查询某一条流水线的运行记录列表。
请求方式:POST
请求地址:https://open.volcengineapi.com/?Action=ListPipelineRuns&Version=2023-05-01
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListPipelineRuns | 公共参数,本接口值:ListPipelineRuns。 |
Version | String | 是 | 2023-05-01 | 公共参数,本接口值:2023-05-01。 |
WorkspaceId | String | 是 | 28a7a8b2d8174d778e1b21d235a4**** | 工作区 ID。 |
PipelineId | String | 是 | 60cb460122422352a334**** | 流水线 ID。 |
NextToken | String | 否 | MjEwMDMyMjg2**** | 无限滚动翻页中下一页的 Token,不填默认返回第一页内容。Token 从返回参数中获取。 |
MaxResults | Integer | 否 | 10 | 滚动翻页返回最大记录数,取值:
|
Filter | Object PipelineRunFilter | 否 | 待查询流水线运行记录列表的过滤条件。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Statuses | Array of String | 否 | ["Canceling"] | 流水线运行状态,可选的值有:
|
Ids | Array of String | 否 | [ | 按流水线运行 ID 过滤,精确查询。 |
POST /?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 | 流水线运行记录列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | 60cb460122422352a334**** | 流水线运行 ID。 |
PipelineId | String | ade5578c312c42ed9dc412a66b44**** | 流水线 ID。 |
Index | integer | 1 | 流水线的第几次执行。 |
Spec | String | 流水线一次具体执行实例的描述。 | |
Trigger | Object PipelineRunTrigger | 流水线运行的触发信息。 | |
Resources | Array of | 运行流水线时使用的代码源配置。 | |
Parameters | Array of | 运行流水线时使用的自定义变量。 | |
SystemParameters | Array of | 运行流水线时使用的流水线预置变量。 | |
Stages | Array of | 流水线的阶段配置。 | |
Description | String | 这是一段描述 | 运行流水线的描述信息。 |
Status | String | 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:22:31Z | 流水线更新时间。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Type | String | Manual | 触发类型。
|
Id | String | 4da129a5b3ed460691e72632c29c**** | 触发器 ID。 |
User | Object IAMUser | 触发人。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | 39c8a5ea0e7a4b50810f8557fcf2**** | 运行流水线使用的代码源 ID。 |
Name | String | demo | 运行流水线使用的代码源名称。 |
Type | String | Gitee | 运行流水线使用的代码源类型。 |
Configuration | Object PipelineRunResourceConfiguration | 代码源触发配置。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
GitResource | Object PipelineRunGitResourceConfiguration | Git 类资源配置。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
URL | String | https://gitee.com/****/**** | 代码仓库 URL。 |
DefaultBranch | String | master | 默认分支。 |
CloneDepth | Integer | 1 | 代码克隆深度。 |
Reference | String | develop | 实际指定的 Commit ID/Tag/Branch。 |
Type | String | Gitee | 代码仓库类型。取值有:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | 62e179262a9b487894d30241728d**** | 阶段 ID。 |
Name | String | exec-cmd | 阶段名称。 |
Status | String | Succeeded | 阶段状态。
|
Tasks | Array of PipelineRunTask | 当前阶段包含的任务。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | 7c9d82311f9246ccb24eae5457bd**** | 任务 ID。 |
Name | String | exec-cmd | 任务名称。 |
Status | String | Succeeded | 任务状态。
|
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****" } }
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。