查询实例详细信息

最近更新时间:2024-04-24 01:16:05

我的收藏

1. 接口描述

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

本接口(DescribeDBInstanceDetail)用于查询指定实例的详细信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBInstanceDetail。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例Id形如:tdsql-ow728lmc。
示例值:tdsql-jv8z8fhl

3. 输出参数

参数名称 类型 描述
InstanceId String 实例Id
示例值:tdsql-jv8z8fhl
InstanceName String 实例名称
示例值:cos_test
Status Integer 实例状态
示例值:2
StatusDesc String 实例目前运行状态描述
示例值:运行中
Vip String 内网 IP 地址
示例值:192.168.240.44
Vport Integer 内网端口
示例值:3306
IsTmp Integer 是否临时实例,0为否,非0为是
示例值:0
NodeCount Integer 节点数,2为一主一从,3为一主二从
示例值:3
Region String 实例所在地域名称,如 ap-shanghai
示例值:ap-guangzhou
Zone String 实例所在可用区名称,如 ap-shanghai-1
示例值:ap-guangzhou-2
VpcId String 字符串型的私有网络Id
示例值:vpc-hqxhp43z
SubnetId String 字符串型的私有网络子网Id
示例值:subnet-15y3y4eo
WanStatus Integer 外网状态,0-未开通;1-已开通;2-关闭;3-开通中;4-关闭中
示例值:0
WanDomain String 外网访问的域名,公网可解析
WanVip String 外网 IP 地址,公网可访问
WanPort Integer 外网端口
示例值:0
ProjectId Integer 实例所属项目 Id
示例值:0
TdsqlVersion String TDSQL 版本信息
示例值:基于MariaDB 10.0.10设计(兼容MySQL 5.5)
Memory Integer 实例内存大小,单位 GB
示例值:2
Storage Integer 实例存储大小,单位 GB
示例值:10
MasterZone String 主可用区,如 ap-shanghai-1
示例值:ap-guangzhou-2
SlaveZones Array of String 从可用区列表,如 [ap-shanghai-2]
示例值:["ap-guangzhou-2","ap-guangzhou-2"]
AutoRenewFlag Integer 自动续费标志:0 否,1 是
示例值:0
ExclusterId String 独享集群Id,普通实例为空
PayMode String 付费模式:prepaid 表示预付费
示例值:prepaid
CreateTime Timestamp 实例创建时间,格式为 2006-01-02 15:04:05
示例值:2020-04-13 15:00:16
IsAuditSupported Boolean 实例是否支持审计
示例值:true
PeriodEndTime Timestamp 实例到期时间,格式为 2006-01-02 15:04:05
示例值:2019-12-06 15:00:16
Machine String 机型信息
示例值:Z4
StorageUsage String 存储空间使用率
示例值:0.000
LogStorage Integer 日志存储空间大小,单位 GB
示例值:8
IsEncryptSupported Integer 是否支持数据加密。1-支持;0-不支持
示例值:0
Vip6 String 内网IPv6
注意:此字段可能返回 null,表示取不到有效值。
Cpu Integer 实例Cpu核数
示例值:1
Pid Integer 产品类型ID
示例值:1002231
Qps Integer 最大QPS
示例值:2100
Ipv6Flag Integer 是否支持IPv6
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
WanVipv6 String 外网IPv6地址,公网可访问
注意:此字段可能返回 null,表示取不到有效值。
WanStatusIpv6 Integer 外网状态,0-未开通;1-已开通;2-关闭;3-开通中;4-关闭中
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
WanPortIpv6 Integer 外网IPv6端口
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
DbEngine String 数据库引擎
注意:此字段可能返回 null,表示取不到有效值。
示例值:Pernoca
DbVersion String 数据库版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:5.7.17
ResourceTags Array of ResourceTag 标签信息
DcnFlag Integer DCN标志,0-无,1-主实例,2-灾备实例
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DcnStatus Integer DCN状态,0-无,1-创建中,2-同步中,3-已断开
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
DcnDstNum Integer DCN灾备实例数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
InstanceType Integer 1: 主实例(独享型), 2: 主实例, 3: 灾备实例, 4: 灾备实例(独享型)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
NodesInfo Array of NodeInfo 实例的各个DB节点信息
注意:此字段可能返回 null,表示取不到有效值。
IsMaxUserConnectionsSupported Boolean 实例是否支持设置用户连接数限制,内核为10.1暂不支持。
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
DbVersionId String 对外显示的数据库版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:5.7
EncryptStatus Integer 加密状态, 0-未开启,1-已开启
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ReplicaConfig DCNReplicaConfig DCN的配置信息
注意:此字段可能返回 null,表示取不到有效值。
ReplicaStatus DCNReplicaStatus DCN的运行状态
注意:此字段可能返回 null,表示取不到有效值。
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
ProxyVersion String proxy版本号
示例值:proxy-22.1.7
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例详细信息

