GetDeployment - 大数据开发治理平台 DataWorks

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	GetDeployment	要执行的操作。
DeploymentId	Long	是	3000001	发布包的ID。执行SubmitFile 和DeployFile时，都会生成一个对应的发布包ID。
RegionId	String	是	cn-zhangjiakou	服务所在地域的列表。
ProjectId	Long	否	10000	DataWorks工作空间的ID，您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。
ProjectIdentifier	String	否	dw_project	DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。

返回数据


名称	类型	示例值	描述
Data	Struct		发布包的详情。
Deployment	Struct		发布包的详情。
CheckingStatus	Integer	7	当前发布包涉及节点的检查状态，当发布包的目标环境是开发环境（toEnviroment=1）时，只有发布包的Status为1并且CheckingStatus为空时，才可以继续进行文件到生产环境的发布。 7：检查未通过 8：正在处于检查中的状态
CreateTime	Long	1593877765000	发布包生成的毫秒时间戳。
CreatorId	String	20030****	发布包创建者的阿里云用户ID。
ErrorMessage	String	成功	当发布包执行失败（status为2）后，该字段记录具体的错误信息。
ExecuteTime	Long	1593877765000	发布包开始执行的毫秒时间戳。
FromEnvironment	Integer	0	执行本次发布所在的环境，包括0（本地）和1（开发环境）。
HandlerId	String	2003****	发布包执行者的阿里云用户ID。
Name	String	ods_user_info_d-2020-07-04_20030****	发布包的名称，显示在任务发布>发布包列表页面。
Status	Integer	1	发布包当前的状态，包括0（就绪）、1（成功）和2（失败）。
ToEnvironment	Integer	1	发布文件信息的目标环境，包括1（开发环境）和2（生产环境）。
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	错误码。
ErrorMessage	String	The connection does not exist.	错误信息。
HttpStatusCode	Integer	200	HTTP状态码。
RequestId	String	0000-ABCD-EFG****	本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。
Success	Boolean	true	调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=GetDeployment
&DeploymentId=3000001
&ProjectId=10000
&RegionId=cn-zhangjiakou
&<公共请求参数>

正常返回示例

XML格式

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <Deployment>
        <Status>1</Status>
        <HandlerId>2003****</HandlerId>
        <ExecuteTime>1593877765000</ExecuteTime>
        <CreatorId>20030****</CreatorId>
        <CreateTime>1593877765000</CreateTime>
        <ToEnvironment>1</ToEnvironment>
        <FromEnvironment>0</FromEnvironment>
        <ErrorMessage>成功</ErrorMessage>
        <Name>ods_user_info_d-2020-07-04_20030****</Name>
    </Deployment>
</Data>
<Success>true</Success>

JSON格式

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": {
        "Deployment": {
            "Status": 1,
            "HandlerId": "2003****",
            "ExecuteTime": 1593877765000,
            "CreatorId": "20030****",
            "CreateTime": 1593877765000,
            "ToEnvironment": 1,
            "FromEnvironment": 0,
            "ErrorMessage": "成功",
            "Name": "ods_user_info_d-2020-07-04_20030****"
        }
    },
    "Success": true
}

错误码


HttpCode	错误码	错误信息	描述
500	InternalError.System	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。
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.	您的请求过于频繁，请尝试放缓请求速度。
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	您被限制访问，请开通DataWorks企业版或旗舰版。

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