ListPipelineRuns--持续交付-火山引擎

文档中心

立即注册

导航

ListPipelineRuns

最近更新时间：2024.09.27 14:46:38首次发布时间：2024.07.02 21:03:13

查询某一条流水线的运行记录列表。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListPipelineRuns&Version=2023-05-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListPipelineRuns	接口名称。当前 API 的名称为 `ListPipelineRuns`。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 `2023-05-01`。
WorkspaceId	String	是	28a7a8b2d8174d778e1b21d235a4****	工作区 ID。
PipelineId	String	是	60cb460122422352a334****	流水线 ID。
NextToken	String	否	MjEwMDMyMjg2****	无限滚动翻页中下一页的 Token，不填默认返回第一页内容。Token 从返回参数中获取。
MaxResults	Long	否	10	滚动翻页返回最大记录数，取值：最小值：1 最大值：100 默认值：10
Filter	Object of PipelineRunFilter	否	-	待查询流水线运行记录列表的过滤条件。

PipelineRunFilter

参数	类型	是否必选	示例值	描述
Statuses	Array of String	否	["Canceling"]	流水线运行状态，可选的值有： Enqueued：排队中 Dequeued：环境启动中 InProgress：运行中 Canceling/Canceled：已取消 Timeout：环境启动超时 Failed：失败 Succeeded：成功
Ids	Array of String	否	[ "d915d8652ac745e2a805504512df****" ]	按流水线运行 ID 过滤，精确查询。

参数

类型

是否必选

示例值

描述

Statuses

Array of String

否

["Canceling"]

流水线运行状态，可选的值有：

Enqueued：排队中
Dequeued：环境启动中
InProgress：运行中
Canceling/Canceled：已取消
Timeout：环境启动超时
Failed：失败
Succeeded：成功

Ids

Array of String

否

[ "d915d8652ac745e2a805504512df****" ]

按流水线运行 ID 过滤，精确查询。

请求示例

POST https://open.volcengineapi.com/?Action=ListPipelineRuns&Version=2023-05-01 HTTP/1.1
Content-Type: application/json
{
  "WorkspaceId": "28a7a8b2d8174d778e1b21d235a4****",
  "PipelineId": "60cb460122422352a334****",
  "NextToken": "MjEwMDMyMjg2****",
  "MaxResults": 10,
  "Filter": {
      "Statuses": [
          "InProgress"
      ],
      "Ids": [
           "d915d8652ac745e2a805504512df****"
      ]
  }
}

返回参数

参数	类型	示例值	描述
NextToken	String	MjEwMDMyMjg2****	无限滚动翻页中下一页的 Token。
Items	Array of PipelineRun	-	流水线运行记录列表。

PipelineRun

参数	类型	示例值	描述
Id	String	60cb460122422352a334****	流水线运行 ID。
PipelineId	String	ade5578c312c42ed9dc412a66b44****	流水线 ID。
Index	Long	1	流水线的第几次执行。
Spec	String	-	流水线一次具体执行实例的描述。
Trigger	Object of PipelineRunTrigger	-	流水线运行的触发信息。
Resources	Array of PipelineRunResource	-	运行流水线时使用的代码源配置。
Parameters	Array of PipelineParameter	-	运行流水线时使用的自定义变量。
SystemParameters	Array of PipelineParameter	-	运行流水线时使用的流水线预置变量。
Stages	Array of PipelineRunStage	-	流水线的阶段配置。
Description	String	这是一段描述	运行流水线的描述信息。
Status	String	Succeeded	流水线运行状态，可选的值有： Enqueued：排队中 Dequeued：环境启动中 InProgress：运行中 Canceling/Canceled：已取消 Timeout：环境启动超时 Failed：失败 Succeeded：成功
StartTime	String	2021-07-19T12:21:31Z	流水线开始运行时间。
FinishTime	String	2021-07-19T12:21:31Z	流水线结束运行时间。
CreateTime	String	2021-07-19T12:21:31Z	流水线创建时间。
UpdateTime	String	2021-07-19T12:21:31Z	流水线更新时间。

PipelineRunTrigger

参数	类型	示例值	描述
Type	String	Manual	触发类型。 Manual：手动触发 Schedule：定时触发 Webhook：通用 Webhook 触发 GitWebhook：代码源 Webhook 触发 CRWebhook：镜像源 Webhook 触发
TriggerId	String	4da129a5b3ed460691e72632c29c****	触发器 ID。
User	Object of IAMUser	-	触发人。

参数

类型

示例值

描述

Type

String

Manual

触发类型。

Manual：手动触发
Schedule：定时触发
Webhook：通用 Webhook 触发
GitWebhook：代码源 Webhook 触发
CRWebhook：镜像源 Webhook 触发

TriggerId

String

4da129a5b3ed460691e72632c29c****

触发器 ID。

User

Object of IAMUser

触发人。

IAMUser

参数	类型	示例值	描述
AccountId	Long	210048****	火山引擎账号（主账号）ID。
UserId	Long	28****	子用户（IAM 用户）ID。

PipelineRunResource

参数	类型	示例值	描述
Id	String	39c8a5ea0e7a4b50810f8557fcf2****	运行流水线使用的代码源 ID。
Name	String	demo	运行流水线使用的代码源名称。
Type	String	Gitee	运行流水线使用的代码源类型。
Configuration	Object of PipelineRunResourceConfiguration	-	代码源触发配置。

PipelineRunResourceConfiguration

参数	类型	示例值	描述
GitResource	Object of PipelineRunGitResourceConfiguration	-	Git 类资源配置。

PipelineRunGitResourceConfiguration

