Contents：
1. API Description
Domain name for API request: cdb.tencentcloudapi.com.
This API (DescribeDBInstanceConfig) is used to query the configuration of a database instance, including synchronization mode and deployment mode.
A maximum of 100 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: cdb.ap-shanghai-fsi.tencentcloudapi.com.
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: 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, such as cdb-c1nl9rpv. It is identical to the instance ID displayed in the database console page. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| ProtectMode | Integer | The data protection method for the master database, which is an attribute of the master instance. Possible returned values: 0 - Async replication; 1 - Semisync replication; 2 - Strongsync replication. |
| DeployMode | Integer | The deployment method for the master database, which is an attribute of the master instance. Possible returned values: 0 - Single availability zone; 1 - Multiple availability zones. |
| Zone | String | Formal name of the availability zone of the master database, such as ap-shanghai-1. |
| SlaveConfig | SlaveConfig | The configuration of the slave database |
| BackupConfig | BackupConfig | The configuration of the second slave database of ECDB. This field is only applicable to ECDB instances. |
| 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 |
|---|---|
| InvalidParameter | Parameter error. |
| InvalidParameter.InstanceNotFound | The instance does not exist. |
5. Example
Example 1 Query the configuration of a database instance
Input example
https://cdb.tencentcloudapi.com/?Action=DescribeDBInstanceConfig
&InstanceId=cdb-f35wr6wj
&<Common request parameters>Output example
{
"Response": {
"DeployMode": 1,
"ProtectMode": 0,
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"SlaveConfig": {
"ReplicationMode": "async",
"Zone": "ap-guangzhou-3"
},
"Zone": "ap-guangzhou-3"
}
}6. Other Resources
Cloud API 3.0 comes with the following development tools to make it easier to call the API.
