云数据库独享集群数据结构

ApiServerNetwork

连通 DB Custom 集群 API Server 的网络配置。

被如下接口引用：CreateDBCustomCluster, DescribeDBCustomClusterDetail。

名称	类型	必选	描述
VpcId	String	是	API Server的访问私有网络ID 示例值：vpc-evvog2gd
SubnetId	String	是	API Server的访问私有网络子网ID 示例值：subnet-clk8il4i

ContainerNetwork

联通 DB Custom 集群中容器的网络配置。

被如下接口引用：CreateDBCustomCluster, DescribeDBCustomClusterDetail。

名称	类型	必选	描述
VpcId	String	是	容器网络的虚拟网络ID 示例值：vpc-evvog2gd
SubnetIds	Array of String	是	容器网络的虚拟网络子网列表示例值：["subnet-clk8il4i"]

DBCustomCluster

DB Custom 集群信息。

被如下接口引用：DescribeDBCustomClusters。

名称	类型	描述
ClusterId	String	集群ID 示例值：dbcc-0cj0av3j
ClusterName	String	集群名称示例值：dbcc-0cj0av3j
Region	String	集群支持的地域示例值：ap-shanghai
ClusterLevel	String	集群规模默认值：L500 示例值：L500
ClusterStatus	String	DB Custom 集群状态枚举值： Creating：创建中 Running：运行中 Destroying：销毁中示例值：Running
ClusterVersion	String	集群版本号示例值：1.28.3
ClusterNodeNum	Integer	集群中的节点数量单位：台示例值：0
ClusterDescription	String	集群描述示例值：该集群用于测试集群购买流程
CreatedTime	String	创建时间示例值：2026-05-29T15:09:14Z
Tags	Array of Tag	集群的标签信息注意：此字段可能返回 null，表示取不到有效值。

DBCustomClusterNode

DB Custom 集群节点信息。

被如下接口引用：DescribeDBCustomClusterNodes。

名称	类型	描述
NodeId	String	节点ID 示例值：dbcn-0zan5xxk
NodeName	String	节点名称示例值：测试节点1
LanIP	String	节点内网IP地址示例值：10.0.0.1
SSHEndpoint	String	节点SSH 访问的Endpoint。格式为IP:Port. 示例值：10.0.0.100:36000
Status	String	节点在集群中的实例状态示例值：Running
Zone	String	节点所属的地域示例值：ap-shanghai-5
NodeType	String	节点类型枚举值： DB.AT5.32XLARGE512：高IO型服务器：128核心512GB内存，87180GB本地NvME SSDB。 DB.AT5.64XLARGE1152：高IO型服务器：256核心1152GB内存，127180GB本地NvME SSDB。 DB.AT5.128XLARGE2304：高IO型服务器：512核心2304GB内存，247180GB本地NvME SSDB。 DB.AT5.16XLARGE256：高IO型服务器：64核心256GB内存，47180GB本地NvME SSDB。 DB.AT5.8XLARGE128：高IO型服务器：32核心128GB内存，2*7180GB本地NvME SSDB。示例值：DB.AT5.8XLARGE128

DBCustomImage

DB Custom 可选的镜像信息。

被如下接口引用：DescribeDBCustomImages。

名称	类型	描述
ImageId	String	镜像ID 示例值：img-1tmhysjj
OsName	String	操作系统名称示例值：TencentOS Server 3.2 with Driver
ImageType	String	镜像类型枚举值： PUBLIC_IMAGE：公共镜像 (腾讯云官方镜像) PRIVATE_IMAGE：私有镜像 (客户专属镜像) 示例值：PUBLIC_IMAGE
Architecture	String	操作系统架构枚举值： x86_64： X86 64位架构 arm64： ARM 64位机构示例值：x86_64

DBCustomNode

DB Custom 节点信息。

被如下接口引用：DescribeDBCustomNodes。

