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

文档中心

立即注册

导航

持续交付

CreatePipelineWebhookURL

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

创建流水线的 WebhookURL。

接口说明

支持为以下两种触发器创建流水线 WebhookURL：

通用 Webhook 触发器：无需填写 TriggerType。
镜像源 Webhook 触发器：TriggerType 填写为 CRWebhook。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreatePipelineWebhookURL	公共参数，本接口值：CreatePipelineWebhookURL。
Version	String	是	2023-05-01	公共参数，本接口值：2023-05-01。
WorkspaceId	String	是	7815d4783edc47c5bbd7df024ab9****	工作区 ID。
PipelineId	String	是	c3afa3f27d754ac8b6052bf3dc0b****	流水线 ID。
TriggerType	String	否	Webhook	触发器类型： Webhook（默认值）：通用 Webhook 触发器 CRWebhook：镜像源 Webhook 触发器

请求示例

POST /?Action=CreatePipelineWebhookURL&Version=2023-05-01 HTTP/1.1
Content-Type:application/json
{
    "WorkspaceId": "7815d4783edc47c5bbd7df024ab9****",
    "PipelineId": "c3afa3f27d754ac8b6052bf3dc0b****",
}

返回参数

参数	类型	示例值	描述
WebhookURL	String	https://cp.volces.com/v2/webhook/scm/eQKcyKfa7s02maKXrR_VoJi****	WebhookURL

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "5202404071710430739950998FB2847****",
        "Action": "CreatePipelineWebhookURL",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing"
    },
    "Result": {
         "WebhookURL": "https://cp.volces.com/v2/webhook/scm/eQKcyKfa7s02maKXrR_VoJi****"
    }
}

错误码

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