All Products
Search
Document Center

Auto Scaling:ModifyNotificationConfiguration

Last Updated:Dec 17, 2024

Modifies event notification rules. Event notification rules support automatic sending of notifications to CloudMonitor, Message Service (MNS) topics, or MNS queues when a specified type of events occur. This helps you learn about the dynamics of your scaling group at the earliest opportunity and further automate resource management. If an existing event notification rule does not meet your business requirements, you can call the ModifyNotificationConfiguration operation to modify the event notification rule, without the need to create a new rule. Take not that you cannot modify the notification method of an event notification rule by calling this operation.

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:ModifyNotificationConfigurationupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ScalingGroupIdstringYes

The ID of the scaling group.

asg-bp1igpak5ft1flyp****
NotificationArnstringYes

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

  • If you specify CloudMonitor as the notification recipient, specify the value in the acs:ess:{region-id}:{account-id}:cloudmonitor format.
  • If you specify a Simple Message Queue (SMQ) queue as the notification recipient, specify the value in the acs:mns:{region-id}:{account-id}:queue/{queuename} format.
  • If you specify an SMQ topic as the notification recipient, specify the value in the acs:mns:{region-id}:{account-id}:topic/{topicname} format.

The variables in the preceding value formats have the following meanings:

  • region-id: the region ID of your scaling group.
  • account-id: the ID of your Alibaba Cloud account.
  • queuename: the name of the SMQ queue.
  • topicname: the name of the SMQ topic.
acs:ess:cn-beijing:161456884340****:cloudmonitor
NotificationTypesarrayYes

The event types.

stringYes

The event type. Valid values:

  • AUTOSCALING:SCALE_OUT_SUCCESS: a successful scale-out event
  • AUTOSCALING:SCALE_IN_SUCCESS: a successful scale-in event
  • AUTOSCALING:SCALE_OUT_ERROR: a failed scale-out event
  • AUTOSCALING:SCALE_IN_ERROR: a failed scale-in event
  • AUTOSCALING:SCALE_REJECT: a rejected scaling request
  • AUTOSCALING:SCALE_OUT_START: a started scale-out event
  • AUTOSCALING:SCALE_IN_START: a started scale-in event
  • AUTOSCALING:SCHEDULE_TASK_EXPIRING: an expiring scheduled task
  • SCALING_GROUP_DIAGNOSE: a scaling group diagnosis
  • AUTOSCALING:SCALE_OUT_WARN: a partially successful scale-out event
  • AUTOSCALG:SCALE_IN_WARN: a partially successful scale-in event
AUTOSCALING:SCALE_OUT_SUCCESS
RegionIdstringNo

The region ID of the scaling group.

cn-beijing
TimeZonestringNo

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

UTC+8

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2024-08-05The request parameters of the API has changedView Change Details