Common request and response parameters of Auto Scaling API (2014-08-28) - Auto Scaling

The topic describes the common request parameters and response parameters for Auto Scaling API.

Common request parameters

The following common request parameters are applicable to scenarios in which GET requests are sent in URLs to call Auto Scaling API operations.

Parameter	Type	Required	Description
Action	String	Yes	The operation that you want to perform.
AccessKeyId	String	Yes	The AccessKey ID provided to you by Alibaba Cloud. The AccessKey pair is used to call API operations for authentication, similar to how the user password is used to log on to the Auto Scaling console. For more information, see Obtain an AccessKey pair.
Signature	String	Yes	The signature string. For more information, see Signatures.
SignatureMethod	String	Yes	The encryption method of the signature string. Set the value to HMAC-SHA1.
SignatureVersion	String	Yes	The version number of the signature algorithm. Set the value to 1.0.
SignatureNonce	String	Yes	A unique, random number used to prevent replay attacks. You must use different numbers for different requests. We recommend that you use `java.util.UUID.randomUUID()` to generate a unique number in Java language.
Timestamp	String	Yes	The timestamp of a request. Specify the value in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC. For example, `2018-01-01T12:00:00Z` specifies 20:00:00 on January 1, 2018 (UTC+8).
Version	String	Yes	The version number of the API. Specify the value in the `YYYY-MM-DD` format. Set the value to 2014-08-28.
Format	String	No	The format type of the response parameters. Valid values: JSON XML Default value: JSON.

Sample request

http(s)://ess.aliyuncs.com/?Action=CreateScaling****
&Format=XML
&Version=2014-08-28
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2018-01-01T12:00:00Z
...

Common response parameters

Parameter

Type

Description

RequestId

String

The request ID.

Every response returns a unique request ID regardless of whether the request is successful.

Sample success responses

XML format

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

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

JSON format

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

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