CreateNotificationConfiguration - Auto Scaling - Alibaba Cloud Documentation Center

Operation description

You can configure CloudMonitor system events, Message Service (MNS) queues, or MNS topics to receive notifications. When a specified type of scaling event or resource change occurs in a scaling group, Auto Scaling sends notifications to CloudMonitor or MNS.
Different event notifications within the same scaling group cannot share the same recipient.

For example, different event notifications cannot use the same CloudMonitor instance, the same MNS topic, or the same MNS queue.

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:CreateNotificationConfiguration

create

*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****
NotificationArn	string	Yes	The identifier of the notification recipient. The following notification methods are supported: CloudMonitor. Format: `acs:ess:{region-id}:{account-id}:cloudmonitor`. MNS queue. Format: `acs:mns:{region-id}:{account-id}:queue/{queuename}`. MNS topic. Format: `acs:mns:{region-id}:{account-id}:topic/{topicname}`. The variables in the format are described as follows: `region-id`: the region ID of the scaling group. `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**:queue/modifyLifecycleHo**
NotificationType	array	Yes	One or more types of Auto Scaling event and resource change notifications. Valid values of N: 1 to 8. Specify multiple values in a repeated list format.	AUTOSCALING:SCALE_OUT_SUCCESS
	string	No	One or more types of auto scaling event and resource change notifications. Valid values of N: 1 to 8. Specify multiple values in a repeated list format. You can call the DescribeNotificationTypes operation to query the valid values of this query parameter.	AUTOSCALING:SCALE_OUT_SUCCESS
RegionId	string	No	The region ID of the scaling group.	cn-beijing
TimeZone	string	No	The time zone for message notifications. The time zone is expressed as an offset from Coordinated Universal Time (UTC), such as UTC+8 or UTC-7.	UTC+8
MessageEncoding	string	No	The encoding method for the notification content. Valid values: PlainText: no encoding. The content is transmitted in plaintext. Base64: Base64 encoding. Default value: Base64. Note This parameter is supported only for MNS notification recipients.	PlainText

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.