This topic describes the request and response parameters that are required for all PolarDB-X 1.0PolarDB-X API operations.
Common request parameters
Parameter | Type | Required | Description |
---|---|---|---|
Format | String | No | The format in which to return the response. Valid values: JSON and XML. Default value: JSON. |
Version | String | Yes | The version number of the API, in YYYY-MM-DD format. Set the value to 2019-01-23. |
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 specifies 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 used to prevent replay attacks. You must use different numbers for different requests. |
ResourceOwnerAccount | String | No | The account that owns the resource to be accessed by this request. |
Common response parameters
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.
- An HTTP
2xx
status code indicates a successful call. - An HTTP
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-AC0491******</RequestId> <!--Return Result Data--> <Interface Name+Response>
- JSON format
{ "RequestId":"4C467B38-3910-447D-87BC-AC0491******", /*Response data*/ }