GetDeployment - 获取发布包的详情 - 大数据开发治理平台 DataWorks

调用GetDeployment获取发布包的详情。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dataworks:*	get	全部资源 ``	无	无

请求参数

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

返回参数

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

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "Deployment": {
      "Status": 1,
      "ErrorMessage": "成功",
      "FromEnvironment": 0,
      "ToEnvironment": 1,
      "CheckingStatus": 7,
      "CreateTime": 1593877765000,
      "HandlerId": "2003****",
      "CreatorId": "20030****",
      "ExecuteTime": 1593877765000,
      "Name": "ods_user_info_d-2020-07-04_20030****"
    },
    "DeployedItems": [
      {
        "FileId": 507642378,
        "FileVersion": 7,
        "Status": 1
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	没有权限，请授权
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.	系统内部错误，请稍后再试。

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史