名称	类型	描述
NodeId	String	节点ID 示例值：dbcn-d82is5s0
NodeName	String	节点名称示例值：dbcn-d82is5s0
SSHEndpoint	String	访问此节点的SSH Endpoint，格式为IP:Port 示例值：10.0.0.100:36000
LanIP	String	节点的内网通信IP地址示例值：10.0.0.1
ClusterId	String	节点所属的集群ID 示例值：dbcc-jnfqi1b9
Zone	String	节点所属的可用区示例值：ap-shanghai-5
NodeType	String	节点类型枚举值： DB.AT5.32XLARGE512：高IO型服务器：128核心512GB内存，87180GB本地NvME SSDB。 DB.AT5.64XLARGE1152：高IO型服务器：256核心1152GB内存，127180GB本地NvME SSDB。 DB.AT5.128XLARGE2304：高IO型服务器：512核心2304GB内存，247180GB本地NvME SSDB。 DB.AT5.16XLARGE256：高IO型服务器：64核心256GB内存，47180GB本地NvME SSDB。 DB.AT5.8XLARGE128：高IO型服务器：32核心128GB内存，2*7180GB本地NvME SSDB。示例值：DB.AT5.8XLARGE128
CPU	Integer	节点CPU大小单位：核示例值：0
Memory	Integer	节点内存单位：GiB 示例值：0
SystemDisk	SystemDisk	系统盘信息注意：此字段可能返回 null，表示取不到有效值。
DataDisks	Array of DataDisk	数据盘信息注意：此字段可能返回 null，表示取不到有效值。
OsName	String	节点的操作系统名称示例值：TencentOS Server 3.2 with Driver
ImageId	String	节点的操作系统镜像ID 示例值：img-1tmhysjj
VpcId	String	节点SSH Endpoint 所属的VPC ID 示例值：vpc-evvog2gd
SubnetId	String	节点SSH Endpoint 所属的VPC 子网ID 示例值：subnet-clk8il4i
Status	String	节点状态枚举值： Creating：创建中 Running：运行中 Isolating：隔离中 Isolated：已隔离 Activating：解除隔离中 Destroying：销毁中示例值：Isolated
ChargeType	String	付费类型枚举值： PREPAID：包年包月示例值：PREPAID
ExpireTime	String	节点到期时间示例值：2026-07-28T17:58:46Z
CreatedTime	String	节点创建时间示例值：2026-05-28T17:58:46Z
IsolatedTime	String	节点隔离时间示例值：2026-05-28T17:44:43Z
Tags	Array of Tag	节点标签信息注意：此字段可能返回 null，表示取不到有效值。
AutoRenew	Integer	节点是否自动续费标记枚举值： 1：自动续费 2：不自动续费示例值：1
SwitchId	String	交换机ID（已加密）示例值：3E7A16039D8E141849DE7C837DE70ECC
RackId	String	机架ID（已加密）示例值：3E5BA837F9B5FFD91DCC02DBF501C7A7
HostIp	String	底层物理机IP（已加密）示例值：7E87DEECE245155C880A7CF5355CD81F

DBInstanceDetail

DB实例详情

被如下接口引用：DescribeDBInstances。

名称	类型	描述
InstanceId	String	DB实例Id 示例值：tdsql-test
InstanceName	String	DB实例名称示例值：tdsql-test
Status	Integer	DB实例状态,-1:已隔离, 0:创建中, 1:流程中, 2:运行中, 3:未初始化示例值：2
StatusDesc	String	DB实例状态描述,-1:已隔离, 0:创建中, 1:流程中, 2:运行中, 3:未初始化示例值：2
DbVersion	String	DB实例版本示例值：5.7.17
Vip	String	Vip信息示例值：10.0.0.1
Vport	Integer	Vip使用的端口号示例值：3306
UniqueVpcId	String	字符串型的私有网络ID 示例值：vpc-test
UniqueSubnetId	String	字符串型的私有网络子网ID 示例值：subnet-test
Shard	Integer	是否为分布式版本,0:否,1:是示例值：1
NodeNum	Integer	DB实例节点数示例值：3
Cpu	Integer	CPU规格(单位:核数) 示例值：2
Memory	Integer	内存规格(单位:GB) 示例值：10
Disk	Integer	磁盘规格(单位:GB) 示例值：10
ShardNum	Integer	分布式类型的实例的分片数示例值：2
Region	String	地域示例值：ap-guangzhou
Zone	String	可用区示例值：ap-guangzhou-1
DbHosts	String	Db所在主机列表, 格式: m1,s1\|m2,s2 示例值：svr-test1\|svr-test2
HostRole	Integer	主机角色, 1:主, 2:从, 3:主+从示例值：1
DbEngine	String	DB引擎，MySQL,Percona,MariaDB 示例值：MySQL
CreateTime	String	创建时间示例值：2022-05-10 12:00:00
Zones	Array of String	可用区列表示例值：["ap-guangzhou-1","ap-guangzhou-2"]

