GetDeployment_大数据开发治理平台 DataWorks_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

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

请求参数

字段名称字段详情
ProjectIdinteger<int64>

DataWorks 工作空间的 ID,您可以单击页面右上角的小扳手图标,进入工作空间管理页面查看。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:10000参考取值来源:
    ListProjectIds
    CreateProject
    AddProjectMemberToRole
ProjectIdentifierstring

DataWorks 工作空间的唯一标识符,即数据开发页面顶部切换工作空间处的英文标识。展开详情

示例值:dw_project参考取值来源:
    CreateProject
    GetProject
    ListProjects
DeploymentIdinteger<int64>

发布包的 ID。执行 SubmitFileDeployFile 时,都会生成一个对应的发布包 ID。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:3000001

返回参数

字段名称字段详情
HttpStatusCodeinteger<int32>

HTTP 状态码。

示例值:200
ErrorMessagestring

错误信息。

示例值:The connection does not exist.
RequestIdstring

本次调用的唯一 ID。出现错误后,您可以根据该 ID 排查问题。

示例值:0000-ABCD-EFG****
ErrorCodestring

错误码。

示例值:Invalid.Tenant.ConnectionNotExists
Successboolean

调用是否成功。

示例值:true
Dataobject

发布包的详情。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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.诊断
500
InternalError.System
An internal system error occurred. Try again later.诊断
500
InternalError.UserId.Missing
An internal system error occurred. Try again later.诊断

变更历史

变更时间变更内容概要操作
2022-09-27
变更返回参数

相关示例

调用GetDeployment获取发布包的详情。
2021-09-14