All Products
Document Center

Public parameters

Last Updated: Dec 08, 2017

Public request parameters

Public request parameters indicates the request parameters required in each API call.

Name Type Required? Description
Format String No Type of returned value. JSON and XML are supported. XML is the default format.
Version String Yes API version. Format: YYYY-MM-DD. The current version is 2015-01-09.
AccessKeyId String Yes ID of the AccessKey that Alibaba Cloud issued to you to access services.
Signature String Yes Signature result. For the signature calculation method, see Signature mechanism.
SignatureMethod String Yes Signature method. HMAC-SHA1 is supported currently.
Timestamp String Yes Request time stamp. The date and time stamp uses the UTC system, and the format complies with ISO8601. The format is YYYY-MM-DDThh:mm:ssZ. For example, 2015-01-09T12:00:00Z indicates 12:00:00, January 9, 2015, Beijing time.
SignatureVersion String Yes Signature algorithm version. The current version is 1.0.
SignatureNonce String Yes A unique random number, which is used to prevent network replay attacks. Different random numbers must be used for different requests.


  2. ?Format=xml
  3. &Version=2015-01-09
  4. &Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
  5. &SignatureMethod=HMAC-SHA1
  6. &SignatureNonce=15215528852396
  7. &SignatureVersion=1.0
  8. &AccessKeyId=key-test
  9. &Timestamp=2015-01-09T12:00:00Z

Public return parameters

Each time you send a call request to an API, the system returns a unique RequestId, whether the request is successful or not.


  • XML example
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!—Result Root Node-->
  3. <Interface Name+Response>
  4. <!—Return Request Tag-->
  5. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
  6. <!—Return Result Data-->
  7. </Interface Name+Response>
  • JSON example
  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
  3. /* Return Result Data*/
  4. }