DataDisk

DB Custom 节点数据盘信息。

被如下接口引用：DescribeDBCustomNodes。

名称	类型	描述
DiskType	String	磁盘类型枚举值： CLOUD_HSSD：增强型云硬盘 LOCAL_NVME：本地硬盘示例值：CLOUD_HSSD
DiskSize	Integer	磁盘大小单位：GiB 示例值：200
DiskName	String	磁盘名称示例值：ImageDisk

名称

类型

描述

DiskType

String

磁盘类型

枚举值：

CLOUD_HSSD：增强型云硬盘
LOCAL_NVME：本地硬盘

示例值：CLOUD_HSSD

DiskSize

Integer

磁盘大小

单位：GiB

示例值：200

DiskName

String

磁盘名称

示例值：ImageDisk

DescribeInstanceDetail

独享集群详情

被如下接口引用：DescribeInstanceList。

名称	类型	描述
InstanceId	String	独享集群实例Id 示例值：dbdc-test
InstanceName	String	独享集群实例名称示例值：dbdc-test
Region	String	地域示例值：ap-guangzhou
ProductId	Integer	产品ID, 0:CDB, 1:TDSQL 示例值：0
Type	Integer	集群类型, 0:公有云, 1:金融围笼, 2:CDC集群示例值：0
HostType	Integer	主机类型, 0:物理机, 1:CVM机型, 2:CDC机型示例值：0
AutoRenewFlag	Integer	自动续费标志, 0:未设置, 1:自动续费, 2:到期不续费示例值：0
Status	Integer	集群状态示例值：1
StatusDesc	String	集群状态描述示例值：运行中
CreateTime	String	创建时间示例值：2021-04-28 00:00:00
PeriodEndTime	String	到期时间示例值：2021-05-28 00:00:00
HostNum	Integer	主机数示例值：1
DbNum	Integer	DB实例数示例值：1
AssignStrategy	Integer	分配策略, 0:紧凑, 1:均匀示例值：0
CpuSpec	Integer	总主机CPU(单位:核数) 示例值：100
CpuAssigned	Integer	总已分配CPU(单位:核数) 示例值：100
CpuAssignable	Integer	总可分配CPU(单位:核数) 示例值：100
MemorySpec	Integer	总主机内存(单位:GB) 示例值：100
MemoryAssigned	Integer	总已分配内存(单位:GB) 示例值：100
MemoryAssignable	Integer	总可分配内存(单位:GB) 示例值：100
DiskSpec	Integer	总机器磁盘(单位:GB) 示例值：1000
DiskAssigned	Integer	总已分配磁盘(单位:GB) 示例值：1000
DiskAssignable	Integer	总可分配磁盘(单位:GB) 示例值：1000
Zone	String	可用区示例值：ap-guangzhou-3
FenceId	String	金融围笼ID 示例值：cage-x-x
ClusterId	String	所属集群ID(默认集群为空) 示例值：cluster-xxx
ResourceTags	Array of ResourceTag	实例标签
CpuType	String	CPU类型：Intel/AMD,Hygon 示例值：Intel/AMD
Zones	Array of String	可用区列表示例值：["ap-guangzhou-1","ap-guangzhou-2"]

DeviceInfo

设备信息

被如下接口引用：DescribeInstances。

