Last updated: 2019-11-29 19:50:48

1. API Description

Domain name for API request:

This API (DescribeDBSwitchRecords) is used to query database instance switch records.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example:

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeDBSwitchRecords
Version Yes String Common parameter. The value used for this API: 2017-03-20
Region Yes String Common parameter. For more information, please see the [list of regions] supported by the product.
InstanceId Yes String Instance ID, such as: cdb-c1nl9rpv or cdbro-c1nl9rpv. It is identical to the instance ID displayed in the database console page.
Offset No Integer A parameter for paging, indicating offset.
Limit No Integer A parameter for paging, indicating the limit on the number of results returned for a single request.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of instance switch records.
Items Array of DBSwitchInfo Details of the instance switch records.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see [Common Error Codes].

Error Code Description
CdbError Backend error or process error.
InternalError.DatabaseAccessError Database's internal error.
InvalidParameter Parameter error.

5. Example

Example 1 Query database switch records

Input example
&<Common request parameters>

Output example

  "Response": {
    "Items": [
        "SwitchTime": "2017-11-07 15:15:48",
        "SwitchType": "TRANSFER"
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "TotalCount": 1

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.