This topic describes the common parameters used in Quota Center API operations. The common parameters include common request parameters and common response parameters.
Common request parameters
Parameter | Type | Required | Description |
---|---|---|---|
Format | String | No | The format in which to return the response. Valid values:
|
Version | String | Yes | The version number of the API. The value is in the YYYY-MM-DD format. Valid value: 2020-05-10. |
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, 2013-01-10T12:00:00Z indicates 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. The number is used to prevent replay attacks. You must use different numbers for different requests. |
Sample requests
https://quotas.aliyuncs.com/?Action=ListProductQuotas
&Format=xml
&Version=2020-05-10
&AccessKeyId=testid
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dg****
&SignatureMethod=HMAC-SHA1
&TimeStamp=2020-06-01T12:00:00Z
&SignatureVersion=1.0
&SignatureNonce=NwDAxvLU6tFE0DVb
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 XML. Every response returns a unique RequestID regardless of whether the call is successful.
- A
2xx
HTTP status code indicates a successful call. - A
4xx
or5xx
HTTP status code indicates a failed call.
Sample responses
- XML format
<?xml version="1.0" encoding="utf-8"?> <!--Result Root Node--> <API Operation Name+Response> <!--Return Request Tag--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!--Return Result Data--> <API Operation Name+Response>
- JSON format
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216" /*Return Result Data*/ }
Sample responses
- XML format
<?xml version="1.0" encoding="utf-8"?> <!--Result Root Node--> <API Operation Name+Response> <!--Return Request Tag--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!--Return Result Data--> </API Operation Name+Response>
- JSON format
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216" /*Return Result Data*/ }