edit-icon download-icon

Common parameters

Last Updated: Mar 15, 2018

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

Common request parameters

Name Type Required Description
Format String Yes Type of the return value. JSON and XML are supported. The default value is XML.
Version String Yes API version, in the format of YYYY-MM-DD. The current version is 2015-01-01.
AccessKeyId String Yes ID of the key Alibaba Cloud issued to a user to access services
Signature String Yes Signature result string. For more information about how to calculate a signature, see Signature mechanism.
SignatureMethod String Yes Signature mode. HMAC-SHA1 is supported currently.
Timestamp String Yes Request timestamp. The date format follows the ISO8601 notation, and the UTC time is used in the format of YYYY-MM-DDThh:mm:ssZ. For example, 2016-01-01T12:00:00Z (indicating 20:00:00, January 1, 2016, Beijing time).
SignatureVersion String Yes Signature algorithm version. The current version is 1.0.
SignatureNonce String Yes Unique random number, used to defend against network replay attacks. You must use different random numbers in different request periods.

Example

  1. https:// r-kvstore.aliyuncs.com/
  2. ?Format=json
  3. &Version=2015-01-01
  4. &Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
  5. &SignatureMethod=HMAC-SHA1
  6. &SignatureNonce=15215528852396
  7. &SignatureVersion=1.0
  8. &AccessKeyId=key-test
  9. &Timestamp=2016-01-01T12:00:00Z

Common return parameters

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

Example

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!—Result root node-->
  3. <API name+Response>
  4. <!—Return request tag-->
  5. <RequestId>4C4fdsf38-3910-447D-87AD-AC078932216</RequestId>
  6. <!—Return result data-->
  7. </API name+Response>
Thank you! We've received your feedback.