Domain name for API request: tdmysql.intl.tencentcloudapi.com.
This API is used to query instance details.
A maximum of 20 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: DescribeDBInstanceDetail. |
| Version | Yes | String | Common Params. The value used for this API: 2021-11-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceName | String | Instance name |
| Zone | String | Region |
| VpcId | String | Character type vpcid |
| SubnetId | String | Character type subnetid |
| CreateVersion | String | Create an instance version |
| Vip | String | Subnet IP |
| Vport | Integer | Subnet port |
| Status | String | Instance status |
| Disk | Integer | Node disk capacity (unit: GB) |
| StorageNodeNum | Integer | Number of storage nodes |
| InitParams | Array of InstanceParam | Initialize instance parameters |
| ResourceTags | Array of ResourceTag | Instance tag information. |
| CreateTime | String | Creation time. |
| UpdateTime | String | Update time. |
| Replications | Integer | Number of storage node replicas |
| FullReplications | Integer | Number of replicas |
| CharSet | String | Character set |
| Node | Array of NodeInfo | Node information |
| Region | String | Region of the instance |
| SpecCode | String | Instance specification |
| InstanceId | String | Instance ID. |
| StatusDesc | String | Status description in Chinese of the instance |
| StorageNodeCpu | Integer | CPU cores of the storage node |
| StorageNodeMem | Integer | Storage node memory size |
| RenewFlag | Integer | Renewal flag |
| PayMode | String | Payment mode, 0 pay-as-you-go, 1 prepaid |
| ExpireAt | String | Expiration time Note: This field may return null, indicating that no valid values can be obtained. |
| IsolatedAt | String | Isolation time Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceType | String | Instance Architecture Type, separate: decoupled architecture; hybrid: peer-to-peer architecture Note: This field may return null, indicating that no valid values can be obtained. |
| StorageType | String | Disk Type, CLOUD_HSSD enhanced SSD, CLOUD_TCS local SSD disk Note: This field may return null, indicating that no valid values can be obtained. |
| Zones | Array of String | List of instance node availability zones. Zones[0] refers to the primary AZ |
| DiskUsage | Integer | Disk usage of the largest node Note: This field may return null, indicating that no valid values can be obtained. |
| BinlogStatus | Integer | Whether binlog is enabled |
| AZMode | Integer | az mode. 1: Single az 2: Multi-az non-primary az mode 3: Multi-az primary az mode |
| StandbyFlag | Integer | Disaster recovery flag. 1: No disaster recovery relationship; 2: Primary instance for disaster recovery; 3: Disaster Recovery Standby Instance |
| BinlogType | String | cdc node type |
| TimingModifyInstanceFlag | Integer | 1 means supported, 0 means unsupported |
| ColumnarNodeCpu | Integer | cpu cores of the columnar node |
| ColumnarNodeMem | Integer | Columnar node memory size |
| ColumnarNodeNum | Integer | Number of columnar nodes |
| ColumnarNodeDisk | Integer | Columnar node disk size |
| ColumnarNodeStorageType | String | Columnar node disk type |
| ColumnarNodeSpecCode | String | Columnar node specification |
| ColumnarVip | String | Columnar storage vip |
| ColumnarVport | Integer | Columnar vport |
| IsSupportColumnar | Boolean | Whether the instance supports columnar storage |
| InstanceCategory | Integer | Instance type |
| SQLMode | String | Compatible mode |
| IsSwitchFullReplicationsEnable | Boolean | Whether modification of the number of replicas is supported |
| InstanceMode | String | Instance type |
| DumperVip | String | dumper vip |
| DumperVport | Integer | dumper vport |
| AutoScaleConfig | AutoScalingConfig | ccu adjustment range of the svls instance |
| TemplateId | String | Parameter template id |
| TemplateName | String | Parameter template name |
| AnalysisMode | String | Instance analysis engine mode Enumeration value:
|
| AnalysisRelationInfos | Array of AnalysisRelationInfo | Analysis engine instance relationship |
| AnalysisInstanceInfo | AnalysisInstanceInfo | Analysis engine instance info Cpu, Memory, and Disk reuse top-level fields |
| MaintenanceWindow | MaintenanceWindowInfo | Maintenance window configuration |
| 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: tdmysql.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceDetail
<Common request parameters>
{
"InstanceId": "tdsql3-a5952a76"
}
{
"Response": {
"AZMode": 1,
"AnalysisInstanceInfo": {
"ReplicasNum": 0
},
"AnalysisMode": "",
"AnalysisRelationInfos": [],
"BinlogStatus": 0,
"BinlogType": "",
"CharSet": "utf8mb4",
"ColumnarNodeCpu": 0,
"ColumnarNodeDisk": 0,
"ColumnarNodeMem": 0,
"ColumnarNodeNum": 0,
"ColumnarNodeSpecCode": "",
"ColumnarNodeStorageType": "",
"ColumnarVip": "",
"ColumnarVport": 0,
"CreateTime": "2026-04-20 21:18:35",
"CreateVersion": "21.6.2.0.permanent.1192.ssl",
"Disk": 100,
"DiskUsage": 19,
"DumperVip": "",
"DumperVport": 0,
"ExpireAt": "0001-01-01 00:00:00",
"FullReplications": 3,
"InitParams": [
{
"Param": "lower_case_table_names",
"Value": "1"
}
],
"InstanceCategory": 0,
"InstanceId": "tdsql3-446540ae",
"InstanceMode": "normal",
"InstanceName": "test003",
"InstanceType": "hybrid",
"IsSupportColumnar": true,
"IsSwitchFullReplicationsEnable": false,
"IsolatedAt": "0001-01-01 00:00:00",
"MaintenanceWindow": {
"Duration": 3600,
"StartTime": 10800,
"WeekDays": [
"Monday"
]
},
"Node": [
{
"BinlogInfo": [],
"Cpu": 1,
"DataDisk": 100,
"Host": "",
"IP": "10.0.70.65",
"Mem": 2,
"NodeId": "node-tdsql3-446540ae-001",
"Port": 6008,
"Type": "hybridnode",
"Zone": "ap-guangzhou-7"
}
],
"PayMode": "postPay",
"Region": "ap-guangzhou",
"RenewFlag": 0,
"Replications": 3,
"ResourceTags": [],
"SQLMode": "MySQL",
"SpecCode": "1c2g",
"StandbyFlag": 1,
"Status": "running",
"StatusDesc": "Running"
"StorageNodeCpu": 1,
"StorageNodeMem": 2,
"StorageNodeNum": 3,
"StorageType": "CLOUD_HSSD",
"SubnetId": "subnet-30tyayxk",
"TemplateId": "",
"TemplateName": "",
"TimingModifyInstanceFlag": 1,
"UpdateTime": "2026-04-23 12:13:32",
"Vip": "10.31.16.52",
"VpcId": "vpc-o7ssr1vx",
"Vport": 3306,
"Zone": "ap-guangzhou-7",
"Zones": [
"ap-guangzhou-7"
],
"RequestId": "27f36bdc-e23b-4b75-aa7c-4a4da0e836c4"
}
}
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.CamAuthError | CAM authentication error. |
| AuthFailure.CheckCamAuthError | CAM authentication request parameter check failed. |
| AuthFailure.UnauthorizedOperation | CAM authentication failure. |
| FailedOperation.DBQueryInstanceError | Query instance data failed. |
| InvalidParameterValue.InvalidParameterValueError | Parameter error |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback