调用SubmitFile,提交文件至调度系统的开发环境,生成对应的任务。该API是异步处理,您可以使用GetDeployment接口获取文件的提交状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | SubmitFile |
系统规定参数。取值:SubmitFile。 |
ProjectId | Long | 否 | 10000 |
DataWorks工作空间的ID。您可以登录DataWorks管控台,进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数,二者必须设置其一,用来确定本次API调用操作的DataWorks工作空间。 |
RegionId | String | 是 | cn-zhangjiakou |
地域信息,通常为服务所在的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。 |
ProjectIdentifier | String | 否 | dw_project |
DataWorks工作空间名称。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数,二者必须设置其一,用来确定本次API调用操作的DataWorks工作空间。 |
FileId | Long | 是 | 1000000 |
文件的ID,您可以通过ListFiles查询对应文件的ID。 |
Comment | String | 否 | 第一次提交任务 |
本次提交的说明信息。 |
SkipAllDeployFileExtensions | Boolean | 否 | false |
文件提交成功后是否跳过发布前检查:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
HttpStatusCode | Integer | 200 |
HTTP状态码。 |
Data | Long | 3000001 |
发布包的ID,后续需要将该ID作为参数调用GetDeployment接口,获取本次发布的具体情况。 |
RequestId | String | 0000-ABCD-EFG**** |
请求ID。用于出现错误后排查问题。 |
ErrorMessage | String | The connection does not exist. |
错误信息。 |
Success | Boolean | true |
调用是否成功。 |
ErrorCode | String | Invalid.Tenant.ConnectionNotExists |
错误码。 |
示例
请求示例
http(s)://[Endpoint]/?Action=SubmitFile
&ProjectId=10000
&ProjectIdentifier=dw_project
&FileId=1000000
&Comment=第一次提交任务
&SkipAllDeployFileExtensions=false
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
200
3000001
0000-ABCD-EFG****
The connection does not exist.
true
Invalid.Tenant.ConnectionNotExists
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"Data" : 3000001,
"RequestId" : "0000-ABCD-EFG****",
"ErrorMessage" : "The connection does not exist.",
"Success" : true,
"ErrorCode" : "Invalid.Tenant.ConnectionNotExists"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. |
您被限制访问,请开通DataWorks企业版或旗舰版。 |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | 对该资源的请求已超过您的可用上限。 |
429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks系统繁忙,请稍后再试。 |
429 | Throttling.User | Your request is too frequent. Try again later. | 您的请求过于频繁,请尝试放缓请求速度。 |
500 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
访问错误中心查看更多错误码。
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/171071.html