查询集中式实例的详细信息

输入示例

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

{
    "InstanceId": "tdsql-h178kq75"
}

输出示例

{
    "Response": {
        "AutoRenewFlag": 0,
        "Cpu": 1,
        "CreateTime": "2023-02-27 17:58:50",
        "DbEngine": "MySQL",
        "DbVersion": "8.0.24",
        "DbVersionId": "8.0",
        "DcnDstNum": 1,
        "DcnFlag": 1,
        "DcnStatus": 2,
        "EncryptStatus": 0,
        "ExclusterId": "",
        "ExclusterType": 0,
        "InstanceId": "tdsql-h178kq75",
        "InstanceName": "cdz",
        "InstanceType": 2,
        "Ipv6Flag": 0,
        "IsAuditSupported": true,
        "IsEncryptSupported": 0,
        "IsMaxUserConnectionsSupported": true,
        "IsTmp": 0,
        "LogStorage": 8,
        "Machine": "TS85",
        "MasterZone": "ap-guangzhou-3",
        "Memory": 2,
        "NodeCount": 2,
        "NodesInfo": [
            {
                "NodeId": "60af5538060f",
                "Role": "master"
            },
            {
                "NodeId": "12c58811dbfd",
                "Role": "slave"
            }
        ],
        "PayMode": "postpaid",
        "PeriodEndTime": "0001-01-01 00:00:00",
        "Pid": 1002231,
        "ProjectId": 0,
        "Qps": 2100,
        "Region": "ap-guangzhou",
        "ReplicaConfig": null,
        "ReplicaStatus": null,
        "RequestId": "40b4a902-5217-4e18-8db1-10e0ff01be62",
        "ResourceTags": [],
        "RsAccessStrategy": 0,
        "SlaveZones": [
            "ap-guangzhou-3"
        ],
        "Status": 2,
        "StatusDesc": "运行中",
        "Storage": 10,
        "StorageUsage": "0.010",
        "SubnetId": "subnet-8ve8m3xy",
        "TdsqlVersion": "基于MySQL 8.0.24设计(兼容Mysql 8.0)",
        "Vip": "10.1.0.13",
        "Vip6": "",
        "VpcId": "vpc-0rjtvrlz",
        "Vport": 3306,
        "WanDomain": "",
        "WanPort": 0,
        "WanPortIpv6": 0,
        "WanStatus": 0,
        "WanStatusIpv6": 0,
        "WanVip": "",
        "WanVipv6": "",
        "Zone": "ap-guangzhou-3",
        "ReservedNetResources": [
            {
                "VpcId": "vpc-5rske1or",
                "SubnetId": "subnet-0z3os0xe",
                "Vip": "10.1.0.6",
                "Vports": [
                    3306
                ],
                "RecycleTime": "2023-05-19 16:12:32"
            }
        ],
        "IsPhysicalReplicationSupported": true,
        "IsDcnStrongSyncSupported": 1,
        "IsDcnSwitchSupported": 1,
        "ProxyVersion": "proxy-22.1.7"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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