名称	类型	描述
DeviceId	Integer	设备ID 示例值：18504
DeviceNo	String	设备No 示例值：SNxxx
DevClass	String	设备类型示例值：SH12
MaxMemory	Float	设备总内存，单位GB 示例值：576
MaxDisk	Float	设备总磁盘，单位GB 示例值：28000
RestMemory	Float	设备剩余内存，单位GB 示例值：216
RestDisk	Float	设备剩余磁盘，单位GB 示例值：6420
RawDeviceNum	Integer	设备机器个数示例值：3
InstanceNum	Integer	数据库实例个数示例值：31

Filter

描述键值对过滤器，用于条件过滤查询。

被如下接口引用：DescribeDBCustomClusterNodes, DescribeDBCustomClusters, DescribeDBCustomNodes。

名称	类型	必选	描述
Name	String	是	筛选条件示例值：node-name
Values	Array of String	是	过滤字段对应的参数值示例值：["测试节点"]

HostDetail

主机详情

被如下接口引用：DescribeHostList。

名称	类型	描述
HostId	String	主机Id 示例值：svr-test
HostName	String	主机名称示例值：svr-test
Zone	String	可用区示例值：ap-guangzhou-1
Status	Integer	主机状态示例值：1
AssignStatus	Integer	分配DB实例状态,0:可分配,1:不可分配示例值：0
HostType	Integer	主机类型, 0:物理机, 1:cvm本地盘, 2:cvm云盘示例值：0
DbNum	Integer	DB实例数示例值：1
CpuSpec	Integer	主机CPU(单位:核数) 示例值：100
CpuAssigned	Integer	已分配CPU(单位:核数) 示例值：100
CpuAssignable	Integer	可分配CPU(单位:核数) 示例值：100
MemorySpec	Integer	主机内存(单位:GB) 示例值：100
MemoryAssigned	Integer	已分配内存(单位:GB) 示例值：100
MemoryAssignable	Integer	可分配内存(单位:GB) 示例值：100
DiskSpec	Integer	主机磁盘(单位:GB) 示例值：100
DiskAssigned	Integer	已分配磁盘(单位:GB) 示例值：100
DiskAssignable	Integer	可分配磁盘(GB) 示例值：100
CpuRatio	Float	CPU分配比示例值：1.0
MemoryRatio	Float	内存分配比示例值：1.0
DiskRatio	Float	磁盘分配比示例值：1.0
MachineName	String	机型名称示例值：HYI12A
MachineType	String	机型类别示例值：SH12
PidTag	String	计费标签示例值：sv_excluster_xxx
Pid	Integer	计费ID 示例值：10811
InstanceId	String	独享集群实例Id 示例值：dbdc-test
Zones	Array of String	可用区列表示例值：["ap-guangzhou-1","ap-guangzhou-2"]

InstanceDetail

集群容量信息。

被如下接口引用：DescribeInstances。

名称	类型	描述
Status	Integer	集群状态，0：运行中，1：不在运行示例值：0
ReadWriteTotalLeaveMemory	Float	读写集群剩余内存容量，单位GB 示例值：216
ReadWriteTotalLeaveDisk	Float	读写集群剩余磁盘容量，单位GB 示例值：6420
ReadWriteTotalMemory	Float	读写集群总内存容量，单位GB 示例值：576
ReadWriteTotalDisk	Float	读写集群总磁盘容量，单位GB 示例值：28000
ReadOnlyTotalLeaveMemory	Float	只读集群剩余内存容量，单位GB 示例值：0
ReadOnlyTotalLeaveDisk	Float	只读集群剩余磁盘容量，单位GB 示例值：0
ReadOnlyTotalMemory	Float	只读集群总内存容量，单位GB 示例值：0
ReadOnlyTotalDisk	Float	只读集群总磁盘容量，单位GB 示例值：0
InstanceDeviceInfos	Array of InstanceDeviceInfo	集群设备详情示例值：见InstanceDeviceInfo数据结构

InstanceDeviceInfo

集群设备组信息。

被如下接口引用：DescribeInstances。

名称	类型	描述
InstanceId	String	集群ID 示例值：cage-gz-3-7
ReadWriteDevice	Array of DeviceInfo	读写设备组示例值：详见DeviceInfo
ReadOnlyDevice	Array of DeviceInfo	只读设备组示例值：详见DeviceInfo
FreeDevice	Array of DeviceInfo	空闲设备组示例值：详见DeviceInfo

