# 流水线消息通知根据类型查询详情 - GetPipelineMessageNoticeByType #### 功能介绍 根据消息通知类型，查询流水线具体通知配置详情 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-pipeline/pipeline_03_0006.html)。 #### URI GET /v5/{project_id}/api/pipeline-notices/{pipeline_id}/notice/detail 表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位字符，由数字和字母组成。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | Integer | **参数解释**： 流水线消息通知类型。 **约束限制**： 不涉及。 **取值范围**： - 1：站内信。 - 2：邮件通知。 - 3：微信。 - 4：钉钉。 - 5：飞书。 - 6：通用webhook。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | Integer | **参数解释**： 流水线消息通知类型。 **约束限制**： 不涉及。 **取值范围**： - 1：站内信。 - 2：邮件通知。 - 3：微信。 - 4：钉钉。 - 5：飞书。 - 6：通用webhook。 **默认取值**： 不涉及。 | | events | Array of [EventStatusDTO] objects | **参数解释**： 第三方通知事件配置。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | webhook_config | [ThirdPartEventDTO] object | **参数解释**： 第三方通知事件配置。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表4EventStatusDTO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 事件类型。 **约束限制**： 不涉及。 **取值范围**： - pipeline.updated：流水线配置被更新。 - pipeline.deleted：流水线被删除。 - pipelineRun.succeed：流水线执行成功。 - pipelineRun.failed：流水线执行失败。 **默认取值**： 不涉及。 | | selected | Boolean | **参数解释**： 是否启用事件通知。 **约束限制**： 不涉及。 **取值范围**： - true：启用通知。 - false：禁用通知。 **默认取值**： 不涉及。 | | name | String | **参数解释**： 通知事件名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | english_name | String | **参数解释**： 通知事件英文名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | resource_role_receivers | Array of strings | **参数解释**： 通知对象列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表5ThirdPartEventDTO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | notice_id | String | **参数解释**： 第三方通知配置ID，第三方通知的唯一标识。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | url | String | **参数解释**： 第三方通知URL地址，由对应第三方平台获取。 **约束限制**： URL地址只能以http://或者https://开头。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | events | Array of strings | **参数解释**： 流水线事件类型。 **约束限制**： 不涉及。 **取值范围**： - pipelineRun.succeed：已完成。 - pipelineRun.failed：失败。 - pipelineRun.pause：暂停。 - pipelineRun.suspend：挂起。 - pipelineRun.ignored：忽略。 **默认取值**： 不涉及。 | | options | Array of strings | **参数解释**： 通知内容列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | mentioned_list | Array of strings | **参数解释**： 第三方user_id列表，通过user_id使用半角逗号（,）分隔组成。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | mentioned_mobile_list | Array of strings | **参数解释**： 手机号列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | secret_info | String | **参数解释**： 加签密钥。 **约束限制**： 钉钉、飞书自定义机器人可以开启安全设置，若未使用加签，无需填写加签秘钥。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | #### 请求示例 ``` GET https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline-notices/0747d5a7099e45f69dc1d099945909a9/notice/detail ``` #### 响应示例 **状态码：200** OK ``` { "events" : [ { "id" : "pipeline.updated", "name" : null, "selected" : false, "english_name" : null, "resource_role_receivers" : null }, { "id" : "pipeline.deleted", "name" : null, "selected" : false, "english_name" : null, "resource_role_receivers" : null }, { "id" : "pipelineRun.succeed", "name" : null, "selected" : false, "english_name" : null, "resource_role_receivers" : null }, { "id" : "pipelineRun.failed", "name" : null, "selected" : false, "english_name" : null, "resource_role_receivers" : null } ], "webhook_config" : null } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad request | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-pipeline/ErrorCode.html)。