GetDeployment - 获取发布流程详细信息 - 大数据开发治理平台 DataWorks

调用此接口，获取发布流程详细信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ProjectId	string	是	DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间 ID。该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。	10000
Id	string	是	发布流程的唯一标识符。	a7ef0634-20ec-4a7c-a214-54020f91XXXX

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	本次调用的唯一 id。出现错误后，您可以根据该 id 排查问题。	08468352-032C-5262-AEDC-68C9FA05XXXX
Pipeline	object	整个发布流程的信息
Id	string	发布流程唯一标识符	a7ef0634-20ec-4a7c-a214-54020f91XXXX
ProjectId	string	DataWorks 工作空间的 ID。	56160
CreateTime	long	发布流程创建时间戳	1724984066000
ModifyTime	long	修改时间	1724984066000
Creator	string	创建人	137946317766XXXX
Status	string	发布流程状态可选值： Init 初始化 Running 运行中 Success 运行成功 Fail 运行失败 Termination 被终止 Cancel 被取消	Running
Message	string	发布失败的错误信息	错误信息
Stages	array<object>	步骤详情
stage	object	stage 的元素
Code	string	发布阶段代号	DEV_CHECK
Step	integer	发布阶段步骤编号	1
Type	string	发布阶段类型可选值 Deploy 发布操作 Check 检查操作 Offline 下线操作 Build 构建操作 Delete 删除操作	Check
Name	string	阶段名称	发布包构建
Description	string	阶段描述	阶段描述信息
Message	string	发布阶段异常信息	异常信息XXX
Status	string	发布阶段状态可选值： Init 初始化 Running 运行中 Success 运行成功 Fail 运行失败 Termination 被终止 Cancel 被取消	Running
Detail	object	阶段详细信息
	any	阶段额外的信息描述	"checkerList": [ { "code": "BuildPackageChecker", "name": "打包检查" }, { "code": "NodeParentDependency", "name": "下游依赖检查" }, { "code": "NodeInProcess", "name": "下线中流程检查" } ]

示例

正常返回示例

JSON格式

{
  "RequestId": "08468352-032C-5262-AEDC-68C9FA05XXXX",
  "Pipeline": {
    "Id": "a7ef0634-20ec-4a7c-a214-54020f91XXXX\n",
    "ProjectId": "56160",
    "CreateTime": 1724984066000,
    "ModifyTime": 1724984066000,
    "Creator": "137946317766XXXX",
    "Status": "Running",
    "Message": "错误信息",
    "Stages": [
      {
        "Code": "DEV_CHECK",
        "Step": 1,
        "Type": "Check",
        "Name": "发布包构建",
        "Description": "阶段描述信息",
        "Message": "异常信息XXX",
        "Status": "Running",
        "Detail": {
          "key": "\"checkerList\": [\n                {\n                  \"code\": \"BuildPackageChecker\",\n                  \"name\": \"打包检查\"\n                },\n                {\n                  \"code\": \"NodeParentDependency\",\n                  \"name\": \"下游依赖检查\"\n                },\n                {\n                  \"code\": \"NodeInProcess\",\n                  \"name\": \"下线中流程检查\"\n                }\n              ]"
        }
      }
    ]
  }
}

错误码

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