Understand PolarDB API Request & Response Parameters - PolarDB

Every PolarDB-X 1.0 API operation requires a common set of request parameters for authentication and versioning. Responses always include a RequestId field.

Common request parameters

Parameter	Type	Required	Description
Format	String	No	The format of the response. Valid values: JSON, XML. Default value: JSON.
Version	String	Yes	The API version in YYYY-MM-DD format. Set to `2019-01-23`.
AccessKeyId	String	Yes	The AccessKey ID provided by Alibaba Cloud.
Signature	String	Yes	The signature string of the current request.
SignatureMethod	String	Yes	The encryption algorithm used to generate the signature. Set to `HMAC-SHA1`.
Timestamp	String	Yes	The time of the request in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ` (UTC). For example, `2013-01-10T12:00:00Z` represents 20:00:00 on January 10, 2013 (UTC+8).
SignatureVersion	String	Yes	The signature algorithm version. Set to `1.0`.
SignatureNonce	String	Yes	A unique random number used to prevent replay attacks. Use a different value for each request.
ResourceOwnerAccount	String	No	The account that owns the resource being accessed.

Common response parameters

Responses are returned in JSON format by default. To receive XML responses, set the Format request parameter to XML.

Every response includes a RequestId, regardless of whether the call succeeds:

An HTTP 2xx status code indicates a successful call.
An HTTP 4xx or 5xx status code indicates a failed call.

Sample responses

XML format:

<?xml version="1.0" encoding="utf-8"?>
<!--Result Root Node-->
<InterfaceNameResponse>
    <!--Return Request Tag-->
    <RequestId>4C467B38-3910-447D-87BC-AC0491******</RequestId>
    <!--Return Result Data-->
</InterfaceNameResponse>

JSON format:

{
    "RequestId": "4C467B38-3910-447D-87BC-AC0491******"
    /*Response data*/
}