All Products
Search
Document Center

Auto Scaling:DescribeNotificationConfigurations

Last Updated:Nov 11, 2024

Queries notification settings. You can call the DescribeNotificationConfiguration operation to query notification settings of scaling events or resource changes, including the notification types and methods.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ess:DescribeNotificationConfigurationsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ScalingGroupIdstringYes

The ID of the scaling group.

asg-bp1igpak5ft1flyp****
RegionIdstringNo

The region ID of the scaling group.

cn-beijing

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
NotificationConfigurationModelsarray<object>

The notification settings.

NotificationConfigurationModelobject

The notification setting.

NotificationArnstring

The Alibaba Cloud Resource Name (ARN) of the notification method. The following list describes the value formats of this parameter:

  • If you use CloudMonitor as the notification method, the value format of this parameter is acs:ess:{region-id}:{account-id}:cloudmonitor.
  • If you use a Message Service (MNS) queue as the notification method, the value format of this parameter is acs:mns:{region-id}:{account-id}:queue/{queuename}.
  • If you use an MNS topic as the notification method, the value format of this parameter 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****
ScalingGroupIdstring

The ID of the scaling group.

asg-bp1igpak5ft1flyp****
NotificationTypesarray

The types of the notifications.

NotificationTypestring

The types of the notifications.

AUTOSCALING:SCALE_IN_SUCCESS
TimeZonestring

The time zone of the notification. The value must be in UTC. For example, a value of UTC+8 indicates that the time is 8 hours ahead of Coordinated Universal Time, and a value of UTC-7 indicates that the time is 7 hours behind Coordinated Universal Time.

UTC+8

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-08-05The response structure of the API has changedView Change Details