Common parameters include common request parameters and common response parameters.

Sample common parameters

Parameter Type Required Description
Format String No The format in which to return the response. Valid values:
  • JSON
  • XML (default value)
Version String Yes The version number of the API. The version number is in the YYYY-MM-DD format. Set the value to 2017-12-04.
AccessKeyId String Yes The AccessKey ID provided to you by Alibaba Cloud. For more information, see Create an AccessKey pair.
Signature String Yes The signature string of the current request. For more information about how signatures are calculated, see Request signatures.
SignatureMethod String Yes The encryption method of the signature string. Set the value to HMAC-SHA1.
Timestamp String Yes The timestamp of the request. The timestamp of the request. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

For example, to specify January 10, 2013, 20:00:00 (UTC+8), set the value to 2013-01-10T12:00:00Z.

SignatureVersion String Yes The version of the signature encryption algorithm. Set the value to 1.0.
SignatureNonce String Yes A unique, random number used to prevent replay attacks. You must use different numbers for different requests.
Sample requests

Common response parameters

API responses use the HTTP response format. Responses can be returned in either the JSON or XML format. You can specify the response format in the request. The default response format is XML. Every response returns a unique RequestId regardless of whether the call is successful.
  • A 2xx HTTP status code indicates a successful call.
  • A 4xx or 5xx HTTP status code indicates a failed call.
Sample responses
  • XML format
    <?xml version="1.0" encoding="utf-8"?> 
        <!--Result Root Node-->
        <Interface Name+Response>
            <!--Return Request Tag-->
            <!--Return Result Data-->
        </Interface Name+Response>                        
  • JSON format
        /*Return Result Data*/