获取消息通知配置 - ShowNotificationSetting

功能介绍

获取消息通知配置。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
AccessAnalyzer:notificationSetting:get	Read	notificationSetting *	-	-	-

URI

GET /v5/notification-settings/{notification_setting_id}

表1 路径参数
参数	是否必选	参数类型	描述
notification_setting_id	是	String	参数解释：消息通知配置的唯一标识符。您可以调用 ListNotificationSettings API。此接口会返回一个消息通知配置的列表，列表中的每个配置摘要对象都包含其唯一的id字段，这就是消息通知配置ID。取值范围：最小长度为1，最大长度为36。仅支持包含字母、数字、下划线（_）和中划线（-）。

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
id	String	参数解释：消息通知配置的唯一标识符。取值范围：最小长度为1，最大长度为36。仅支持包含字母、数字、下划线（_）和中划线（-）。
urn	String	参数解释：消息通知配置的唯一资源标识符。取值范围：最小长度为1，最大长度为1500。
analyzer_id	String	参数解释：分析器的唯一标识符。取值范围：最小长度为1，最大长度为36。仅支持包含字母、数字、下划线（_）及中划线（-）。
analyzer_name	String	参数解释：分析器的名称。取值范围：最小长度为1，最大长度为255。仅支持包含字母、数字、下划线（_）、中划线（-）和点号（.）。
analyzer_type	String	参数解释：分析器的类型。取值范围： account: 账号级外部访问分析器 organization：组织级外部访问分析器 account_unused_access：账号级未使用访问分析器 organization_unused_access：组织级未使用访问分析器 account_privilege_escalation：账号级提权访问分析器 account_iam_best_practice：账号级IAM最佳实践分析器
mc_switch	Boolean	参数解释：是否开启消息中心通知开关。取值范围：不涉及。
smn_topic_urns	Array of strings	参数解释：消息通知配置的SMN主题URN列表。取值范围：数组长度为0到3。数组元素为字符串，最小长度为1，最大长度为1500。
created_at	String	参数解释：创建消息通知配置的时间。使用UTC +0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。例如：2023-09-07T07:51:10.502Z。取值范围：不涉及。
updated_at	String	参数解释：上次更新消息通知配置的时间。使用UTC +0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。例如：2023-09-07T07:51:10.502Z。取值范围：不涉及。

状态码：400

表3 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：不涉及。
error_msg	String	参数解释：错误信息。取值范围：不涉及。
request_id	String	参数解释：请求 ID。取值范围：不涉及。
encoded_authorization_message	String	参数解释：鉴权信息。取值范围：不涉及。

状态码：403

表4 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：不涉及。
error_msg	String	参数解释：错误信息。取值范围：不涉及。
request_id	String	参数解释：请求 ID。取值范围：不涉及。
encoded_authorization_message	String	参数解释：鉴权信息。取值范围：不涉及。

状态码：404

表5 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：不涉及。
error_msg	String	参数解释：错误信息。取值范围：不涉及。
request_id	String	参数解释：请求 ID。取值范围：不涉及。
encoded_authorization_message	String	参数解释：鉴权信息。取值范围：不涉及。

请求示例

获取消息通知配置。

GET https://{hostname}/v5/notification-settings/{notification_setting_id}

响应示例

状态码：200

{
  "id" : "{notification_setting_id}",
  "urn" : "AccessAnalyzer:{region_id}:{domain_id}:notificationSetting:{notification_setting_id}",
  "analyzer_id" : "3de500b3f6c74b0a8ef170656f8a6376",
  "analyzer_type" : "account",
  "analyzer_name" : "external_analyzer_1",
  "mc_switch" : true,
  "smn_topic_urns" : [ "urn:smn:cn-north-7:******:test1" ],
  "created_at" : "2023-09-07T08:04:41.698Z",
  "updated_at" : "2023-09-07T08:04:41.698Z"
}