InstanceExpand

集群扩展信息。

被如下接口引用：DescribeInstances。

名称	类型	描述
InstanceId	String	集群ID 示例值：dbdc-dcdjhdzk
InstanceName	String	集群名称示例值：exclusivetest
AppId	Integer	用户ID 示例值：1270047691
Region	String	地域示例值：ap-guangzhou
Zone	String	可用区示例值：ap-guangzhou-1
InstanceType	Integer	集群类型： 0：一主一备，1：一主两备示例值：1
InstanceStatus	Integer	集群状态: 0 集群创建中, 1 集群有效, 2 集群扩容中, 3 集群删除中, 4 集群缩容中 -1 集群已隔离 -2 集群已删除示例值：1
CreateTime	String	创建时间示例值：2021-02-25T16:08:47+08:00
AutoRenewFlag	Integer	实例自动续费标识： 0正常续费 1自动续费 2到期不续费示例值：1
Machine	String	机型示例值：SH12
PeriodEndTime	String	过期时间示例值：2021-09-25T16:08:47+08:00
InstanceDetail	InstanceDetail	集群信息示例值：详见InstanceDetail
Pid	Integer	计费侧的产品ID 示例值：10875

LoginSettings

DB Custom 节点登录相关配置。

被如下接口引用：AddNodesToDBCustomCluster, CreateDBCustomNodes。

名称类型必选描述

Password

String

否

名称	类型	必选	描述
Password	String	否	实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下： Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) `~ ! @ # $ % ^ & * - + = \| { } [ ] : ; ' , . ? / ]中的特殊符号。 Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( )` ~ ! @ # $ % ^ & * - + = \| { } [ ] : ; ' , . ? /]中的特殊符号。示例值：password@PRE123
KeyIds	Array of String	否	密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口 DescribeKeyPairs获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。入参限制：当前仅支持设置单个 ID。示例值：["skey-48hbnu45"]
KeepImageLogin	String	否	保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为true。枚举值： true：表示保持镜像的登录设置 false：表示不保持镜像的登录设置示例值：true

实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下： Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。 Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。

示例值：password@PRE123

KeyIds

Array of String

否

密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口 DescribeKeyPairs获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。

入参限制：当前仅支持设置单个 ID。

示例值：["skey-48hbnu45"]

KeepImageLogin

String

否

保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为true。

枚举值：

true：表示保持镜像的登录设置
false：表示不保持镜像的登录设置

示例值：true

ResourceTag

标签对象，包含tagKey & tagValue

被如下接口引用：DescribeInstanceDetail, DescribeInstanceList。

名称	类型	必选	描述
TagKey	String	是	标签键示例值：env
TagValue	String	是	标签值示例值：prod

SystemDisk

DB Custom 节点系统盘信息。

被如下接口引用：DescribeDBCustomNodes。

名称	类型	描述
DiskType	String	磁盘类型枚举值： CLOUD_HSSD：增强型云硬盘示例值：CLOUD_HSSD
DiskSize	Integer	磁盘大小单位：GiB 示例值：100

名称

类型

描述

DiskType

String

磁盘类型

枚举值：

CLOUD_HSSD：增强型云硬盘

示例值：CLOUD_HSSD

DiskSize

Integer

磁盘大小

单位：GiB

示例值：100

Tag

标签键值对。

被如下接口引用：CreateDBCustomCluster, CreateDBCustomNodes, DescribeDBCustomClusterDetail, DescribeDBCustomClusters, DescribeDBCustomNodes, ModifyDBCustomClusterTags, ModifyDBCustomNodeTags。

名称	类型	必选	描述
Key	String	是	标签键示例值：test-key1
Value	String	是	标签值示例值：test-key1-value

数据结构

本页目录：

ApiServerNetwork

ContainerNetwork

DBCustomCluster

DBCustomClusterNode

DBCustomImage

DBCustomNode

DBInstanceDetail

DataDisk

DescribeInstanceDetail

DeviceInfo

Filter

HostDetail

InstanceDetail

InstanceDeviceInfo

InstanceExpand

LoginSettings

ResourceTag

SystemDisk

Tag