edit-icon download-icon

Public parameters

Last Updated: Apr 11, 2018

Public parameters refers to the parameters that every interface call uses, including public request parameters and public return parameters.

Public request parameters

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

Name Type Required or not Description
Version String Yes API version number.
  • The format is YYYY-MM-DD.
  • The current version number is 2016-11-01.
AccessKeyId String Yes AccessKey ID used to access services, issued to a user by Alibaba Cloud.
Signature String Yes The signature result string.
See Signature Mechanism for the signature calculation method.
SignatureMethod String Yes The signature method, HMAC-SHA1 currently supported.
Timestamp String Yes The request timestamp.
  • The date format follows the ISO8601 standard and uses UTC time.
  • Format:
    YYYY-MM-DDThh:mm:ssZ.
  • Example: 2014-11-11T12:00:00Z (equivalent to 20:00:00 on November 11, 2014, Beijing time).
SignatureVersion String Yes Signature algorithm version.
The current version is 1.0.
SignatureNonce String Yes A unique random number, used to prevent network replay attacks.
You must use different random numbers for different requests.
ResourceOwnerAccount String No The resource owner account for this API request, that is the login user name.
For more information about using this parameter, see RAM resource authorization.(You can only use this parameter in the Action of the RAM in which the live resources can be authorized, or the request is rejected.)
Format String No Type of value returned, JSON and XML supported.
Default value: XML.

Example

  1. https://live.aliyuncs.com/
  2. ?Format=xml
  3. &Version=2016-11-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

The system returns a unique identification code (RequestId) each time you send a request to call an interface, whether the call succeeds or not.

Example

XMLexample

  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>

JSONexample

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  3. /* Return result data */
  4. }
Thank you! We've received your feedback.