获取消息通知配置列表 - ListNotificationSettings

功能介绍

获取消息通知配置列表。

调试

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

授权信息

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

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

URI

GET /v5/notification-settings

表1 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	参数解释：单页最大结果数。约束限制：不涉及。取值范围：最小值为1，最大值为200。默认取值： 100
marker	否	String	参数解释：页面标记。约束限制：不涉及。取值范围：最小长度为4，最大长度为400。仅支持包含大小写字母、数字及特殊字符（+、/、=、-、_）。默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
notification_settings	Array of NotificationSettingSummary objects	参数解释：消息通知配置列表。取值范围：不涉及。
page_info	PageInfo object	参数解释：页面的信息。取值范围：不涉及。

表3 NotificationSettingSummary
参数	参数类型	描述
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。取值范围：不涉及。

表4 PageInfo
参数	参数类型	描述
current_count	Integer	参数解释：当前页中的项数。取值范围：不涉及。
next_marker	String	参数解释：如果存在更多可用的输出，那么该值表示可用输出比当前响应中包含的更多。在后续调用此操作时，您可以在标记请求参数中使用此值，以获取输出的下一部分。您应该重复这个过程，直到next_marker返回为null。取值范围：仅支持包含字母、数字、加号（+）、斜线（/）、等号（=）、下划线（_）和中划线（-）。

状态码：400

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

状态码：403

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

请求示例

获取消息通知配置列表。

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

响应示例

状态码：200

{
  "notification_settings" : [ {
    "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"
  }, {
    "id" : "{notification_setting_id}",
    "urn" : "AccessAnalyzer:{region_id}:{domain_id}:notificationSetting:{notification_setting_id}",
    "analyzer_id" : "7d866d909fda4e32b1fc2aae45c34a97",
    "analyzer_type" : "account",
    "analyzer_name" : "external_analyzer_2",
    "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"
  } ],
  "page_info" : {
    "current_count" : 2,
    "next_marker" : null
  }
}