参数	类型	示例值	描述
URL	String	https://gitee.com/**/**	代码仓库 URL。
DefaultBranch	String	master	默认分支。
CloneDepth	Integer	1	代码克隆深度。
Reference	String	develop	实际指定的 Commit ID/Tag/Branch。
Type	String	Gitee	代码仓库类型。取值有： GitHub：GitHub 代码仓库 GitLab：GitLab 代码仓库 Gitee：Gitee 代码仓库 Gerrit：Gerrit 代码仓库 BitbucketCloud：BitbucketCloud 代码仓库 Git：通用 Git 类型代码仓库

PipelineParameter

参数	类型	示例值	描述
Key	String	key1	变量的键。
Value	String	val1	变量的值。
Secret	Boolean	true/false	变量是否开启隐私设置。 true：开启隐私设置。变量的默认值展示为***。 false：关闭隐私设置。变量的默认值明文展示。
Dynamic	Boolean	true/false	变量是否开启动态设置。 true：变量为动态变量。支持在运行流水线时修改当前变量的运行值。 false：变量为非动态变量。运行流水线时使用默认值。
OptionValues	Array of String	["abc","bcd"]	当配置可选值时，代表变量是个单选值。
Description	String	this is a param description	变量备注。

PipelineRunStage

参数	类型	示例值	描述
Id	String	62e179262a9b487894d30241728d****	阶段 ID。
Name	String	exec-cmd	阶段名称。
Status	String	Succeeded	阶段状态。 NotStart：初始状态 Queued：待执行 InProgress：运行中 Timeout：超时 Failed：失败 Succeeded：成功 Cancelled：取消
Tasks	Array of PipelineRunTask	-	当前阶段包含的任务。

PipelineRunTask

参数	类型	示例值	描述
Id	String	7c9d82311f9246ccb24eae5457bd****	任务 ID。
Name	String	exec-cmd	任务名称。
Status	String	Succeeded	任务状态。 Queued：待执行 Running：运行中 Timeout：超时 Failed：失败 Succeeded：成功 Cancelled：取消
DependsOn	Array of String	["exec-cmd"]	依赖的上游任务名称。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "202404071154300739950998FB283A****",
        "Action": "ListPipelineRuns",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Id": "02765d2b55654d3ab800541a4cf9****",
                "PipelineId": "c3afa3f27d754ac8b6052bf3dc0b****",
                "Index": 13,
                "Spec": "version: 1.0.0\nstages:\n  - stage: stage-1\n    displayName: 阶段-1\n    tasks:\n      - dependsOn: []\n        task: task1\n        displayName: 任务-1\n        steps:\n          - step: exec-cmd\n            displayName: 命令执行\n            inputs:\n              shell: BASH\n              cmd: |-\n                sleep 200\n\n                echo 'aa'\n            component: execCmd@1.0.0/shell\n        plugins: []\n        outputs: []\n        timeout:\n          time: '2'\n          unit: h\n        workspace:\n          resources:\n            - ref: test111\n              directory: $(CP_WORKSPACE)\n          caches:\n            - cacheKey: m2\n              directory: $(CP_WORKSPACE)/m2\n              cachePolicy: pull-push\n            - cacheKey: gradle\n              directory: $(CP_WORKSPACE)/gradle\n              cachePolicy: pull-push\n            - cacheKey: npm\n              directory: $(CP_WORKSPACE)/npm\n              cachePolicy: pull-push\nagentPool: public/sit-v2-public\n",
                "Trigger": {
                    "Type": "Manual",
                    "TriggerId": "4da129a5b3ed460691e72632c29c****",
                    "User": {
                        "AccountId": 210048****,
                        "UserId": 484****
                    }
                },
                "Resources": [
                    {
                        "Id": "39c8a5ea0e7a4b50810f8557fcf2****",
                        "Name": "gitee",
                        "Type": "Gitee",
                        "Configuration": {
                            "GitResource": {
                                "URL": "https://gitee.com/****/****",
                                "DefaultBranch": "master",
                                "CloneDepth": 1,
                                "Reference": "master",
                                "Type": "Gitee"
                            }
                        }
                    }
                ],
                "Parameters": [
                    {
                        "Key": "key",
                        "Value": "val1",
                        "OptionValues": null,
                        "Description": null
                    }
                ],
                "Stages": [
                    {
                        "Id": "62e179262a9b487894d30241728d****",
                        "Name": "exec-cmd",
                        "Status": "Succeeded",
                        "Tasks": [
                            {
                                "Id": "7c9d82311f9246ccb24eae5457bd****",
                                "Name": "exec-cmd",
                                "Status": "Succeeded"
                            }
                        ]
                    }
                ],
                "Status": "Succeeded",
                "StartTime": "",
                "FinishTime": "",
                "CreateTime": "2024-03-21T20:09:39+08:00",
                "UpdateTime": "2024-03-21T20:09:48+08:00",
                "SystemParameters": [
                    {
                        "Key": "CP_WORKSPACE",
                        "Value": "/workspace",
                        "OptionValues": null,
                        "Description": null
                    },
                    {
                        "Key": "CP_CACHE_DIR",
                        "Value": "/workspace",
                        "OptionValues": null,
                        "Description": null
                    },
                    {
                        "Key": "PIPELINE_ID",
                        "Value": "c3afa3f27d754ac8b6052bf3dc0b****",
                        "OptionValues": null,
                        "Description": null
                    },
                    {
                        "Key": "PIPELINERUN_ID",
                        "Value": "02765d2b55654d3ab800541a4cf9****",
                        "OptionValues": null,
                        "Description": null
                    },
                    {
                        "Key": "DATETIME",
                        "Value": "20240321200939",
                        "OptionValues": null,
                        "Description": null
                    }
                ]
            }
        ],
        "NextToken": "MjEwMDMwNTE2****"
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。