文档首页/流水线 CodeArts Pipeline/API参考/API/流水线管理/获取通用Webhook信息 - ShowGenericWebHook
更新时间：2025-12-02 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取通用Webhook信息 - ShowGenericWebHook

功能介绍

获取通用Webhook信息

调用方法

请参见如何调用API。

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}/webhook

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

pipeline_id

是

String

参数解释：

流水线ID，可以通过查询流水线列表接口获取，其中pipelines.pipelineId即为流水线ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

pipelineId

String

参数解释：

流水线ID。

取值范围：

32位字符，由数字和字母组成。

projectId

String

参数解释：

项目ID。

取值范围：

32位字符，由数字和字母组成。

region

String

参数解释：

局点。

取值范围：

不涉及。

status

Boolean

参数解释：

通用Webhook状态。

取值范围：

  • true：启用。

  • false：未启用。

useIam

Boolean

参数解释：

是否使用IAM。

取值范围：

  • true：使用IAM。

  • false：不使用IAM。

webhookUrl

String

参数解释：

通用WebHooK地址。

取值范围：

不涉及。

请求示例

GET https://{endpoint}/v5/0b015e21d3054a3fb03839c43b7cd034/pipelines/12780316f8ca4d8c86bee1bcf24691be/webhook

响应示例

状态码：200

OK

{
  "pipelineId" : "36dd030a69324d489e4241db387acbdf",
  "projectId" : "4fd6dac138aa4d4d965140a19b26a810",
  "region" : "{region}",
  "status" : true,
  "useIam" : false,
  "webhookUrl" : "https://wxample.com/v5/4fd6dac138aa4d4d965140a19b26a810/pipelines/36dd030a69324d489e4241db387acbdf/webhook/callback-run/{region}?access_token=c60d5a520b2a42a1afb1c07ec0666e49"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题：流水线管理