查询实例详情

最近更新时间:2026-05-22 02:46:52

我的收藏

1. 接口描述

接口请求域名: tdmysql.tencentcloudapi.com 。

本接口(DescribeDBInstanceDetail)提供查询实例详情功能

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBInstanceDetail。
Version String 公共参数,本接口取值:2021-11-22。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String

实例ID


示例值:"tdsql3-xxx"

3. 输出参数

参数名称 类型 描述
InstanceName String

实例名称


示例值:"实例名称"
Zone String

区域


示例值:"ap-guangzhou-1"
VpcId String

字符型vpcid


示例值:"vpc-o7ssr1vx"
SubnetId String

字符型subnetid


示例值:"subnet-s21doiba"
CreateVersion String

创建实例版本


示例值:"R080D001"
Vip String

子网IP


示例值:"172.16.113.202"
Vport Integer

子网端口


示例值:3306
Status String

实例状态


示例值:"running"
Disk Integer

存储节点磁盘容量,单位GB


示例值:200
StorageNodeNum Integer

存储节点数量


示例值:3
InitParams Array of InstanceParam

初始化实例参数

ResourceTags Array of ResourceTag

实例标签信息

CreateTime String

创建时间


示例值:"2006-01-02 15:04:05"
UpdateTime String

更新时间


示例值:"2006-01-02 15:04:05"
Replications Integer

存储节点副本数量


示例值:3
FullReplications Integer

全能型副本数


示例值:2
CharSet String

字符集


示例值:"utf8"
Node Array of NodeInfo

节点信息

Region String

实例所属地域


示例值:"ap-guangzhou"
SpecCode String

实例规格


示例值:"mini"
InstanceId String

实例ID


示例值:"tdsql3-xxx"
StatusDesc String

实例状态中文描述


示例值:"运行中"
StorageNodeCpu Integer

存储节点CPU核数


示例值:1
StorageNodeMem Integer

存储节点内存大小


示例值:2
RenewFlag Integer

续费标志


示例值:0
PayMode String

付费模式,0后付费,1预付费


示例值:"0"
ExpireAt String

过期时间


注意:此字段可能返回 null,表示取不到有效值。
示例值:"2006-01-02 15:04:05"
IsolatedAt String

隔离时间


注意:此字段可能返回 null,表示取不到有效值。
示例值:"2006-01-02 15:04:05"
InstanceType String

实例架构类型,separate:分离架构;hybrid:对等架构


注意:此字段可能返回 null,表示取不到有效值。
示例值:"hybrid"
StorageType String

磁盘类型,CLOUD_HSSD增强型SSD,CLOUD_TCS本地SSD盘


注意:此字段可能返回 null,表示取不到有效值。
示例值:CLOUD_HSSD
Zones Array of String

实例节点可用区列表。Zones[0]表示主可用区


示例值:["az1"]
DiskUsage Integer

最大节点磁盘使用量


注意:此字段可能返回 null,表示取不到有效值。
示例值:100
BinlogStatus Integer

binlog是否开启


示例值:0
AZMode Integer

az模式,1: 单AZ 2: 多AZ非主AZ模式 3: 多AZ主AZ模式


示例值:2
StandbyFlag Integer

灾备标志位,1: 无灾备关系;2: 灾备主实例;3: 灾备备实例


示例值:1
BinlogType String

cdc节点类型


示例值:dumper/kafka
TimingModifyInstanceFlag Integer

1表示支持,0表示不支持


示例值:1
ColumnarNodeCpu Integer

列存节点cpu核数


示例值:1
ColumnarNodeMem Integer

列存节点mem内存大小


示例值:2
ColumnarNodeNum Integer

列存节点个数


示例值:1
ColumnarNodeDisk Integer

列存节点磁盘大小


示例值:1
ColumnarNodeStorageType String

列存节点磁盘类型


示例值:CLOUD_HSSD
ColumnarNodeSpecCode String

列存节点规格


示例值:1c2g
ColumnarVip String

列存 vip


示例值:10.2.3.45
ColumnarVport Integer

列存 vport


示例值:6028
IsSupportColumnar Boolean

实例是否支持列存


示例值:true
InstanceCategory Integer

实例类型


示例值:1
SQLMode String

兼容模式


示例值:mysql
IsSwitchFullReplicationsEnable Boolean

是否支持修改全能型副本数量


示例值:true
InstanceMode String

实例类型


示例值:enhanced
DumperVip String

dumper vip


示例值:10.0.3.13
DumperVport Integer

dumper vport


示例值:3307
AutoScaleConfig AutoScalingConfig

svls实例的ccu变配范围

TemplateId String

参数模板id


示例值:template-write
TemplateName String

参数模板名称


示例值:高吞吐写入模版
AnalysisMode String

实例分析引擎模式

枚举值:

  • libra: LibraDB分析引擎实例

示例值:libra
AnalysisRelationInfos Array of AnalysisRelationInfo

分析引擎实例关系

AnalysisInstanceInfo AnalysisInstanceInfo

分析引擎实例信息

Cpu、Memory、Disk复用顶层字段

MaintenanceWindow MaintenanceWindowInfo

维护窗口配置

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例详情

输入示例

POST / HTTP/1.1
Host: tdmysql.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceDetail
<公共请求参数>

{
    "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": "运行中",
        "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"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure.CamAuthError CAM鉴权错误。
AuthFailure.CheckCamAuthError CAM鉴权请求参数检查失败。
AuthFailure.UnauthorizedOperation CAM鉴权失败。
FailedOperation.DBQueryInstanceError 查询实例数据失败。
InvalidParameterValue.InvalidParameterValueError 参数错误。