Common parameters-阿里云帮助中心

Common parameters, which include common request parameters and common response parameters, are required upon an operation.

Common request parameters

Common request parameters must be included in all Domains API requests.

Parameter	Type	Required	Description
Format	String	No	The format in which to return the response. Valid values: JSON and XML. Default value: XML.
Version	String	Yes	The version number of the API. The version number is in the YYYY-MM-DD format. The current version number is 2018-08-01.
AccessKeyId	String	Yes	The AccessKey ID provided by Alibaba Cloud for you to access services.
Signature	String	Yes	The signature string in the API request.
SignatureMethod	String	Yes	The signature algorithm. Currently, only HMAC-SHA1 is supported.
Timestamp	String	Yes	The request timestamp in the format of yyyy-MM-dd T HH:mm:ss z(UTC time).
SignatureVersion	String	Yes	The version of the signature algorithm. The current version is 1.0.
SignatureNonce	String	Yes	A unique, random number used to prevent replay attacks. Different requests must use different random numbers.

Sample requests

https://xxx-xxxxxxxxxx.aliyuncs.com/? Action=ListUsers
&Format=xml
&Version=2018-11-01
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1 desensitization algorithm desensitization *
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1521552885****
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2012-06-01T12:00:00Z
...

Common response parameters

Each time you send an API request, the system returns a unique identifier, regardless of whether the request is successful. RequestId, which can be used to track the execution of the request.

The correct response example is as follows:

XML format

<? xml version="1.0" encoding="UTF-8"? encoding="UTF-8"?>
<! --The root node of the result-->
<Operation name+Response>
<! --Returned request ID-->
<RequestId>4C467B38-3910-447D-87BC-AC0491******</RequestId>
<! --Returned results-->
</Operation name+response>

JSON format

{
"RequestId": "4C467B38-3910-447D-87BC-AC0491******",
/* Return Result Data */
}