创建触发器。
支持创建以下类型的触发器:
通用 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 | 公共参数,本接口值:CreateTrigger。 |
Version | String | 是 | 2023-05-01 | 公共参数,本接口值:2023-05-01。 |
WorkspaceId | String | 是 | 7d494e18ee414936c3d189a311676**** | 触发器所属工作区 ID。 |
PipelineId | String | 是 | 0f7ca5a42f4ce414933cfd116**** | 触发器所属流水线 ID。 |
Name | String | 是 | Webhook-demo-update | 触发器名称。 |
Type | String | 是 | 类型 | 触发器类型:
|
Configuration | Object TriggerConfiguration | 是 | 触发器配置。 | |
Description | String | 否 | 这是一段描述 | 触发器描述。 |
Parameters | Array of TriggerParameter | 否 | 通过触发器触发流水线运行时,使用的流水线变量。 | |
Resources | Array of TriggerResource | 否 | 通过触发器触发流水线运行时,使用的代码源。 |
POST /?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": "202404071710430739950998FB2847****", "Action": "CreateTrigger", "Version": "2023-05-01", "Service": "cp", "Region": "cn-beijing" }, "Result": { "Id": "007a85e4ac034eb790b096705694****" } }
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。