Common request parameters
Common request parameters are parameters that must be included in every API call.
Name | Type | Required | Description |
|---|---|---|---|
Format | String | No | The format of the return value. JSON and XML are supported. The default value is XML. |
RegionId | String | Yes | Set this parameter to |
Version | String | Yes | The API version. The value is in the |
AccessKeyId | String | Yes | The AccessKey ID issued by Alibaba Cloud to access the service. |
Signature | String | Yes | The signature string. For more information about how to calculate the signature, see Signature mechanism. |
SignatureMethod | String | Yes | The signature method. Only HMAC-SHA1 is supported. |
Timestamp | String | Yes | The timestamp of the request. The date format follows the ISO 8601 standard and must be in UTC. The format is |
SignatureVersion | String | Yes | The version of the signature algorithm. The current version is 1.0. |
SignatureNonce | String | Yes | A unique random number that prevents network replay attacks. Use a different random number for each request. |
Example
https://cloudpush.aliyuncs.com/
?Format=XML
&RegionId=cn-hangzhou
&Version=2016-08-01
&AccessKeyId=testid
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&Timestamp=2016-02-25T12:00:00Z
&<API-specific parameters>
…Common return parameters
For each API request, the system returns a unique identifier, RequestId, regardless of whether the request succeeds or fails.
XML example
<?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 example
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
/* The returned result data */
}