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

文档中心

立即注册

导航

CreateTrigger

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

创建触发器。

接口说明

支持创建以下类型的触发器：

通用 Webhook 触发器：Type 为 Webhook，Configuration 中的 Webhook 为必选。
镜像源 Webhook 触发器：Type 为 CRWebhook，Configuration 中的 Webhook 为必选，Webhook 中的 CR 为必选。
定时触发器：Type 为 Schedule，Configuration 中的 Schedule 为必选。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateTrigger	接口名称。当前 API 的名称为 `CreateTrigger`。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 `2023-05-01`。
WorkspaceId	String	是	7d494e18ee414936c3d189a311676****	触发器所属工作区 ID。
PipelineId	String	是	0f7ca5a42f4ce414933cfd116****	触发器所属流水线ID
Name	String	是	Webhook-demo-update	触发器名称
Type	String	是	Webhook	触发器类型： Webhook：通用 Webhook 触发器 Schedule：定时触发器 CRWebhook：镜像源 Webhook 触发器
Configuration	Object of TriggerConfiguration	是	-	触发器配置。
Description	String	否	这是一段描述	触发器描述。
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"

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

TriggerParameter

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

TriggerResource

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

请求示例

POST https://open.volcengineapi.com/?Action=CreateTrigger&Version=2023-05-01 HTTP/1.1
Content-Type: application/json
{
    "WorkspaceId": "7d494e18ee414936c3d189a311676****",
    "PipelineId": "0f7ca5a42f4ce414933cfd116****",
    "Name": "Webhook-demo",
    "Type": "Webhook",
    "Configuration": {
        "Webhook": {
            "URL": "https://cp.volces.com/v2/webhook/scm/FkLuvVzsxl2zVyQtbutMYnGBi3HYEmK9ZPofERuN1TJ1FbdFztPrsG7rMrWRmQ70****"
        }
    },
    "Parameters": [
        {
            "Key": "demo_key",
            "Value": "demo_val"
        }
    ]
}

返回参数

参数	类型	示例值	描述
Id	String	007a85e4ac034eb790b096705694****	触发器 ID。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "202404071710430739950998FB****",
        "Action": "CreateTrigger",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Id": "007a85e4ac034eb790b096705694****"
    }
}

错误码

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