TDSQL MySQL版获取实例详情

1. 接口描述

接口请求域名： dcdb.tencentcloudapi.com 。

本接口（DescribeDCDBInstanceDetail）用于获取TDSQL实例详情

默认接口请求频率限制：200次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDCDBInstanceDetail。
Version	是	String	公共参数，本接口取值：2018-04-11。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID，形如dcdbt-7oaxtcb7 示例值：tdsqlshard-rlye31jd

3. 输出参数

参数名称	类型	描述
InstanceId	String	实例ID，形如dcdbt-7oaxtcb7 示例值：tdsqlshard-rlye31jd
InstanceName	String	实例名称示例值：tdsqlshard-rlye31jd
Status	Integer	实例状态。0-实例创建中；1-异步任务处理中；2-运行中；3-实例未初始化；-1-实例已隔离示例值：2
StatusDesc	String	实例目前运行状态描述示例值：运行中
Vip	String	实例内网IP地址示例值：172.16.0.39
Vport	Integer	实例内网端口示例值：3306
NodeCount	Integer	实例节点数。值为2时表示一主一从，值为3时表示一主二从示例值：2
Region	String	实例所在地域名称，形如ap-guangzhou 示例值：ap-guangzhou
VpcId	String	实例私有网络ID，形如vpc-r9jr0de3 示例值：vpc-4x1eyoyv
SubnetId	String	实例私有网络子网ID，形如subnet-6rqs61o2 示例值：subnet-58oypmoq
WanStatus	Integer	外网状态，0-未开通；1-已开通；2-关闭；3-开通中；4-关闭中示例值：0
WanDomain	String	外网访问的域名，公网可解析示例值：gz-tdsqlshard-rlye31jd.sql.tencentcdb.com
WanVip	String	外网IP地址，公网可访问示例值：43.136.248.14
WanPort	Integer	外网访问端口示例值：0
ProjectId	Integer	实例所属项目ID 示例值：0
AutoRenewFlag	Integer	实例自动续费标志。0-正常续费；1-自动续费；2-到期不续费示例值：0
ExclusterId	String	独享集群ID 示例值：dbdc-odgvdv66
PayMode	String	付费模式。prepaid-预付费；postpaid-按量计费示例值：prepaid
CreateTime	Timestamp	实例创建时间，格式为 2006-01-02 15:04:05 示例值：2020-04-08 13:59:39
PeriodEndTime	Timestamp	实例到期时间，格式为 2006-01-02 15:04:05 示例值：2020-05-08 13:59:39
DbVersion	String	数据库版本信息示例值：5.7.17
IsAuditSupported	Integer	实例是否支持审计。0-不支持；1-支持示例值：1
IsEncryptSupported	Integer	实例是否支持数据加密。0-不支持；1-支持示例值：0
Machine	String	实例母机机器型号示例值：SH02D
Memory	Integer	实例内存大小，单位 GB，各个分片的内存大小的和示例值：12
Storage	Integer	实例磁盘存储大小，单位 GB，各个分片的磁盘大小的和示例值：40
StorageUsage	Float	实例存储空间使用率，计算方式为：各个分片已经使用的磁盘大小的和/各个分片的磁盘大小的和。示例值：0.001
LogStorage	Integer	日志存储空间大小，单位GB 示例值：16
Pid	Integer	产品类型ID 示例值：11128
MasterZone	String	主DB可用区示例值：ap-guangzhou-1
SlaveZones	Array of String	从DB可用区示例值：["ap-guangzhou-1"]
Shards	Array of ShardBriefInfo	分片信息
Vip6	String	内网IPv6 示例值：2402:5e00:1011:2d01:1:90cb:55fa:e4f4
Cpu	Integer	实例Cpu核数示例值：1
Qps	Integer	实例QPS 示例值：4000
DbEngine	String	DB引擎示例值：Mysql
Ipv6Flag	Integer	是否支持IPv6 示例值：0
WanVipv6	String	外网IPv6地址，公网可访问示例值：2402:4e00:1012:2c01:1:90cb:55fa:e4d2
WanStatusIpv6	Integer	外网状态，0-未开通；1-已开通；2-关闭；3-开通中；4-关闭中示例值：0
WanPortIpv6	Integer	外网IPv6端口示例值：0
ResourceTags	Array of ResourceTag	标签信息
DcnFlag	Integer	DCN标志，0-无，1-主实例，2-灾备实例示例值：0
DcnStatus	Integer	DCN状态，0-无，1-创建中，2-同步中，3-已断开示例值：0
DcnDstNum	Integer	DCN灾备实例数示例值：0
InstanceType	Integer	1：主实例（独享型）, 2: 主实例, 3：灾备实例, 4：灾备实例（独享型）示例值：2
IsMaxUserConnectionsSupported	Boolean	实例是否支持设置用户连接数限制，内核为10.1暂不支持。示例值：true
DbVersionId	String	对外显示的数据库版本示例值：5.7
EncryptStatus	Integer	加密状态, 0-未开启，1-已开启示例值：0
ExclusterType	Integer	独享集群类型，0:公有云, 1:金融围笼, 2:CDC集群示例值：0
RsAccessStrategy	Integer	VPC就近访问示例值：0
ReservedNetResources	Array of ReservedNetResource	尚未回收的网络资源
IsPhysicalReplicationSupported	Boolean	是否支持物理复制示例值：true
IsDcnStrongSyncSupported	Integer	是否支持强同步DCN 示例值：1
IsDcnSwitchSupported	Integer	是否支持DCN切换示例值：1
CpuType	String	cpu类型，英特尔：Intel/AMD，海光：Hygon，默认Intel/AMD 示例值：Intel/AMD
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取实例详情

