Documentation

Recent Pages

DescribeDBInstanceConfig

Last updated: 2020-08-07 14:26:06

1. API Description

Domain name for API request: cdb.tencentcloudapi.com.

This API (DescribeDBInstanceConfig) is used to query the configuration information of a TencentDB instance, such as its synchronization mode and deployment mode.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cdb.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: DescribeDBInstanceConfig.
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 in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.

3. Output Parameters

Parameter Name	Type	Description
ProtectMode	Integer	Data protection mode of the primary instance. Value range: 0 (async replication), 1 (semi-sync replication), 2 (strong sync replication).
DeployMode	Integer	Master instance deployment mode. Value range: 0 (single-AZ), 1 (multi-AZ)
Zone	String	Instance AZ information in the format of "ap-shanghai-1".
SlaveConfig	SlaveConfig	Configuration information of the secondary database.
BackupConfig	BackupConfig	Configuration information of secondary database 2 of a strong sync instance.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the configuration information of TencentDB instance

Input Example

https://cdb.tencentcloudapi.com/?Action=DescribeDBInstanceConfig
&InstanceId=cdb-f35wr6wj
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "SlaveConfig": {
      "ReplicationMode": "async",
      "Zone": "ap-guangzhou-3"
    },
    "ProtectMode": 0,
    "Zone": "ap-guangzhou-3",
    "DeployMode": 1
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.