ListPipelineRuns - 获取发布流程列表

分页获取发布流程列表,也可以使用筛选条件对发布流程进行筛选。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

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

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

10000
Creatorstring

筛选条件:发布流程的创建者

110755000425****
Statusstring

筛选条件:发布流程的当前状态

可选值:

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

页码,从 1 开始,默认值为 1。

1
PageSizeinteger

每页显示的条数,默认为 10 条,最大 100 条。

10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

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

7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX
PagingInfoobject

分页信息。

TotalCountinteger

满足条件的数据总条数。

2524
PageSizeinteger

每页显示的条数

10
PageNumberinteger

查询分页的页码。

1
PipelineRunsarray<object>

发布流程信息列表。

pipelineRunobject

发布流程列表元素

Idstring

发布流程 Id

097c73fe-ed6e-4fb1-b109-a5d59e46cd58
ProjectIdlong

项目 Id

70199
CreateTimelong

发布包创建时间戳

1702736654000
ModifyTimelong

修改时间

1702736654000
Creatorstring

创建人

110755000425XXXX
Statusstring

发布流程状态

可选值

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

发布阶段发生错误时的错误信息

Error message
Stagesarray<object>

发布阶段列表

stageobject

发布阶段列表元素

Codestring

发布阶段代号

DEV_CHECK
Stepinteger

发布阶段步骤编号

1
Typestring

发布阶段类型,是该发布阶段操作类型的一个分类。

可选值

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

阶段名称

Check before going online to development
Descriptionstring

阶段描述

Check before going online to development
Messagestring

发布阶段发生错误时的错误信息

Error message
Statusstring

发布阶段状态

可选值

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

发布阶段的其他补充信息

any

补充信息

{ "checkerList": [ { "code": "BuildPackageChecker", "name": "package check" }, { "code": "NodeParentDependency", "name": "downstream dependency check" }, { "code": "NodeInProcess", "name": "offline process check" } ] }

示例

正常返回示例

JSON格式

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\n",
  "PagingInfo": {
    "TotalCount": 2524,
    "PageSize": 10,
    "PageNumber": 1,
    "PipelineRuns": [
      {
        "Id": "097c73fe-ed6e-4fb1-b109-a5d59e46cd58",
        "ProjectId": 70199,
        "CreateTime": 1702736654000,
        "ModifyTime": 1702736654000,
        "Creator": "110755000425XXXX",
        "Status": "Running",
        "Message": "Error message",
        "Stages": [
          {
            "Code": "DEV_CHECK",
            "Step": 1,
            "Type": "Check",
            "Name": "Check before going online to development\n",
            "Description": "Check before going online to development\n",
            "Message": "Error message\n",
            "Status": "Running",
            "Detail": {
              "key": {
                "checkerList": [
                  {
                    "code": "BuildPackageChecker",
                    "name": "package check"
                  },
                  {
                    "code": "NodeParentDependency",
                    "name": "downstream dependency check"
                  },
                  {
                    "code": "NodeInProcess",
                    "name": "offline process check"
                  }
                ]
              }
            }
          }
        ]
      }
    ]
  }
}

错误码

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