common request parameters

Common request parameters are request parameters used by each API.

Table 1. Common request parameters
Name Type Required Description
Format String No The format of the response.  Valid values:

JSON (default) | XML

Version string Yes The version of the API in the format of YYYY-MM-DD. Valid value:

2016-04-28

AccessKeyId String Yes The AccessKey ID of the user who calls the API.
Signature String Yes The request signature.
SignatureMethod String Yes The algorithm used to create the request signature. Valid value:

HMAC-SHA1

Timestamp String Yes The time at which the quest is signed in the YYYY-MM-DDThh:mm:ssZ format.

For example, 2013-01-10T12:00:00Z.

SignatureVersion String Yes The signature version to use. Valid value:

1.0

SignatureNonce String Yes A random number for the signature to prevent from network attacks.

Different random numbers must be used for different requests.

Common response parameters

The API response uses unified format. Returning 2XX HTTP status code indicates a successful call; returning 4xx or 5xx HTTP status code indicates a failed call. When a call succeeds, the formats of the returned data include XML and JSON. You can specify the format of the returned data when sending the request. The default format is XML.

A RequestId is returned no matter the request is successful or not.
  • XML format
    <? xml version="1.0" encoding="utf-8"? > 
        <!—The root node of the result-->
        <Action+Response>
            <!—The returned result-->
            <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
            <!—The returned result-->
        </Action+Response>
    
  • JSON format
    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
        /*The returned result*/
        }