GetPipelineRun - 获取发布流程详细信息

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

接口说明

注意 低版本的 SDK 中可能无该接口,此时请使用 GetDeployment 接口,参数与该文档一致。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*get
*全部资源
*

请求参数

名称类型必填描述示例值
ProjectIdlong

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间管理页面获取 ID。

该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。

10000
Idstring

发布流程的唯一标识符。

a7ef0634-20ec-4a7c-a214-54020f****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求的 ID。用于定位日志,排查问题。

08468352-032C-5262-AEDC-68C9FA05XXXX
Pipelineobject

整个发布流程的信息

Idstring

发布流程 Id

a7ef0634-20ec-4a7c-a214-54020f91XXXX
ProjectIdlong

DataWorks 工作空间的 ID。

56160
CreateTimelong

发布包创建时间戳

1724984066000
ModifyTimelong

修改时间

1724984066000
Creatorstring

创建人

137946317766XXXX
Statusstring

发布流程状态

可选值:

  • Init 初始化
  • Running 运行中
  • Success 运行成功
  • Fail 运行失败
  • Termination 被终止
  • Cancel 被取消
Running
Messagestring

发布失败的错误信息

Error message
Stagesarray<object>

步骤详情

stageobject

stage 的元素

Codestring

发布阶段代号

DEV_CHECK
Stepinteger

发布阶段步骤编号

1
Typestring

发布阶段类型

可选值

  • Deploy 发布操作
  • Check 检查操作
  • Offline 下线操作
  • Build 构建操作
  • Delete 删除操作
Check
Namestring

阶段名称

Publish package build
Descriptionstring

阶段描述

Phase description
Messagestring

发布阶段异常信息

Exception information XXX
Statusstring

发布阶段状态

可选值:

  • Init 初始化
  • Running 运行中
  • Success 运行成功
  • Fail 运行失败
  • Termination 被终止
  • Cancel 被取消
Running
Detailobject

阶段详细信息

any

阶段额外的信息描述

"checkerList": [ { "code": "BuildPackageChecker", "name": "Build_Package_Checker" }, { "code": "NodeParentDependency", "name": "Downstream_Dependency_Checker" }, { "code": "NodeInProcess", "name": "Decommissioning_Process_Checker" } ]

示例

正常返回示例

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": "Error message",
    "Stages": [
      {
        "Code": "DEV_CHECK",
        "Step": 1,
        "Type": "Check",
        "Name": "Publish package build",
        "Description": "Phase description",
        "Message": "Exception information XXX",
        "Status": "Running",
        "Detail": {
          "key": "\"checkerList\": [\n    {\n        \"code\": \"BuildPackageChecker\",\n        \"name\": \"Build_Package_Checker\"\n    },\n    {\n        \"code\": \"NodeParentDependency\",\n        \"name\": \"Downstream_Dependency_Checker\"\n    },\n    {\n        \"code\": \"NodeInProcess\",\n        \"name\": \"Decommissioning_Process_Checker\"\n    }\n]\n"
        }
      }
    ]
  }
}

错误码

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