# 获取通知信息 - ShowNotification #### 功能介绍 根据任务ID查询任务在不同事件类型下的消息通知和邮件通知配置。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-codecheck/codecheck_03_0006.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codecheck/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartscheck:task:get | Read | task \* | - | - | - | | codeartscheck:task:get | Read | - | codeartscheck:ProjectId | - | - | #### URI GET /v1/task/notification/{task_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | task_id | 是 | String | **参数解释：** 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~100000\]的字符。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | httpStatus | String | **参数解释：** HTTP响应状态。 **取值范围：** - OK：请求已成功处理，服务器返回了请求的资源或操作结果。 - ACCEPTED：请求已被服务器接受，但处理尚未完成（通常用于异步操作）。 - INTERNAL_SERVER_ERROR：接口内部异常。 - BAD_REQUEST：参数校验异常。 | | result | [NotificationResult] object | **参数解释：** 通知配置信息。 | | status | String | **参数解释：** 接口响应状态。 **取值范围：** - success：接口响应成功。 - error：接口响应失败。 | 表4NotificationResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | codeGateFailed | [TaskEventNotificationParam] object | **参数解释：** 门禁失败。 **取值范围：** 不涉及。 | | deleteTask | [TaskEventNotificationParam] object | **参数解释：** 删除任务。 **取值范围：** 不涉及。 | | executeTask | [TaskEventNotificationParam] object | **参数解释：** 任务检查完成。 **取值范围：** 不涉及。 | 表5TaskEventNotificationParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | roles | String | **参数解释:** 接收者角色。 **取值范围:** 不涉及。 | | sendMail | Boolean | **参数解释:** 是否开启邮件通知。 **取值范围:** - true：开启 - false：关闭 | | sendMessage | Boolean | **参数解释:** 是否开启消息通知。 **取值范围:** - true：开启 - false：关闭 | | sendOfficialAccount | Boolean | **参数解释:** 是否开启公众号通知。 **取值范围:** - true：开启 - false：关闭 | | sendRolesEnable | Boolean | **参数解释:** 是否发送给指定的角色。 **取值范围:** - true：发送 - false：不发送 | | sendUsersEnable | Boolean | **参数解释:** 是否发送给指定的用户。 **取值范围:** - true：发送 - false：不发送 | | userIds | String | **参数解释:** 用户列表，用户ID用英文逗号隔开。 **取值范围:** 不涉及。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 查询ID为897acf5exxx48a5013cd的最新一次消息通知。 ``` https://{endpoint}/v1/task/notification/897acf5exxx48a5013cd ``` #### 响应示例 **状态码：200** 请求成功! ``` { "httpStatus" : "OK", "result" : { "codeGateFailed" : { "roles" : "Developer", "sendMail" : true, "sendMessage" : true, "sendOfficialAccount" : false, "sendRolesEnable" : true, "sendUsersEnable" : true, "userIds" : "e8d32c5f742448228fd2ec78bdee72e4" }, "deleteTask" : { "roles" : "Developer", "sendMail" : true, "sendMessage" : true, "sendOfficialAccount" : false, "sendRolesEnable" : true, "sendUsersEnable" : true, "userIds" : "e8d32c5f742448228fd2ec78bdee72e4" }, "executeTask" : { "roles" : "Developer", "sendMail" : true, "sendMessage" : true, "sendOfficialAccount" : false, "sendRolesEnable" : true, "sendUsersEnable" : true, "userIds" : "e8d32c5f742448228fd2ec78bdee72e4" } }, "status" : "success" } ``` **状态码：400** 请求异常。 ``` { "error_code" : "CC.xxxxxxxx.400", "error_msg" : "请求参数校验失败,请检查请求参数是否正确" } ``` **状态码：401** 权限不足。 ``` { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功! | | 400 | 请求异常。 | | 401 | 权限不足。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。