Common parameters

Last Updated: Jul 03, 2017

Public request parameters

Format

  • Name: Format
  • Type: String
  • Required: No
  • Description: Return value type. The “JSON” and “XML” types are supported, and the default value is “XML”.

Version

  • Name: Version
  • Type: String
  • Required: Yes
  • Description: API version number. It is in the “YYYY-MM-DD” format and the current version number is “2015-04-01”.

AccessKeyId

  • Name: AccessKeyId
  • Type: String
  • Required: Yes
  • Description: Access key ID issued by Alibaba Cloud to users for the access service.

Signature

  • Name: Signature
  • Type: String
  • Required: Yes
  • Description: Signature result string. For details about signature calculation, refer to the signature mechanism.

SignatureMethod

  • Name: SignatureMethod
  • Type: String
  • Required: Yes
  • Description: Signature method. Currently, only “HMAC-SHA1” is supported.

SignatureVersion

  • Name: SignatureVersion
  • Type: String
  • Required: Yes
  • Description: Signature algorithm version. The current version is “1.0”.

SignatureNonce

  • Name: SignatureNonce
  • Type: String
  • Required: Yes
  • Description: Unique random number preventing network replay attacks. You must use different random numbers for different requests.

Timestamp

  • Name: Timestamp
  • Type: String
  • Required: Yes
  • Description: Timestamp for a request. The date format follows the ISO8601 standard and uses UTC time. The following is an example of the timestamp format:YYYY-MM-DDThh:mm:ssZExample: 2013-01-10T12:00:00Z (equivalent to 1/10/2013 20:00:00 Beijing time)

Request example

  1. https://sts.aliyuncs.com/
  2. ?Format=xml
  3. &Version=2015-04-01
  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

Public return parameters

  Each time you send a request to invoke an interface, the system will return a unique identification code (“RequestId”) to you, no matter the request is successful or not.

Example

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. }
Thank you! We've received your feedback.