
# 修改通用webhook开关 - SwitchGenericWebhook
#### 功能介绍
修改通用webhook开关
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-pipeline/pipeline_03_0006.html)。
#### URI
POST /v5/{project_id}/api/pipelines/{pipeline_id}/webhook/switch
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|:---|
| project_id  | 是    | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-pipeline/pipeline_03_0036.html)。 **约束限制**： 不涉及。 **取值范围**： 32位字符，由数字和字母组成。 **默认取值**： 不涉及。                              |
| pipeline_id | 是    | String | **参数解释**： 流水线ID，可以通过[查询流水线列表](https://support.huaweicloud.com/api-pipeline/ListPipelines.html)接口，其中pipelines.pipelineId即为流水线ID。 **约束限制**： 不涉及。 **取值范围**： 32位字符，仅由数字和字母组成。 **默认取值**： 不涉及。 |
   
#### 请求参数
表2请求Body参数 
| 参数             | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|
| webhook_switch | 是    | Boolean | **参数解释**： 是否打开webhook开关。 **约束限制**： 不涉及。 **取值范围**： - true：已打开webhook开关。   - false：未打开webhook开关。    **默认取值**： 不涉及。 |
| use_iam        | 是    | Boolean | **参数解释**： 是否使用IAM鉴权。 **约束限制**： 不涉及。 **取值范围**： - true：使用IAM鉴权。   - false：不使用IAM鉴权。    **默认取值**： 不涉及。              |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数     | 参数类型   | 描述                                                                                                                                                     |
|:---|:---|:---|
| status | String | **参数解释**： 返回状态。 **取值范围**： 不涉及。 |
   
#### 请求示例
```
POST https://{endpoint}/v5/93b9fc6ffc6a4edc9ab049c1f0dbec4b/api/pipelines/4a5350af4b5041d4a7fdea16d6938eb0/webhook/switch
{
  "webhook_switch" : false,
  "use_iam" : true
}
```
#### 响应示例
**状态码：200**
OK
```
{
  "status" : "success"
}
```
#### 状态码
| 状态码 | 描述 |
|:---|:---|
| 200 | OK |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-pipeline/ErrorCode.html)。
