Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to query the configuration message of a cloud database instance, including sync mode and deployment mode.
A maximum of 100 requests can be initiated per second for this API.
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 Params. The value used for this API: DescribeDBInstanceConfig. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID, in the format such as cdb-c1nl9rpv. This matches the instance ID displayed on the TencentDB console. |
| Parameter Name | Type | Description |
|---|---|---|
| ProtectMode | Integer | Data protection method of the primary instance, possible returned values: 0 - asynchronous replication mode, 1 - semi-sync replication mode, 2 - strong sync replication mode. |
| DeployMode | Integer | Primary instance deployment mode. Possible returned values: 0 - single AZ deployment, 1 - multi-AZ deployment. |
| Zone | String | Primary AZ information of the instance, in the format of "ap-shanghai-2". |
| SlaveConfig | SlaveConfig | Configuration message of the first standby for two-node, three-node, and four-node instances. When querying a two-node instance, this parameter returns the standby information of the two-node instance. When querying a three-node or four-node instance, this parameter returns the first standby information of the instance. Note: This field may return null, indicating that no valid values can be obtained. |
| BackupConfig | BackupConfig | Configuration message of the second standby database for three-node and 4-node instances. When querying three-node and 4-node instances, this parameter returns the information of the second standby database. Note: This field may return null, indicating that no valid values can be obtained. |
| Switched | Boolean | Whether to switch over to the standby database. |
| FourthConfig | BackupConfig | Configuration message of the third standby database in a 4-node instance. When querying a 4-node instance, this parameter returns the info of the third standby database. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceConfig
<Common request parameters>
{
"InstanceId": "cdbro-j99ornco"
}
{
"Response": {
"BackupConfig": {
"ReplicationMode": "sync",
"Vip": "",
"Vport": 0,
"Zone": "ap-guangzhou-4"
},
"DeployMode": 0,
"FourthConfig": {
"ReplicationMode": "sync",
"Vip": "",
"Vport": 0,
"Zone": "ap-guangzhou-4"
},
"ProtectMode": 2,
"RequestId": "e6ad4a50-f251-4236-9c30-1887f330a38c",
"SlaveConfig": {
"ReplicationMode": "sync",
"Zone": "ap-guangzhou-4"
},
"Switched": false,
"Zone": "ap-guangzhou-4"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| CdbError | Backend or process error. |
| InternalError.CdbError | System error. |
| InternalError.DBOperationError | Database operation failed. |
| InternalError.InternalHttpServerError | An exception occurred while executing the request. |
| InternalError.JSONError | Failed to parse JSON. |
| InternalError.NetworkError | Network error |
| InternalError.UndefinedError | Unknown error |
| InternalError.UnknownError | Unknown error |
| InvalidParameter | Parameter error. |
| InvalidParameter.ControllerNotFoundError | This API was not found. |
| InvalidParameter.InstanceNotFound | The instance does not exist. |
| InvalidParameterValue.InvalidParameterValueError | Invalid parameter value |
| OperationDenied | Operation denied. |
フィードバック