# 批量更新流水线消息通知 - BatchUpdatePipelineNotice #### 功能介绍 批量更新流水线消息通知 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-pipeline/pipeline_03_0006.html)。 #### URI PUT /v5/{project_id}/api/pipelines/batch-update/notice 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-pipeline/pipeline_03_0036.html)。 **约束限制**： 不涉及。 **取值范围**： 32位字符，由数字和字母组成。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | pipeline_ids | 是 | Array of strings | **参数解释**： 流水线ID列表，可以通过[查询流水线列表](https://support.huaweicloud.com/api-pipeline/ListPipelines.html)接口获取，其中pipelines.pipelineId即为流水线ID。 **约束限制**： 不涉及。 **取值范围**： 32位字符，由数字和字母组成。 **默认取值**： 不涉及。 | | notice_events | 是 | Array of [notice_events] objects | **参数解释**： 通知配置列表详情。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表3notice_events | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 否 | Integer | **参数解释**： 通知事件类型。 **取值范围**： - 1：站内信。 - 2：邮件通知。 - 3：微信。 - 4：钉钉。 - 5：飞书。 | | events | 否 | Array of [events] objects | **参数解释**： 通知事件列表详情。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | webhook_config | 否 | [webhook_config] object | **参数解释**： webhook通知事件配置。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | switch_enable | 否 | Boolean | **参数解释**： 是否启用消息通知开关。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | enable | 否 | Boolean | **参数解释**： 是否跟随项目通知设置开关。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表4events | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | **参数解释**： 事件ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | selected | 否 | Boolean | **参数解释**： 是否选中。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | notice_roles | 否 | Array of strings | **参数解释**： 通知角色列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | receivers | 否 | Array of strings | **参数解释**： 自定义成员。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表5webhook_config | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | notice_id | 否 | String | **参数解释**： 通知ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | url | 否 | String | **参数解释**： Webhook URL。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | events | 否 | Array of strings | **参数解释**： 事件列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | options | 否 | Array of strings | **参数解释**： 通知选项列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | mentioned_list | 否 | Array of strings | **参数解释**： 通知被提及列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | mentioned_mobile_list | 否 | Array of strings | **参数解释**： 被提及手机号列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | secret_info | 否 | String | **参数解释**： 密钥信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | sort_index | 否 | Integer | **参数解释**： 排序索引。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | Array of [result] objects | **参数解释**： 批量操作流水线响应体。 **取值范围**： 不涉及。 | 表7result | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pipeline_id | String | **参数解释**： 流水线ID。 **取值范围**： 32位字符，仅由数字和字母组成。 | | pipeline_name | String | **参数解释**： 流水线名称。 **取值范围**： 仅包含中文、大小写英文字母、数字、'-'和'_'，且长度为\[1,128\]个字符。 | | status | String | **参数解释**： 操作状态。DELETE_FAILED表示删除失败，DELETE_SUCCESS表示删除成功，SUCCESS表示操作成功，FAILED表示操作失败 **取值范围**： DELETE_FAILED，DELETE_SUCCESS，SUCCESS，FAILED。 | | reason | String | **参数解释**： 操作失败原因。 **取值范围**： 不涉及。 | #### 请求示例 ``` POST https://{endpoint}/v5/d80a8a6530324b7bac972cbb8a9f28ec/api/pipelines/batch-update/notice { "pipeline_ids" : [ "fe2cee7c8d2f4059a9b3b52ec0b94d11", "cbe95455be034fdb8064ede2d6b63cfd" ], "notice_events" : [ { "type" : 1, "enable" : false, "switch_enable" : true, "events" : [ { "id" : "pipelineRun.succeed", "selected" : true, "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ], "receivers" : [ "c5d7272cfff4b4495b338934fa34a345e" ] }, { "id" : "pipelineRun.failed", "selected" : true, "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ], "receivers" : [ "c5d7272cfff4b4495b338934fa34a345e" ] }, { "id" : "pipeline.deleted", "selected" : true, "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ], "receivers" : [ "c5d7272cfff4b4495b338934fa34a345e" ] }, { "id" : "pipeline.updated", "selected" : true, "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ], "receivers" : [ "c5d7272cfff4b4495b338934fa34a345e" ] } ] }, { "type" : 2, "enable" : false, "switch_enable" : true, "events" : [ { "id" : "pipelineRun.succeed", "selected" : true, "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ], "receivers" : [ "c5d7272cfff4b4495b338934fa34a345e" ] }, { "id" : "pipelineRun.failed", "selected" : true, "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ], "receivers" : [ "c5d7272cfff4b4495b338934fa34a345e" ] }, { "id" : "pipeline.deleted", "selected" : true, "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ], "receivers" : [ "c5d7272cfff4b4495b338934fa34a345e" ] }, { "id" : "pipeline.updated", "selected" : true, "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ], "receivers" : [ "c5d7272cfff4b4495b338934fa34a345e" ] } ] } ] } ``` #### 响应示例 **状态码：200** ``` { "result" : [ { "pipeline_id" : "fe2cee7c8d2f4059a9b3b52ec0b94d11", "pipeline_name" : "新建流水线-20251229203112", "status" : "SUCCESS", "reason" : null }, { "pipeline_id" : "cbe95455be034fdb8064ede2d6b63cfd", "pipeline_name" : "新建流水线-20251226154524", "status" : "SUCCESS", "reason" : null } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-pipeline/ErrorCode.html)。