edit-icon download-icon

Common parameters

Last Updated: Apr 12, 2018

This section describes the common request parameters and the common request parameters

Common request parameters

The following table describes the common parameters that comprise of a URL for a GET request over HTTP or HTTPS protocol.

Name Type Required Description
Action String Yes The target API.
AccessKeyId String Yes Equivalent to a logon password. However, an AccessKey is used to call APIs, while logon password is used to log on to the console. For more information, see Create an AccessKey.
Signature String Yes Your signature. For more information, see Signature.
SignatureMethod String Yes Signature method. Value: HMAC-SHA1.
Timestamp String Yes Request time stamp. Use the offset from Coordinated Universal Time (UTC), the time display is based on ISO8601. Format: YYYY-MM-DDThh:mm:ssZ.
For example, 2018-01-01T12:00:00Z indicates 20:00:00, Jan 01, 2018, Beijing time (UTC+8).
SignatureVersion String Yes Signature algorithm version. Value: 1.0.
SignatureNonce String Yes Unique random number, which is used to prevent network replay attacks. Different random numbers must be used for different requests.
Version String Yes The API version to use. Value: 2014-08-28.
Format String No Type of the response parameters. Optional values: json | xml.
Default value: json.

Request example

  1. https://ess.aliyuncs.com/?Action=XXXXXX
  2. &Format=xml
  3. &Version=2014-08-28
  4. &Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
  5. &SignatureMethod=HMAC-SHA1
  6. &SignatureNonce=15215528852396
  7. &SignatureVersion=1.0
  8. &AccessKeyId=key-test
  9. &Timestamp=2012-06-01T12:00:00Z

Common response parameters

Name Type Description
RequestId String The request ID. We return a unique RequestId for every API request, whether the request is successful or not.
Thank you! We've received your feedback.