This topic describes the common parameters that can be used to call each API operation in PolarDB-X. Common parameters include request parameters and response parameters.

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. Specify the version number in the YYYY-MM-DD format. Set the value to 2020-02-02.
AccessKeyId String Yes The AccessKey ID that is used to connect to PolarDB-X.
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, if you want to specify 20:00:00 (UTC+8) on January 10, 2013 as the value of the timestamp, set the value to 2013-01-10T12:00:00Z.

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 name of the account that owns the resource that you want to access. You can use this account to log on to PolarDB-X to call API operations.

Common response parameters

API responses use the HTTP response format. Responses can be returned in the JSON or XML format. You can specify the response format in the request. The default response format is XML. Each response returns a unique RequestId regardless of whether the call is successful.

  • A 2xx status code indicates a successful call.
  • A 4xx or 5xx 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******",
    /*Return Result Data*/
    }