DescribeNotificationConfigurations - Auto Scaling - Alibaba Cloud Documentation Center

Queries the auto scaling events and resource change notifications that you created.

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 region ID of the scaling group.	cn-beijing

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
NotificationConfigurationModels	object
NotificationConfigurationModel	array<object>	The collection of auto scaling events and resource change notifications.
	array<object>
NotificationArn	string	The Alibaba Cloud Resource Name (ARN) of the notified party. The following list describes the value formats of this parameter: If the notified party is CloudMonitor, the value format is acs:ess:{region-id}:{account-id}:cloudmonitor. If the notified party is a Message Service (MNS) queue, the value format is acs:mns:{region-id}:{account-id}:queue/{queuename}. If the notified party is an MNS topic, the value format is acs:mns:{region-id}:{account-id}:topic/{topicname}. The variables in the preceding formats have the following meanings: region-id: the region ID of the scaling group. account-id: the ID of the Alibaba Cloud account. 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
	string	The types of notifications for scaling activities or resource changes.	AUTOSCALING:SCALE_IN_SUCCESS
TimeZone	string	The time zone for message notifications. The offset of the time zone relative to Coordinated Universal Time (UTC), such as UTC+8 (China Standard Time) or UTC-7 (Mountain Standard Time).	UTC+8
MessageEncoding	string	The codec for the notification message content. Valid values: PlainText: No encoding; transmitted as 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.