获取实例详情

最近更新时间:2024-03-12 01:25:16

我的收藏

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 外网访问的域名,公网可解析
WanVip String 外网IP地址,公网可访问
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
注意:此字段可能返回 null,表示取不到有效值。
Cpu Integer 实例Cpu核数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Qps Integer 实例QPS
注意:此字段可能返回 null,表示取不到有效值。
示例值:4000
DbEngine String DB引擎
注意:此字段可能返回 null,表示取不到有效值。
示例值:Mysql
Ipv6Flag Integer 是否支持IPv6
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
WanVipv6 String 外网IPv6地址,公网可访问
注意:此字段可能返回 null,表示取不到有效值。
WanStatusIpv6 Integer 外网状态,0-未开通;1-已开通;2-关闭;3-开通中;4-关闭中
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
WanPortIpv6 Integer 外网IPv6端口
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ResourceTags Array of ResourceTag 标签信息
DcnFlag Integer DCN标志,0-无,1-主实例,2-灾备实例
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
DcnStatus Integer DCN状态,0-无,1-创建中,2-同步中,3-已断开
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
DcnDstNum Integer DCN灾备实例数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
InstanceType Integer 1: 主实例(独享型), 2: 主实例, 3: 灾备实例, 4: 灾备实例(独享型)
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
IsMaxUserConnectionsSupported Boolean 实例是否支持设置用户连接数限制,内核为10.1暂不支持。
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
DbVersionId String 对外显示的数据库版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:5.7
EncryptStatus Integer 加密状态, 0-未开启,1-已开启
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ExclusterType Integer 独享集群类型,0:公有云, 1:金融围笼, 2:CDC集群
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
RsAccessStrategy Integer VPC就近访问
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ReservedNetResources Array of ReservedNetResource 尚未回收的网络资源
IsPhysicalReplicationSupported Boolean 是否支持物理复制
示例值:true
IsDcnStrongSyncSupported Integer 是否支持强同步DCN
示例值:1
IsDcnSwitchSupported Integer 是否支持DCN切换
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例详细信息

查询分布式实例 dcdbt-21dfpcv1 的详细信息

输入示例

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

{
    "InstanceId": "dcdbt-21dfpcv1"
}

输出示例

{
    "Response": {
        "AutoRenewFlag": 0,
        "Cpu": 3,
        "CreateTime": "2016-07-13 11:08:38",
        "DbEngine": "MariaDB",
        "DbVersion": "10.0.10",
        "DcnDstNum": 0,
        "DcnFlag": 0,
        "DcnStatus": 0,
        "ExclusterId": "",
        "InstanceId": "dcdbt-21dfpcv1",
        "InstanceName": "dcdbt-21dfpcv1",
        "InstanceType": 2,
        "Ipv6Flag": 0,
        "IsAuditSupported": 1,
        "IsEncryptSupported": 0,
        "LogStorage": 16,
        "Machine": "TS85",
        "MasterZone": "ap-guangzhou-1",
        "Memory": 6,
        "NodeCount": 2,
        "PayMode": "prepaid",
        "PeriodEndTime": "2023-01-01 11:12:24",
        "Pid": 1001670,
        "ProjectId": 0,
        "Qps": 4000,
        "Region": "ap-guangzhou",
        "RequestId": "e1828feb-9a21-409a-8964-309215615d84",
        "ResourceTags": [],
        "Shards": [
            {
                "Cpu": 2,
                "CreateTime": "2021-12-01 11:49:54",
                "LogDisk": 8,
                "Memory": 4,
                "NodeCount": 2,
                "NodesInfo": [
                    {
                        "NodeId": "85409b834943",
                        "Role": "master"
                    },
                    {
                        "NodeId": "9de9c0321ccd",
                        "Role": "slave"
                    }
                ],
                "ProxyVersion": "\"1.17.6-M-V2.0R723D002\"",
                "ShardInstanceId": "shard-ngbrea6b",
                "ShardMasterZone": "ap-guangzhou-1",
                "ShardSerialId": "set_1643096858_1",
                "ShardSlaveZones": [
                    "ap-guangzhou-1"
                ],
                "Status": 2,
                "StatusDesc": "运行中",
                "Storage": 10,
                "StorageUsage": 0.01
            },
            {
                "Cpu": 1,
                "CreateTime": "2021-12-01 11:49:54",
                "LogDisk": 8,
                "Memory": 2,
                "NodeCount": 2,
                "NodesInfo": [
                    {
                        "NodeId": "1e2025d21782",
                        "Role": "master"
                    },
                    {
                        "NodeId": "b228c46e9b63",
                        "Role": "slave"
                    }
                ],
                "ProxyVersion": "\"1.17.6-M-V2.0R723D002\"",
                "ShardInstanceId": "shard-5zf65smf",
                "ShardMasterZone": "ap-guangzhou-1",
                "ShardSerialId": "set_1643096949_3",
                "ShardSlaveZones": [
                    "ap-guangzhou-1"
                ],
                "Status": 2,
                "StatusDesc": "运行中",
                "Storage": 10,
                "StorageUsage": 0.011
            }
        ],
        "SlaveZones": [
            "ap-guangzhou-1"
        ],
        "Status": 2,
        "StatusDesc": "运行中",
        "Storage": 20,
        "StorageUsage": 0.0105,
        "SubnetId": "subnet-ovkcc9x6",
        "Vip": "10.1.0.5",
        "Vip6": "",
        "VpcId": "vpc-j97vcvb5",
        "Vport": 3306,
        "WanDomain": "",
        "WanPort": 0,
        "WanPortIpv6": 0,
        "WanStatus": 0,
        "WanStatusIpv6": 0,
        "WanVip": "",
        "WanVipv6": "",
        "IsMaxUserConnectionsSupported": true,
        "DbVersionId": "5.7",
        "EncryptStatus": 0,
        "ExclusterType": 0,
        "RsAccessStrategy": 0,
        "ReservedNetResources": [
            {
                "VpcId": "vpc-p6alckzx",
                "SubnetId": "subnet-3pz073lq",
                "Vip": "172.16.0.40",
                "Vports": [
                    3306
                ],
                "RecycleTime": "2023-05-19 16:12:32"
            }
        ],
        "IsPhysicalReplicationSupported": true,
        "IsDcnStrongSyncSupported": 1,
        "IsDcnSwitchSupported": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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