查询流水线列表。
请求方式:POST
请求地址:https://open.volcengineapi.com/?Action=ListPipelines&Version=2023-05-01
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListPipelines | 公共参数,本接口值:ListPipelines。 |
Version | String | 是 | 2023-05-01 | 公共参数,本接口值:2023-05-01。 |
WorkspaceId | String | 是 | 3f5f09a059124d6898a8543e678f**** | 工作区 ID。 |
Filter | Object PipelineFilter | 否 | 待查询流水线的过滤条件。 | |
PageSize | Integer | 否 | 10 | 分页查询时每页显示的记录数,取值:
|
PageNumber | Integer | 否 | 1 | 分页查询时的起始页码,从 1 开始,默认为 1。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Name | String | 否 | foo | 按流水线名称过滤,模糊查询。 |
Ids | Array of String | 否 | ["9d3f01e4f7ee4293a7cfc0c2d4d6****"] | 按流水线 ID 过滤,精确查询。 |
POST /?Action=ListPipelines&Version=2023-05-01 HTTP/1.1 Content-Type:application/json { "WorkspaceId": "3f5f09a059124d6898a8543e678f****", "PageNumber": 1, "PageSize": 10, "Filter": { "Name": "test", "Ids": [ "9d3f01e4f7ee4293a7cfc0c2d4d6****" ] } }
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalCount | Integer | 10 | 流水线总数。 |
Items | Array of Pipeline | 流水线列表。 | |
PageSize | Integer | 10 | 分页大小。 |
PagetNumber | Integer | 1 | 当前页码。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | 67d0485e1efb44128f0d990cdad6**** | 流水线 ID。 |
Name | String | pipelineName | 流水线名称。 |
WorkspaceId | String | 9d3f01e4f7ee4293a7cfc0c2d4d6**** | 流水线所属工作区 ID。 |
Description | String | 这是一段描述 | 流水线描述信息。 |
Spec | String | 流水线编排 YAML 描述信息。 | |
Resources | Array of PipelineResource | 流水线资源相关配置,目前指代码源。 | |
Parameters | Array of PipelineParameter | 流水线变量配置。 | |
Caches | Array of PipelineCache | 流水线缓存配置。 | |
Notification | Object PipelineNotification | 流水线消息通知配置。 | |
Creator | Object IAMUser | 流水线创建人。 | |
CreateTime | String | 2023-05-10T21:33:20Z | 流水线创建时间。 |
UpdateTime | String | 2023-05-10T21:33:20Z | 流水线更新时间。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | 669631b1495540a49915ede9893d**** | 代码源 ID。 |
Configuration | Object PipelineResourceConfiguration | 代码源配置。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Git | Object GitResourceConfiguration | Git 代码源配置。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
DefaultBranch | String | master | 默认分支。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Key | String | m2 | 缓存目录名称。 |
Path | String | $(CP_WORKSPACE)/.m2 | 缓存路径。 |
Description | String | this is a param description | 缓存目录备注。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Events | Array of String | ["EventPipelineStarted"] | 触发消息通知的事件列表。
|
EnableSiteLetter | Boolean | true/false | 是否开启站内信通知。
|
Sms | Object NotificationTarget | 短信消息通知配置。 | |
Object NotificationTarget | 邮件消息通知配置。 | ||
Webhook | Object WebhookNotification | Webhook 消息通知配置。 | |
CustomContent | String | 自定义消息 | 自定义的消息通知内容。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Enable | String | true/false | 是否开启通知。
|
Tragets | Array of String | ["Triggerer", "Creator"] | 通知目标。
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Enable | String | true/false | 是否开启通知。
|
Type | String | Lark | Webhook 类型。
|
Url | String | https://open.feishu.cn/open-apis/bot/v2/hook/2e5c3202-aa81-4b14-**** | WebhookURL。 |
Token | String | 4W0TEVvODT8hK4e**** | 调用 Token。 |
HTTP/1.1 200 OK Content-Type:application/json { "ResponseMetadata": { "RequestId": "202404031138595E5D8BD124299EB9****", "Action": "ListPipelines", "Version": "2023-05-01", "Service": "cp", "Region": "cn-beijing", }, "Result": { "Items": [ { "Id": "67d0485e1efb44128f0d990cdad6****", "Name": "test-v2-pipeline_1683717039073", "WorkspaceId": "9d3f01e4f7ee4293a7cfc0c2d4d6****", "Description": "", "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", "Resources": [ { "Id": "669631b1495540a49915ede9893d****", "Configuration": { "Git": { "DefaultBranch": "demo" } } } ], "CreateTime": "2023-05-10T19:10:39Z", "UpdateTime": "2023-05-10T21:33:20Z", "Creator": { "AccountId": 140000****, "UserId": 0 }, "Draft": false } ], "PageSize": 10, "PageNumber": 1, "TotalCount": 1 } }
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。