DescribeNotificationConfigurations-Auto Scaling(ESS)-阿里云帮助中心

Queries the notification configurations for Auto Scaling events and resource changes of a scaling group, including event notification types and notification methods.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ess:DescribeNotificationConfigurations

get

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
ScalingGroupId	string	Yes	The ID of the scaling group.	asg-bp1igpak5ft1flyp****
RegionId	string	No	The ID of the region where the scaling group resides.	cn-beijing

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
NotificationConfigurationModels	object
NotificationConfigurationModel	array<object>	The notification configurations for Auto Scaling events and resource changes.
	array<object>
NotificationArn	string	The identity of the Notification Recipient. The parameter format is as follows: cloud monitoring: acs:ess:{region-id}:{account-id}:cloudmonitor. MNS queue: acs:mns:{region-id}:{account-id}:queue/{queuename}. MNS topic: acs:mns:{region-id}:{account-id}:topic/{topicname}. The variables in the parameter format are described as follows: region-id: the ID of the region where the scaling group resides. account-id: the Alibaba Cloud account ID. queuename: the name of the MNS queue. topicname: the name of the MNS topic.	acs:mns:cn-beijing:161456884340**:topic/modifyLifecycleHo**
ScalingGroupId	string	The ID of the scaling group.	asg-bp1igpak5ft1flyp****
NotificationTypes	object
NotificationType	array	The list of notification types for Auto Scaling events and resource changes.
	string	The list of notification types for Auto Scaling events and resource changes.	AUTOSCALING:SCALE_IN_SUCCESS
TimeZone	string	The time zone for message notifications. The time zone offset relative to Coordinated Universal Time (UTC), such as UTC+8 and UTC-7.	UTC+8
MessageEncoding	string	The encoding method for the message notification content. Valid values: PlainText: no encoding. The content is transmitted in plaintext. Base64: Base64 encoding.	PlainText

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "NotificationConfigurationModels": {
    "NotificationConfigurationModel": [
      {
        "NotificationArn": "acs:mns:cn-beijing:161456884340****:topic/modifyLifecycleHo****",
        "ScalingGroupId": "asg-bp1igpak5ft1flyp****",
        "NotificationTypes": {
          "NotificationType": [
            "AUTOSCALING:SCALE_IN_SUCCESS"
          ]
        },
        "TimeZone": "UTC+8",
        "MessageEncoding": "PlainText"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.