本接口用于查询实例详细信息

输入示例

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

{
    "InstanceId": "tdsqlshard-hn35cf0n"
}

输出示例

{
    "Response": {
        "AutoRenewFlag": 0,
        "Cpu": 2,
        "CpuType": "Intel/AMD",
        "CreateTime": "2025-03-22 17:01:11",
        "DbEngine": "MySQL",
        "DbVersion": "8.0.30",
        "DbVersionId": "8.0",
        "DcnDstNum": 0,
        "DcnFlag": 0,
        "DcnStatus": 0,
        "EncryptStatus": 0,
        "ExclusterId": "dbdc-00wb5kz5",
        "ExclusterType": 0,
        "InstanceId": "tdsqlshard-hn35cf0n",
        "InstanceName": "QT4st6gv8.0",
        "InstanceType": 1,
        "Ipv6Flag": 0,
        "IsAuditSupported": 1,
        "IsDcnStrongSyncSupported": 0,
        "IsDcnSwitchSupported": 1,
        "IsEncryptSupported": 1,
        "IsMaxUserConnectionsSupported": true,
        "IsPhysicalReplicationSupported": false,
        "LogStorage": 16,
        "Machine": "SH12",
        "MasterZone": "ap-guangzhou-2",
        "Memory": 4,
        "NodeCount": 2,
        "PayMode": "prepaid",
        "PeriodEndTime": "2025-03-28 15:33:44",
        "Pid": 11128,
        "ProjectId": 0,
        "Qps": 2100,
        "Region": "ap-guangzhou",
        "RequestId": "37f48ae6-6e19-421c-bc3d-9e5215bce840",
        "ReservedNetResources": [],
        "ResourceTags": [],
        "RsAccessStrategy": 0,
        "Shards": [
            {
                "Cpu": 1,
                "CreateTime": "2025-03-22 17:01:12",
                "LogDisk": 8,
                "Memory": 2,
                "NodeCount": 2,
                "NodesInfo": [
                    {
                        "NodeId": "412f4810600c",
                        "Role": "master",
                        "Zone": "ap-guangzhou-2"
                    },
                    {
                        "NodeId": "a0872cc18e43",
                        "Role": "slave",
                        "Zone": "ap-guangzhou-2"
                    }
                ],
                "ProxyVersion": "",
                "ShardInstanceId": "shard-alt5mizl",
                "ShardMasterZone": "ap-guangzhou-2",
                "ShardSerialId": "set_1742635118_5",
                "ShardSlaveZones": [
                    "ap-guangzhou-2"
                ],
                "Status": 2,
                "StatusDesc": "运行中",
                "Storage": 10,
                "StorageUsage": 0.01
            },
            {
                "Cpu": 1,
                "CreateTime": "2025-03-22 17:01:12",
                "LogDisk": 8,
                "Memory": 2,
                "NodeCount": 2,
                "NodesInfo": [
                    {
                        "NodeId": "557c152b5be8",
                        "Role": "master",
                        "Zone": "ap-guangzhou-2"
                    },
                    {
                        "NodeId": "5fa1b08b00e8",
                        "Role": "slave",
                        "Zone": "ap-guangzhou-2"
                    }
                ],
                "ProxyVersion": "",
                "ShardInstanceId": "shard-l4vjg0a3",
                "ShardMasterZone": "ap-guangzhou-2",
                "ShardSerialId": "set_1742635315_7",
                "ShardSlaveZones": [
                    "ap-guangzhou-2"
                ],
                "Status": 2,
                "StatusDesc": "运行中",
                "Storage": 10,
                "StorageUsage": 0.01
            }
        ],
        "SlaveZones": [
            "ap-guangzhou-2"
        ],
        "Status": 2,
        "StatusDesc": "运行中",
        "Storage": 20,
        "StorageUsage": 0.01,
        "SubnetId": "subnet-6rq8ehaq",
        "Vip": "10.0.0.50",
        "Vip6": "",
        "VpcId": "vpc-ilhphh7v",
        "Vport": 3306,
        "WanDomain": "",
        "WanPort": 0,
        "WanPortIpv6": 0,
        "WanStatus": 0,
        "WanStatusIpv6": 0,
        "WanVip": "",
        "WanVipv6": ""
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.OssOperationFailed	请求后端接口失败。
FailedOperation.TradeConfigNotFound	计费配置查询失败
InternalError.GetSubnetFailed	查询虚拟私有网络子网信息失败。
InternalError.OperateDatabaseFailed	数据库操作失败。
InvalidParameter	参数错误。
InvalidParameter.InstanceNotFound	未找到请求的实例。
UnauthorizedOperation.PermissionDenied	没有权限操作该接口或资源。

近期搜索热词

云服务器

云硬盘

容器服务

负载均衡

弹性伸缩

私有网络

云函数

API 网关

专线接入

批量计算

对象存储

微服务平台 TSF

文件存储

全站加速网络

消息队列 CKafka 版

日志服务

云数据库 MySQL

云数据库 MariaDB

云数据库 SQL Server

云数据库 PostgreSQL

云数据库 Redis®

内容分发网络 CDN

云数据库 Memcached

云数据库 MongoDB

TDSQL MySQL版

全球应用加速

数据传输服务

腾讯云区块链服务平台 TBaaS

云拨测

主机安全

访问管理

DDoS 防护

标签

密钥管理系统

Web 应用防火墙

操作审计

域名注册

SSL 证书

短信

数据万象

NLP 技术

云点播

云加密机

云市场

云安全中心

云开发 CloudBase

口语评测（基础版）

腾讯云数据仓库 TCHouse-P

流计算 Oceanus

Elasticsearch Service

集团账号管理

图像识别

人脸识别

文字识别

媒体处理

云直播

云联络中心

物联网通信

机器翻译

人脸融合

弹性 MapReduce

游戏数据库 TcaplusDB

腾讯云 BI

游戏多媒体引擎

实时音视频

渠道合作伙伴

TI-ONE 训练平台

数据安全审计

智能视图计算平台

数据安全治理中心

云压测

设备安全

腾讯云数据仓库 TCHouse-C

大模型图像创作引擎

云数据库 KeeWiDB

商场客留大数据

腾讯云健康看板

实时互动-教育版

数据加速器 GooseFS