This topic describes the request and response parameters that all operations use.

Common request parameters

Parameter Type Required Description
Format String No The format in which to return the response. Set the value to:

JSON and XML. Default value: JSON.

Version String Yes The version number of the API. Specify the version number in the YYYY-MM-DD format. Set the value to:

2019-12-12

AccessKeyId String Yes The AccessKey ID provided to you by Alibaba Cloud.
Signature String Yes The signature string of the current 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. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.

Example: 2013-01-10T12:00:00Z. This value indicates 20:00:00 on January 10, 2013 (UTC+8).

SignatureVersion String Yes The version of the signature algorithm. Set the value to:

1.0

SignatureNonce String Yes A unique, random number that is used to prevent replay attacks.

You must use different numbers for different requests. We recommend that you use universally unique identifiers (UUIDs).

ResourceOwnerAccount String No The Alibaba Cloud account to which the resource you want to access belongs.
Examples
https://amqp-open.aliyuncs.com/?Action=ListInstances
&Format=JSON
&Version=2019-12-12
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=e7b1f31150be45594905ce6d28561286
&SignatureVersion=1.0
&AccessKeyId=key-test
&TimeStamp=2020-02-10T08%3A43%3A05Z
...

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 JSON. Each response includes a unique request ID that is indicated by the RequestId parameter 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"?> 
        <!--Root node of the response-->
        <API operation name + Response>
            <!--Returned request ID-->
            <RequestId>D6660A81-1A96-43F3-AC00-4EE473C70AEC</RequestId>
            <!--Returned result data->
        </API operation name + Response>                        
  • JSON format
    {
        "RequestId":"D6660A81-1A96-43F3-AC00-4EE473C70AEC",
        /*Returned result data*/
    }