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

文档中心

立即注册

导航

ListTriggers

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

查询当前流水线的触发器列表。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListTriggers	接口名称。当前 API 的名称为 `ListTriggers`。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 `2023-05-01`。
WorkspaceId	String	是	7d496c3d189a311676****	触发器所属工作区 ID。
PipelineId	String	是	0f7ca5e80f4c3cfd116****	触发器所属流水线 ID。
Filter	Object of TriggerFilter	否	-	待查询触发器列表的过滤条件。
PageNumber	Long	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Long	否	10	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：10

TriggerFilter

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	["f4e68241db4c1ed401cae****"]	按触发器 ID 过滤，精确查询。
Name	String	否	demo	按触发器名称过滤，模糊查询。

请求示例

POST https://open.volcengineapi.com/?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	Long	10	分页大小。
PageNumber	Long	1	当前页码。
TotalCount	Long	2	触发器总数。

Trigger

参数	类型	示例值	描述
Id	String	f4e68241db4c1ed401cae****	触发器 ID。
WorkspaceId	String	7d494e1889a311676****	触发器所属工作区。
PipelineId	String	0f7ca5a4fe80f4c3cfd116****	触发器所属流水线 ID。
Name	String	GitWebhook-demo	触发器名称。
Description	String	这是一段描述	触发器描述。
Type	String	Webhook	触发器类型： Schedule：定时触发 Webhook：通用 Webhook 触发 GitWebhook：代码源 Webhook 触发 CRWebhook：镜像源 Webhook 触发
Configuration	Object of TriggerConfiguration	-	触发器配置。
Creator	Object of IAMUser	-	触发器创建人。
CreateTime	String	2021-07-19T12:21:31Z	触发器创建时间。
UpdateTime	String	2021-07-19T12:22:31Z	触发器更新时间。
Parameters	Array of TriggerParameter	-	通过触发器触发流水线运行时，使用的流水线变量。
Resources	Array of TriggerResource	-	通过触发器触发流水线运行时，使用的代码源。

TriggerConfiguration

参数	类型	示例值	描述
Schedule	Object of ScheduleConfiguration	-	定时触发器的配置。
Webhook	Object of WebhookConfiguration	-	Webhook 类型触发器的配置。

ScheduleConfiguration

参数	类型	示例值	描述
ScheduleConfig	String	44 17 * * 1	使用 Crontab 表达式配置定时触发的时间，配置方法请参见官方文档。 Crontab 表达式默认使用 UTC + 8 时区。

WebhookConfiguration

参数	类型	示例值	描述
Git	Object of GitWebhookConfiguration	-	代码源触发器的 Webhook 配置。
CR	Object of CRWebhookConfiguration	-	镜像源触发器的 Webhook 配置。
URL	String	https://cp.volces.com/v2/webhook/scm/eQKcyKfa702maKXrR_VoJi****	Webhook 的 URL，可以通过 CreatePipelineWebhookURL 接口生成。

GitWebhookConfiguration

参数	类型	示例值	描述
ResourceId	String	c3e06107e5edcb4fb5329d9b****	关联的代码源 ID。
Filters	Array of WebhookEventFilter		代码源触发器支持的触发事件和过滤条件。如果不配置，则默认所有事件都将触发流水线运行。

WebhookEventFilter

参数	类型	示例值	描述
EventType	String	Push	触发事件的类型： Push：代码 Push CreateTag：TAG 创建 PRMerged：合并请求完成后
Config	Object of WebhookEventConfig	-	触发事件的配置，用于二次过滤符合条件的触发事件。

参数

类型

示例值

描述

EventType

String

Push

触发事件的类型：

Push：代码 Push
CreateTag：TAG 创建
PRMerged：合并请求完成后

Config

Object of WebhookEventConfig

触发事件的配置，用于二次过滤符合条件的触发事件。

WebhookEventConfig

参数	类型	示例值	描述
References	Array of String	["main" ]	过滤的分支或者 TAG。 Push 和 PRMerged 事件支持填写过滤的分支。 CreateTag 事件支持填写过滤的 TAG。

参数

类型

示例值

描述

References

Array of String

["main" ]

过滤的分支或者 TAG。

Push 和 PRMerged 事件支持填写过滤的分支。
CreateTag 事件支持填写过滤的 TAG。

CRWebhookConfiguration

参数	类型	示例值	描述
Filter	Object of CRWebhookEventFilter		镜像源触发器支持的触发动作和触发条件。如果不配置，则默认所有事件都将触发流水线运行。

CRWebhookEventFilter

参数	类型	示例值	描述
CREventType	String	CRPush	触发动作： CRPush：镜像推送
Condition	String	"volcregion":"xxx"	触发条件，用于二次过滤符合条件的触发事件。支持使用正则表达式。

参数

类型

示例值

描述

CREventType

String

CRPush

触发动作：

CRPush：镜像推送

Condition

String

"volcregion":"xxx"

触发条件，用于二次过滤符合条件的触发事件。支持使用正则表达式。

IAMUser

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

TriggerParameter

参数	类型	示例值	描述
Key	String	key	动态变量 Key。
Value	String	value	动态变量 Value。

TriggerResource

参数	类型	示例值	描述
ResourceId	String	60cb460122422352a334****	代码源 ID。
Reference	String	master	流水线运行使用的代码 Reference，支持填写 Commit ID/Tag/Branch。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "202404071710430739950998FB****",
        "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": 140000****,
                    "UserId": ****
                },
                "Parameters": [
                    {
                        "Key": "demo_key",
                        "Value": "demo_val"
                    }
                ],
                "Resources": []
            }
        ],
        "PageSize": 10,
        "PageNumber": 1,
        "TotalCount": 1
    }
}

错误码

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