Common parameters

Common parameters are required for all API calls and include common request parameters and common return parameters.

Common request parameters

Name	Type	Required	Description
Format	String	No	The return value is returned in JSON or XML format.
Version	String	Yes	The API version number. The format is YYYY-MM-DD. The version number for this API edition is 2019-03-27.
AccessKeyId	String	Yes	The AccessKey ID that Alibaba Cloud assigns to you for service access.
Signature	String	Yes	The signature string. For information about how to calculate a signature, see Signature mechanism.
Timestamp	String	Yes	The timestamp of the request. The date must follow the ISO 8601 standard and use UTC. The format is YYYY-MM-DDThh:mm:ssZ. For example, `2013-08-15T12:00:00Z` is 20:00:00 on August 15, 2013 (UTC+8).
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. Use a different random number for each request.

Common return parameters

The system returns a unique RequestId for every API call, regardless of whether the call is successful.

Request example

https://dg.aliyuncs.com/
?Format=xml
&Version=2019-03-27
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D 
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&OwnerId=12345678
&Timestamp=2014-10-10T12:00:00Z

Response example

API calls return data in a unified format. A 2xx HTTP status code indicates a successful call, while a 4xx or 5xx HTTP status code indicates a failed call. The response examples in this document are formatted for readability. The actual response does not include line breaks or indentation.

XML format

<?xml version="1.0" encoding="utf-8"?> 
<!--The root node of the result-->
<APIName+Response>
    <!--The request ID-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--The returned result data-->
</APIName+Response>

JSON format

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
    /* The returned result data */
}