All Products
Search
Document Center

Auto Scaling:DescribeAlertConfiguration

Last Updated:Aug 07, 2024

Queries the status of scaling activities that trigger text message, internal message, or email-based notifications. When you call the DescribeAlertConfiguration operation, you must specify the scaling group ID and region ID to query the status of the desired scaling activities. A scaling activity can be in one of the following states: Successful, Failed, and Rejected.

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 DescribeAlertConfiguration

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

ScalingGroupId String Yes asg-bp18p2yfxow2dloq****

The ID of the scaling group.

RegionId String Yes cn-hangzhou

The region ID of the scaling group.

Response parameters

Parameter

Type

Example

Description

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

The request ID.

ScaleStatuses Array of String ScaleSuccessful

The status of the scaling activities that trigger text message, internal message, or email-based notifications. Valid values:

  • ScaleSuccessful: Notifications are sent if scaling activities are successfully complete.
  • ScaleRejected: Notifications are sent if scaling activities are rejected.
  • ScaleFailed: Notifications are sent if scaling activities failed.

Examples

Sample requests

http(s)://ess.aliyuncs.com/?Action=DescribeAlertConfiguration
&ScalingGroupId=asg-bp18p2yfxow2dloq****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

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

<DescribeAlertConfigurationResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <ScaleStatuses>ScaleSuccessful</ScaleStatuses>
</DescribeAlertConfigurationResponse>

JSON format

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

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "ScaleStatuses" : [ "ScaleSuccessful" ]
}

Error codes

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