Public parameters

Last Updated: Sep 26, 2017

Public request parameters

Public request parameters refer to the request parameters that every interface uses.

Name Type Required? Description
Format String No Type of response values. JSON and XML are supported. XML is the default format.
Version String Yes API version number. The format is in the form of YYYY-MM-DD. The version number is 2015-11-23 if RegionID is cn - hangzhou. The version number is 2017-06-22 if RegionID is not cn - hangzhou, such as ap - southeast - 1.
AccessKeyId String Yes The AccessKeyId that Alibaba Cloud issues to a user for accessing services.
Signature String Yes The signature result string. See Signature for the signature calculation method.
SignatureMethod String Yes The signature method. HMAC-SHA1 is currently supported.
Timestamp String Yes The request’s timestamp. The date format follows the ISO8601 standard and adopts the UTC time. Format: YYYY-MM-DDThh:mm:ssZ. For example: 2015-11-23T04:00:00Z (for 12:00:00 on November 23, 2015, Beijing time).
SignatureVersion String Yes Signature algorithm version. The current version is 1.0.
SignatureNonce String Yes A unique random number. It is used to prevent replay attacks. Different random numbers must be used for different requests.
RegionId String Yes Data center information. cn-hangzhou, ap-southeast-1 and ap-southeast-2 are currently supported.

Example

  1. https://dm.aliyuncs.com/
  2. ?Format=xml
  3. &Version=2015-11-23
  4. &Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
  5. &SignatureMethod=HMAC-SHA1
  6. &SignatureNonce=e1b44502-6d13-4433-9493-69eeb068e955
  7. &SignatureVersion=1.0
  8. &AccessKeyId=key-test
  9. &Timestamp=2015-11-23T12:00:00Z

Public return parameters

The system returns a unique identification code (RequestId) each time you send a request to call an interface, no matter whether the call succeeds 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.