This topic describes common parameters, which include common request parameters and common response parameters. Common parameters are required by all API operations.
Common request parameters
Parameter | Type | Required | Description |
---|---|---|---|
Format | String | No | The response format. Valid values:
|
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-09. |
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.
For example, use 2013-01-10T12:00:00Z to indicate 20:00:00 on January 10, 2013 (UTC+8). |
SignatureVersion | String | Yes | The version of the signature encryption 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 random numbers for different requests. |
ResourceOwnerAccount | String | No | The Alibaba Cloud account to which the resource you want to access belongs. |
Sample requests
http://bastionhost.aliyuncs.com/?Action=TagResources
&TimeStamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2014-05-15
&SignatureVersion=1.0
&Signature=Signature
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. Every response returns a unique RequestID regardless of whether the call is successful.
- A
2xx
status code indicates a successful call. - A
4xx
or5xx
status code indicates a failed call.
Sample responses
- XML format
<?xml version="1.0" encoding="utf-8"?> <!--Result Root Node--> <Interface Name+Response> <!--Return Request Tag--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!--Return Result Data--> <Interface Name+Response>
- JSON format
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216", /*Return Result Data*/ }