调用DeployFile接口,发布数据开发中的文件至生产环境。调用DeployFile接口后,您需要通过DeployFile返回的Data参数继续调用GetDeployment接口,轮询被触发的异步发布流程的状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DeployFile

系统规定参数。取值:DeployFile

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 10000001

文件的ID,您可以通过ListFiles查询对应文件的ID。

该参数与NodeId参数配置一个即可。

Comment String 第一次发布任务

本次发布的说明信息。

NodeId Long 2000001

待发布文件在调度系统对应的任务ID。该参数与FileId参数配置一个即可。

返回数据

名称 类型 示例值 描述
HttpStatusCode Integer 200

HTTP状态码。

Data Long 30000001

发布包的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=DeployFile
&ProjectId=10000
&ProjectIdentifier=dw_project
&FileId=10000001
&Comment=第一次发布任务
&NodeId=2000001
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DeployFileResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <Data>30000001</Data>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <Success>true</Success>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
</DeployFileResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "Data" : 30000001,
  "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. 系统内部错误,请稍后再试。

访问错误中心查看更多错误码。