edit-icon download-icon

Public parameters

Last Updated: Jan 29, 2018

Public request parameters

Public request parameters are the request parameters used in each API.

Parameter Type Required Description
Format String No Type of value returned. JSON and XML are supported. The default type is XML.
Version String Yes API version number, in the YYYY-MM-DD format. The current version number is 2017-12-18.
AccessKeyId String Yes Your Key ID issued by Alibaba Cloud for access to the service.
Signature String Yes Signature result string. For more information about the signature calculation method, see Signature mechanism.
SignatureMethod String Yes Signature method. HMAC-SHA1 is currently supported.
Timestamp String Yes Time stamp of a request. The date format follows the ISO 8601 standard and uses UTC time. The format is YYYY-MM-DDThh:mm:ssZ. For example: 2015-01-09T12:00:00Z (12:00:00 on January 9, 2015 UTC).
SignatureVersion String Yes Signature algorithm version. The current version is 1.0.
SignatureNonce String Yes Unique random number, used to prevent replay attacks. Different random numbers must be used for different requests.

Example

  1. https://domain-intl.aliyuncs.com/
  2. ?Format=xml
  3. &Version=2017-12-18
  4. &Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
  5. &SignatureMethod=HMAC-SHA1
  6. &SignatureNonce=15215528852396
  7. &SignatureVersion=1.0
  8. &AccessKeyId=key-test
  9. &Timestamp=2017-12-25T12:00:00Z

Public response parameters

The system returns a unique identification code (RequestId) each time you send a request to call an API, no matter the call is successful or not.

Examples

  • XML format
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!—Result root node-->
  3. <API name+Response>
  4. <!—Returned request tag-->
  5. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</ RequestId>
  6. <!—Returned results-->
  7. </API name+Response>
  • JSON format
  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
  3. /* Returned results*/
  4. }
Thank you! We've received your feedback.