Obtaining the Message Notification Configuration List

Function

This API is used to obtain the message notification configuration list.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
AccessAnalyzer:notificationSetting:list	Read	notificationSetting *	-	-	-

URI

GET /v5/notification-settings

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition: Maximum number of results on a page. Constraints: N/A Range: The value ranges from 1 to 200. Default Value: 100
marker	No	String	Definition: Page marker. Constraints: N/A Range: The value contains 4 to 400 characters. Only letters, digits, and special characters (+/=-_) are allowed. Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
notification_settings	Array of NotificationSettingSummary objects	Definition: Message notification configuration list. Range: N/A
page_info	PageInfo object	Definition: Page information. Range: N/A

**Table 3** NotificationSettingSummary
Parameter	Type	Description
id	String	Definition: Unique identifier of the message notification configuration. Range: 1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
urn	String	Definition: Unique resource identifier of the message notification configuration. Range: The value contains 1 to 1,500 characters.
analyzer_id	String	Definition: Unique identifier of an analyzer. Range: 1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
analyzer_name	String	Definition: Analyzer name. Range: 1 to 255 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
analyzer_type	String	Definition: Analyzer type. Range: account: account-level external access analyzer organization: organization-level external access analyzer account_unused_access: account-level unused access analyzer organization_unused_access: organization-level unused access analyzer account_privilege_escalation: account-level privilege escalation access analyzer account_iam_best_practice: account-level IAM best practice analyzer
mc_switch	Boolean	Definition: Whether to enable message notifications. Range: N/A
smn_topic_urns	Array of strings	Definition: URN list of SMN topics configured for message notifications. Range: The array length ranges from 0 to 3. The array element contains 1 to 1,500 characters.
created_at	String	Definition: Time when the message notification configuration is created. The UTC+0 time zone is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-07T07:51:10.502Z. Range: N/A
updated_at	String	Definition: Time when the message notification configuration was last updated. The UTC+0 time zone is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-07T07:51:10.502Z. Range: N/A

**Table 4** PageInfo
Parameter	Type	Description
current_count	Integer	Definition: Number of items on the current page. Range: N/A
next_marker	String	Definition: If present, it indicates that the available output is more than the output contained in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this operation until the next_marker response returns null. Range: Only letters, digits, plus signs (+), slashes (/), equal signs (=), underscores (_), and hyphens (-) are allowed.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A
request_id	String	Definition: Request ID. Range: N/A
encoded_authorization_message	String	Definition: Authentication information. Range: N/A

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A
request_id	String	Definition: Request ID. Range: N/A
encoded_authorization_message	String	Definition: Authentication information. Range: N/A

Example Requests

Obtaining the message notification configuration list

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

Example Responses

Status code: 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
  }
}