调用GetDeploymentPackage获取发布包的详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProjectId |
integer |
否 |
DataWorks 工作空间的 ID。 您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间 ID。 该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。 |
10000 |
| ProjectIdentifier |
string |
否 |
DataWorks 工作空间的唯一标识符,即数据开发页面顶部切换工作空间处的英文标识。 该参数与 ProjectId 参数二者必须设置其一,以确定本次 API 调用操作的 DataWorks 工作空间。 |
dw_project |
| DeploymentId |
integer |
是 |
发布包的 ID。 执行 SubmitFile 和 DeployFile 时,都会生成一个对应的发布包 ID。 |
1000000001 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| HttpStatusCode |
integer |
HTTP 状态码 。 |
200 |
| ErrorMessage |
string |
错误信息 。 |
You have no permission. |
| RequestId |
string |
请求 ID。用于定位日志,排查问题 。 |
0bc1ec92159376**** |
| ErrorCode |
string |
错误码 。 |
Invalid.Tenant.ConnectionNotExists |
| Success |
boolean |
是否调用成功。
|
true |
| Data |
object |
发布包的详情 。 |
|
| Deployment |
object |
发布包的详 情。 |
|
| Status |
integer |
发布包当前的状态 ,包括 0(就绪)、1(成功)和 2(失败)。 |
1 |
| ErrorMessage |
string |
当发布包执行失败(status 为 2)后, 该字段记录具体的错误信息。 |
Success |
| FromEnvironment |
integer |
执行本次发布所在的环境 ,包括 0(本地)和 1(开发环境)。 |
0 |
| ToEnvironment |
integer |
发布文件信息的目标环境, 包括 1(开发环境)和 2(生产环境)。 |
1 |
| CheckingStatus |
integer |
当前发布包涉及节点的检查状态, 当发布包的目标环境是开发环境(toEnviroment=1)时,只有发布包的 Status 为 1 并且 CheckingStatus 为空时,才可以继续进行文件到生产环境的发布。
|
7 |
| CreateTime |
integer |
发布包生成的毫秒时间 戳。 |
1593877765000 |
| HandlerId |
string |
发布包执行者的阿里云用 户 ID。 |
2003**** |
| CreatorId |
string |
发布包创建者的阿里云 用户 ID。 |
20030**** |
| ExecuteTime |
integer |
发布包开始执行的毫秒时 间戳。 |
1593877765000 |
| Name |
string |
发布包的名称, 显示在任务发布>发布包列表页面。 |
ods_user_info_d-2020-07-04_20030**** |
| DeployedItems |
array<object> |
发布项详情。 |
|
|
object |
发布项详情。 |
||
| FileId |
integer |
文件的 ID 。 |
5076**** |
| FileVersion |
integer |
文件的版本 。 |
7 |
| Status |
integer |
|
1 |
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"ErrorMessage": "You have no permission.",
"RequestId": "0bc1ec92159376****",
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"Success": true,
"Data": {
"Deployment": {
"Status": 1,
"ErrorMessage": "Success",
"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": 0,
"FileVersion": 7,
"Status": 1
}
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 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. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。