Common parameters include common request parameters and common response parameters.

Common request parameters

Common request parameters must be included in all API requests. The following table describes the common request parameters.

Parameter Type Required Description
Format String No The format in which the response is returned.

Valid values: JSON and XML. Default value: JSON.

Version String Yes The version number of the API. Format: YYYY-MM-DD.

Set the value to 2016-04-28.

AccessKeyId String Yes The AccessKey ID provided by Alibaba Cloud.
Signature String Yes The signature string of the request.
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 20:00:00 (UTC+8) on January 10, 2021, set the parameter to 2021-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.

Common response parameters

API responses use the HTTP response format where a 2xx status code indicates a successful call and a 4xx or 5xx status code indicates a failed call. Responses can be returned in the JSON or XML format. The default response format is JSON. You can specify the response format when you call an operation.

Every response returns a unique RequestId regardless of whether the call is successful.
  • XML format
    <?xml version="1.0" encoding="utf-8"?> 
        <!--Result Root Node-->
        <Interface Name+Response>
            <!--Return Request Tag-->
            <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
            <!--Return Result Data-->
        <Interface Name+Response>
                        
  • JSON format
    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
        /*Return Result Data*/
        }