Common parameters are required in all Database Gateway API requests. 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. The returned data is in JSON format.
Version String Yes The version number of the API, in YYYY-MM-DD format. The current version is 2019-03-27.
AccessKeyId String Yes The AccessKey ID provided to you by Alibaba Cloud.
Signature String Yes The signature string of the current request. For information about how to calculate a signature for a request, see Signature.
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, a value of 2013-08-15T12:00:00Z indicates 20:00:00 on August 15, 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 a unique random number for each request.

Common response parameters

Every response returns a unique request ID regardless of whether the call is successful.

Sample requests

Sample responses

API responses use the HTTP response format where a 2xx status code indicates a successful call and a 4xx or 5xx status code indicates a failed call. For a successful call, the returned data is in JSON format. For an external system, you can configure a parameter to specify the format of returned data when you configure request parameters. For ease of reading, the sample responses are formatted. The actual responses do not include line breaks or indentations.

XML format

<?xml version="1.0" encoding="utf-8"?> 
<!--Result root node-->
<Operation name + Response>
    <!--Return request tag-->
    <!--Return result data-->
</Operation name + Response>

JSON Format

    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
    /* Return Result Data */