查询当前流水线的触发器列表。
请求方式:POST
请求地址:https://open.volcengineapi.com/?Action=ListTriggers&Version=2023-05-01
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListTriggers | 公共参数,本接口值:ListTriggers。 |
Version | String | 是 | 2023-05-01 | 公共参数,本接口值:2023-05-01。 |
WorkspaceId | String | 是 | 7d496c3d189a311676**** | 触发器所属工作区 ID。 |
PipelineId | String | 是 | 0f7ca5e80f4c3cfd116**** | 触发器所属流水线 ID。 |
Filter | Object TriggerFilter | 否 | 待查询触发器列表的过滤条件。 | |
PageNumber | Integer | 否 | 1 | 分页查询时的起始页码,从 1 开始,默认为 1。 |
PageSize | Integer | 否 | 10 | 分页查询时每页显示的记录数,取值:
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ids | Array of String | 否 | ["f4e68241db4c1ed401cae****"] | 按触发器 ID 过滤,精确查询。 |
name | String | 否 | demo | 按触发器名称过滤,模糊查询。 |
POST /?Action=ListTriggers&Version=2023-05-01 HTTP/1.1 Content-Type:application/json { "PageNumber": 1, "PageSize": 10, "WorkspaceId": "7d496c3d189a311676****", "PipelineId": "0f7ca5e80f4c3cfd116****", }
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Items | Array of Trigger | 触发器列表。 | |
PageSize | Integer | 10 | 分页大小。 |
PageNumber | Integer | 1 | 当前页码。 |
TotalCount | Integer | 2 | 触发器总数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | f4e68241db4c1ed401cae**** | 触发器 ID。 |
WorkspaceId | String | 7d494e1889a311676**** | 触发器所属工作区 。 |
PipelineId | String | 0f7ca5a4fe80f4c3cfd116**** | 触发器所属流水线 ID。 |
Name | String | GitWebhook-demo | 触发器名称。 |
Description | String | 这是一段描述 | 触发器描述。 |
Type | String | Webhook | 触发器类型:
|
Configuration | Object TriggerConfiguration | 触发器配置。 | |
Creator | Object IAMUser | 触发器创建人。 | |
CreateTime | String | 2021-07-19T12:21:31Z | 触发器创建时间。 |
UpdateTime | String | 2021-07-19T12:22:31Z | 触发器更新时间。 |
Parameters | Array of TriggerParameter | 通过触发器触发流水线运行时,使用的流水线变量。 | |
Resources | Array of TriggerResource | 通过触发器触发流水线运行时,使用的代码源。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Key | String | key | 动态变量 Key。 |
Value | String | value | 动态变量 Value。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ResourceId | String | 60cb460122422352a334**** | 代码源 ID。 |
Reference | String | master | 触发器触发流水线运行时,使用的代码源 reference。可以为 Commit ID/Tag/Branch。 |
参数名 | 类型 | 示例值 | 描述 |
---|---|---|---|
Schedule | Object ScheduleConfiguration | 定时触发器的配置。 | |
Webhook | Object WebhookConfiguration | Webhook 类型触发器的配置。 |
参数名 | 类型 | 示例值 | 描述 |
---|---|---|---|
ScheduleConfig | String | 44 17 * * 1 | 定时触发的时间。 |
参数名 | 类型 | 示例值 | 描述 |
---|---|---|---|
Git | Object GitWebhookConfiguration | 代码源触发器的 Webhook 配置。 | |
CR | Object CRWebhookConfiguration | 否 | 镜像源触发器的 Webhook 配置。 |
URL | String | https://cp.volces.com/v2/webhook/scm/eQKcyKfa702maKXrR_VoJi**** | Webhook 的 URL。 |
参数名 | 类型 | 示例值 | 描述 |
---|---|---|---|
ResourceId | String | c3e06107e5edcb4fb5329d9b**** | 关联的代码源 ID。 |
Filters | Array of WebhookEventFilter | 代码源触发器支持的触发事件和过滤条件。 |
参数名 | 类型 | 示例值 | 描述 |
---|---|---|---|
EventType | String | Push | 触发事件的类型:
|
Config | Object WebhookEventConfig | 触发事件的配置,用于二次过滤符合条件的触发事件。 |
参数名 | 类型 | 示例值 | 描述 |
---|---|---|---|
References | Array of String | ["main" ] | 过滤的分支或者 TAG。 |
参数名 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
Filter | Object CRWebhookEventFilter | 否 | 镜像源触发器支持的触发动作和触发条件。 |
参数名 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
CREventType | String | 否 | CRPush | 触发动作:
|
Condition | String | 否 | "volcregion":"xxx" | 触发条件,用于二次过滤符合条件的触发事件。 |
HTTP/1.1 200 OK Content-Type:application/json { "ResponseMetadata": { "RequestId": "202404071710430739950998FB2847****", "Action": "ListTriggers", "Version": "2023-05-01", "Service": "cp", "Region": "cn-north-1" }, "Result": { "Items": [ { "Id": "f4e68241db4c1ed401cae****", "WorkspaceId": "7d494e1889a311676****", "PipelineId": "0f7ca5a4fe80f4c3cfd116****", "Name": "GitWebhook-demo", "Description": null, "Type": "GitWebhook", "Configuration": { "Webhook": { "Git": { "ResourceId": "c3e06107edsfds29b****", "Filters": [ { "EventType": "Push", "Config": { "References": [ "main" ] } } ] }, "URL": "https://cp.volces.com/v2/webhook/scm/FkLuvVzsxl2zVyQtbutMYnGBi3HYEmK9ZPofERuN1TJ1FbdFztPrsG7r****" }, "Schedule": null }, "CreateTime": "2023-10-12T17:30:03+08:00", "UpdateTime": "2023-10-12T17:30:03+08:00", "Creator": { "AccountId": 1400000039, "UserId": 0 }, "Parameters": [ { "Key": "demo_key", "Value": "demo_val" } ], "Resources": [] } ], "PageSize": 10, "PageNumber": 1, "TotalCount": 1 } }
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。