A common request parameter refers to a request parameter that is used by each API.

Common request parameters

Common request parameters are listed in the following table.

Name Type Required Description
Format String No The format of the return value. Valid values: JSON and XML. Default value: XML.
Version String Yes The version of the API in the date format of YYYY-MM-DD.
AccessKeyId String Yes The Access Key ID that is issued by Alibaba Cloud for user access.
Signature String Yes The signature result string. For more information, see Sign signatures.
SignatureMethod string Yes The signature method. Currently, HMAC-SHA1 is supported.
Timestamp String Yes The request timestamp. The format of the date follows the ISO8601 standard and uses UTC time. Format: YYYY-MM-DDThh:mm:ssZ. For example, 2013-08-15T12:00:00Z indicates 20:00:00, Aug 15, 2013, Beijing time.
SignatureVersion String Yes The version of the signature algorithm. The current version is 1.0.
SignatureNonce String Yes The unique random number. This is used to prevent replay attacks. For different requests, you must use different random numbers.


? Format=json

Common response parameters

All requests, successful or failed, are replied with a unique ID (RequestId).

  • Examples
    XML format
    <? xml version="1.0" encoding="UTF-8"? >
    <! --Result root node-->
    <operation name+response>
    <! ----returned request >
    <! --Returns the result-->
    </operation name+response>
    JSON format:
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
    /* Returned results*/