All Products
Search
Document Center

Auto Scaling:CreateNotificationConfiguration

Last Updated:May 07, 2024

Creates a notification rule. You can call the CreateNotificationConfiguration operation to create a notification rule to stay informed about scaling events or resource changes. This helps you learn about the dynamic status of your scaling group in real time and further automates the management of scaling events.

Usage notes

  • You can configure CloudMonitor system events, Message Service (MNS) queues, or MNS topics to receive notifications. When a specified type of scaling activity or resource change occurs in a scaling group, Auto Scaling notifies CloudMonitor or MNS.

  • You cannot specify the same recipient service for different event notification rules in a scaling group.

    For example, if you create multiple event notification rules in a scaling group, the event notification rules cannot share the same CloudMonitor or MNS resource, such as the same MNS topic or queue.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

CreateNotificationConfiguration

The operation that you want to perform. Set the value to CreateNotificationConfiguration.

ScalingGroupId

String

Yes

asg-bp1igpak5ft1flyp****

The ID of the scaling group.

NotificationArn

String

Yes

acs:mns:cn-beijing:161456884340****:queue/modifyLifecycleHo****

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

  • If you use CloudMonitor as the recipient service, specify the value in the acs:ess:{region-id}:{account-id}:cloudmonitor format.

  • If you use an MNS queue as the recipient service, specify the value in the acs:mns:{region-id}:{account-id}:queue/{queuename} format.

  • If you use an MNS topic as the recipient service, specify the value in the acs:mns:{region-id}:{account-id}:topic/{topicname} format.

The following items describe the variables in the preceding value formats:

  • 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.

NotificationType.N

String

No

AUTOSCALING:SCALE_OUT_SUCCESS

The type of notification rule N for scaling activities or resource changes. Valid values of N: 1 to 8. Specify multiple values in the repeated list form.

You can call the DescribeNotificationTypes operation to query the values of this parameter.

RegionId

String

No

cn-beijing

The region ID of the scaling group.

Response parameters

Parameter

Type

Example

Description

RequestId

String

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

The request ID.

Examples

Sample requests

http(s)://ess.aliyuncs.com/?Action=CreateNotificationConfiguration
&ScalingGroupId=asg-bp1igpak5ft1flyp****
&NotificationArn=acs:mns:cn-beijing:161456884340****:queue/modifyLifecycleHo****
&NotificationType=["AUTOSCALING:SCALE_OUT_SUCCESS"]
&RegionId=cn-beijing
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateNotificationConfigurationResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
</CreateNotificationConfigurationResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

For a list of error codes, see Service error codes.

HTTP status code

Error code

Error message

Description

400

InvalidNotificationArn

The specified parameter notificationArn is invalid.

The value of NotificationArn is invalid.

400

InvalidNotificationTypes

The specified notification type is invalid.

The value of NotificationType.N is invalid.

400

NotificationConfigurationExist

The specified notification configuration already exist for the scalingGroup.

A notification rule for the event already exists.

400

NotificationConfigurationQuotaExceed.ForScalingGroup

NotificationConfiguration num exceed for the specified scalingGroup.

The maximum number of notification rules that you can create in the scaling group has been reached.

400

QueueNotExist

The specified queue queuename does not exist.

The MNS queue does not exist.

400

TopicNotExist

The specified topic topicname does not exist.

The MNS topic does not exist.

400

UnsupportedNotificationType.CurrentRegion

The NotificationType is not supported in the special region which scaling group belongs to.

The notification method is not supported in the region of the scaling group.

404

InvalidScalingGroupId.NotFound

The specified scaling group does not exist.

The specified scaling group does not exist.