租户端数据库 TDSQL MYSQL 版（TDSQL）数据结构

数据结构

最近更新时间: 2026-07-13 00:12:19

TemplateParam

参数模板参数

被如下接口引用：DescribeConfigTemplate、DescribeDefaultConfigTemplate

名称	必选	允许NULL	类型	描述
Constraint	是	否	TemplateParamConstraint	参数约束条件示例值：查看
Default	是	否	String	参数默认值示例值： OFF
Param	是	否	String	参数名示例值： audit_txsql_audit_mode
Value	是	否	String	参数值示例值： OFF
IsTenantShow	是	否	Bool	租户端是否可见示例值： true
IsTenantEditable	是	否	Bool	租户端是否可修改示例值： true

Permission

描述对资源权限，仅内部使用。

被如下接口引用：AuthenticateCAM

名称	必选	允许NULL	类型	描述
IsPermitted	是	否	Int64	是否有权限，1 - 有权限， 0 - 无权限示例值： 1
Resource	是	否	String	资源对象示例值： *

TablePrivilege

表权限

被如下接口引用：ModifyAccountPrivileges

名称	必选	允许NULL	类型	描述
Database	是	否	String	数据库示例值： userDB
Table	是	否	String	表名示例值： user
Privileges	是	否	Array of String	权限集合示例值： ['SELECT']

InstanceConfig

实例配置

被如下接口引用：DescribeConfigHistories

名称	必选	允许NULL	类型	描述
Id	是	否	Int64	实例配置ID，形如：1 示例值： 3852
ModTime	是	否	String	修改时间示例值： 2024-11-15 15:44:37
ParamName	是	否	String	参数名称示例值： default_collation_for_utf8mb4
ParamNewValue	是	否	String	修改后参数值示例值： utf8mb4_0900_ai_ci
ParamOldValue	是	否	String	修改前参数值示例值： utf8mb4_general_ci
Status	是	否	Int64	修改状态, 0:成功, -1:失败, -2:值非法示例值： 0
Type	是	否	String	参数类型, 当前支持:Database,Proxy 示例值： Database

TmpInstance

临时实例

被如下接口引用：DescribeDBTmpInstances

名称	必选	允许NULL	类型	描述
AppId	是	是	Int64	应用ID 示例值： 1255000112
CreateTime	是	是	Datetime	创建时间示例值： 2024-11-13 18:10:22
InstanceId	是	是	String	实例 ID，形如：tdsql-ow728lmc。示例值： tdsqlshard-cq3ndzu7
InstanceRemark	是	是	String	实例备注示例值：业务实例
Ipv6Flag	是	是	Uint64	实例IPv6标志，1-支持1pv6，0-不支持ipv6 示例值： 0
PeriodEndTime	是	是	Datetime	有效期结束时间示例值： 2024-11-13 18:10:22
Region	是	是	String	实例所在地域示例值： ap-region1
SrcInstanceId	是	是	String	源实例 ID，形如：tdsql-ow728lmc。示例值： tdsqlshard-cq3ndzu8
Status	是	是	Int64	实例状态：0 创建中，1 流程处理中， 2 运行中，3 实例未初始化，-1 实例已隔离，4 实例初始化中，5 实例删除中，6 实例重启中，7 数据迁移中。示例值： 2
StatusDesc	是	是	String	实例状态描述示例值：运行中
TempType	是	是	Int64	0:非临时实例 ,1:无效临时实例, 2:回档成功的有效临时实例示例值： 2
Vip	是	是	String	实例虚IP 示例值： 10.0.0.2
Vipv6	是	是	String	实例虚IPv6 示例值： FC00:0000:130F:0000:0000:09C0:876A:130B
Vport	是	是	Int64	实例虚端口示例值： 3306
Zone	是	是	String	实例所在可用区示例值： ap-region1-1

SpecConfig

按机型分类的规格配置

被如下接口引用：DescribeShardSpec

名称	必选	允许NULL	类型	描述
Machine	是	否	String	规格机型示例值： ST-80
SpecConfigInfos	是	否	Array of SpecConfigInfo	规格列表示例值：查看

DatabaseTable

数据库表信息

被如下接口引用：DescribeDatabaseObjects

名称	必选	允许NULL	类型	描述
Table	是	否	String	表名示例值： user

ShardBriefInfo

实例分片信息

被如下接口引用：DescribeDCDBInstanceDetail

名称	必选	允许NULL	类型	描述
Cpu	是	否	Int64	分片Cpu核数示例值： 1
CreateTime	是	否	Datetime	分片创建时间示例值： 2021-02-08 10:25:08
LogDisk	是	否	Int64	分片日志磁盘空间大小，单位GB 示例值： 8
Memory	是	否	Int64	分片内存大小，单位GB 示例值： 2
NodeCount	是	否	Int64	分片节点个数示例值： 3
ProxyVersion	是	否	String	分片Proxy版本信息示例值： 1.14.63-M-V2R667D003
ShardInstanceId	是	否	String	分片ID，形如shard-7vg1o339 示例值： shard-lbt0utcz
ShardMasterZone	是	否	String	分片主DB可用区示例值： ap-region1-1
ShardSerialId	是	否	String	分片SerialId 示例值： set_1612751240_1
ShardSlaveZones	是	否	Array of String	分片从DB可用区示例值： ["ap-region1-1", "ap-region1-2"]
Status	是	否	Int64	分片运行状态示例值： 2
StatusDesc	是	否	String	分片运行状态描述示例值：运行中
Storage	是	否	Int64	分片磁盘大小，单位GB 示例值： 10
StorageUsage	是	否	Float	分片磁盘空间使用率示例值： 0.007
NodesInfo	是	是	Array of NodeInfo	DB节点信息示例值：查看

UserTaskInfo

用户任务信息

被如下接口引用：DescribeUserTasks

名称	必选	允许NULL	类型	描述
Id	是	否	Int64	任务ID 示例值： 699
AppId	是	否	Int64	用户账户ID 示例值： 1255000112
Status	是	否	Int64	任务状态，0-任务初始化中；1-任务运行中；2-任务成功；3-任务失败示例值： 2
UserTaskType	是	否	Int64	任务类型，0-实例回档；1-实例创建；2-实例扩容；3-实例迁移；4-实例删除；5-实例重启示例值： 6
CreateTime	是	否	Datetime	任务创建时间示例值： 2024-11-15 16:22:23
EndTime	是	否	Datetime	任务结束时间示例值： 2024-11-15 16:22:26
ErrMsg	是	否	String	任务错误信息示例值： “”
InputData	是	否	String	客户端参数示例值： ""
InstanceId	是	否	String	实例ID 示例值： tdsqlshard-mfktr7ji
InstanceName	是	否	String	实例名称示例值： tdsqlshard-mfktr7ji
RegionId	是	否	Int64	地域ID 示例值： 80000052

ShardZoneChooseInfo

分片节点可用区选择

被如下接口引用：DescribeDCDBSaleInfo

名称	必选	允许NULL	类型	描述
MasterZone	是	否	ZonesInfo	主可用区示例值：查看
SlaveZones	是	否	Array of ZonesInfo	可选的从可用区示例值：查看

SpecConfigInfo

实例可售卖规格详细信息，创建实例和扩容实例时 NodeCount、Memory 确定售卖规格，硬盘大小可用区间为[MinStorage,MaxStorage]

被如下接口引用：DescribeShardSpec

名称	必选	允许NULL	类型	描述
Cpu	是	否	Int64	CPU核数示例值： 1
MaxStorage	是	否	Int64	数据盘规格最大值，单位 GB 示例值： 1500
Memory	是	否	Int64	内存大小，单位 GB 示例值： 2
MinStorage	是	否	Int64	数据盘规格最小值，单位 GB 示例值： 10
NodeCount	是	否	Uint64	节点个数，2 表示一主一从，3 表示一主二从示例值： 1
Pid	是	否	Int64	产品类型 Id 示例值： 14319
Qps	是	否	Int64	最大 Qps 值示例值： 2100
SuitInfo	是	否	String	推荐的使用场景示例值：日独立用户数上百人的小型应用

ProxyConfigParam

网关配置参数

被如下接口引用：DescribeInstanceProxyConfig

名称	必选	允许NULL	类型	描述
Param	是	否	String	配置参数名称示例值： ssl_open
Value	是	否	String	配置参数值示例值： 1
Default	是	否	String	参数默认值示例值： 1
Description	是	否	String	参数描述示例值： The Meta Cluster Timeout
NeedRestart	是	否	Bool	是否需要重启生效示例值： true
Constraint	是	否	ProxyConstraint	参数限制示例值：查看

ExpandShardConfig

升级实例 -- 扩容分片类型

被如下接口引用：UpgradeHourDCDBInstance

名称	必选	允许NULL	类型	描述
ShardInstanceIds	是	否	Array of String	分片ID数组示例值： ["shard-xeedfgd"]
ShardMemory	是	否	Int64	分片内存大小，单位 GB 示例值： 2
ShardStorage	是	否	Int64	分片存储大小，单位 GB 示例值： 10
ShardCpu	否	否	Int64	分片cpu大小，单位：核，可以通过 DescribeShardSpec 查询实例规格获得。示例值： 1
ShardNodeCount	否	是	Int64	分片节点数示例值： 2

DatabaseView

数据库视图信息

被如下接口引用：DescribeDatabaseObjects

名称	必选	允许NULL	类型	描述
View	是	否	String	视图名称示例值： view_select

DcnDetailItem

DCN详情条目

被如下接口引用：DescribeDcnDetail

名称	必选	允许NULL	类型	描述
DcnFlag	是	否	Int64	实例DCN标志，1-主，2-备示例值： 0
DcnStatus	是	否	Int64	实例DCN状态，0-无，1-创建中，2-同步中，3-已断开示例值： 0
InstanceId	是	否	String	实例ID 示例值： tdsqlshard-cq3ndzu7
InstanceName	是	否	String	实例名称示例值： tdsqlshard-cq3ndzu7
Region	是	否	String	实例地域示例值： ap-region1
Status	是	否	Int64	实例状态：0 创建中，1 流程处理中， 2 运行中，3 实例未初始化，-1 实例已隔离，4 实例初始化中，5 实例删除中，6 实例重启中，7 数据迁移中。示例值： 2
StatusDesc	是	否	String	实例状态描述示例值：运行中
Vip	是	否	String	实例IP地址示例值： 10.0.0.2
Vipv6	是	否	String	实例IPv6地址示例值： FC00:0000:130F:0000:0000:09C0:876A:130B
Vport	是	否	Int64	实例端口示例值： 3306
Zone	是	否	String	实例可用区示例值： ap-region1-1
EncryptStatus	是	否	Int64	KMS开启状态，0-未开启，1-已开启示例值： 0
DcnStatusDesc	是	否	String	dcn状态描述：创建中，灾备同步，已断开，切换中，灾备强同步中示例值：创建中
CreateTime	是	否	String	创建时间示例值： 2024-11-13 18:10:22
ReplicaStatus	是	是	ReplicaStatus	备机的状态示例值：查看
PolarisService	是	否	String	北极星服务示例值： no
Storage	是	否	Int64	存储(GB) 示例值： 20
ReplicaConfig	是	是	ReplicaConfig	备机的配置信息示例值：查看
StorageUsage	是	否	String	存储空间使用率示例值： 0.1010000000
PolarisServiceStatusDesc	是	否	String	北极星服务中的状态描述信息：未开启，已开启，已隔离，切换中示例值：已开启
Memory	是	否	Int64	内存(MB) 示例值： 4
PeriodEndTime	是	否	String	到期时间示例值： 2024-11-13 18:10:22
PolarisInstanceId	是	否	String	北极星实例id 示例值： no
Cpu	是	否	Int64	cpu核数示例值： 2
InstanceType	是	否	Int64	实例类型：1 主实例（独享型）, 2 主实例, 3 灾备实例, 4 灾备实例（独享型）示例值： 3
PayMode	是	否	Int64	计费模式：0 按量计费，1 独享集群/包年包月示例值： 1
PolarisServiceStatus	是	否	Int64	北极星服务状态示例值： 0
IsDcnSwitchSupported	是	否	Int64	是否支持dcn切换：0 不支持，1 支持示例值： 1
PolarisInstanceName	是	否	String	北极星实例名示例值： no
PolarisNamespace	是	否	String	北极星命名空间示例值： no
PolarisRegion	是	否	String	北极星管控地域示例值： no

ProxyConstraint

proxy参数约束

被如下接口引用：DescribeInstanceProxyConfig

名称	必选	允许NULL	类型	描述
Type	是	否	String	约束类型,如枚举enum，区间section 示例值： section
Range	否	是	ConstraintRange	约束类型为section时的范围示例值：查看
Enum	否	否	String	约束类型为enum时的可选值列表示例值： ALL,OFF,FILTER

ZonesInfo

可用区信息

被如下接口引用：DescribeDCDBSaleInfo

名称	必选	允许NULL	类型	描述
Zone	是	否	String	可用区英文ID 示例值： ap-region1-1
ZoneId	是	否	Int64	可用区数字ID 示例值： 100001
ZoneName	是	否	String	可用区中文名示例值： region1一区
OnSale	是	否	Bool	是否在售示例值： false

DBParamValue

云数据库参数信息。

被如下接口引用：CreateHourDCDBInstance、InitDCDBInstances、ModifyDBParameters

名称	必选	允许NULL	类型	描述
Param	是	否	String	参数名称示例值： character_set_server
Value	是	否	String	参数值示例值： utf8mb4

DBEngineInfo

数据库引擎信息

被如下接口引用：DescribeDBEngines

名称	必选	允许NULL	类型	描述
Description	是	否	String	引擎描述示例值：完全兼容MySQL 8.0
Name	是	否	String	引擎名称，eg. 基于MariaDB 10.1.9 分支示例值： MySQL 8.0
Type	是	否	String	引擎类型，MariaDB
Version	是	否	String	引擎版本，eg. 10.1.9 示例值： 8.0

Rsip

拉取实例后端RS信息，返回IP和PORT结构体数组

被如下接口引用：DescribeDBInstanceRsip

名称	必选	允许NULL	类型	描述
Ip	是	否	String	Ip地址示例值： 10.0.0.1
Port	是	否	Int64	端口示例值： 2206

CommonDBInstance

通用数据库实例

被如下接口引用：DescribeCommonDBInstances

名称	必选	允许NULL	类型	描述
AppId	是	是	Int64	应用Id 示例值： 1255000112
CreateTime	是	是	String	实例创建时间示例值： 2019-12-12 07:15:00
InstanceId	是	是	String	实例ID 示例值： tdsqlshard-2iou4ejr
InstanceName	是	是	String	实例名称示例值： tdsqlshard-2iou4ejr
NetType	是	是	Int64	0-基础网络，1-VPC网络示例值： 1
PayMode	是	是	Int64	计费类型，1-包年包月，0-按量计费示例值： 0
ProjectId	是	是	Int64	项目Id 示例值： 1
Region	是	是	String	地域示例值： ap-region1
Status	是	是	String	实例状态信息，0-创建中,1-运行中，2-隔离中,下线后无法拉取实例信息示例值： 1
SubnetId	是	是	String	子网统一Id 示例值： subnet-l9bprnz2
Vips	是	是	Array of String	VPC网络IP 示例值： [10.0.0.1]
VpcId	是	是	String	VPC网络统一Id 示例值： vpc-1iy15ozp
Vport	是	是	Int64	VPC网络端口示例值： 3306
Zone	是	是	String	可用区示例值： ap-region1-1

InstanceShardInfo

TDSQL实例的分片信息

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
ShardInstanceId	是	否	String	分片ID 示例值： shard-c5lhigx2
ShardSerialId	是	否	String	分片的SerialId 示例值： set_1727254327_7
Status	是	否	Int64	分片的运行状态示例值： 2

DCDBInstanceInfo

分布式数据库实例信息

被如下接口引用：DescribeDCDBInstances

名称	必选	允许NULL	类型	描述
AppId	是	否	Int64	应用ID 示例值： 1255000355
AutoRenewFlag	是	否	Int64	自动续费标志示例值： 0
Cpu	是	否	Uint64	Cpu核数示例值： 1
CreateTime	是	否	Datetime	创建时间示例值： 2024-11-13 18:10:22
DbEngine	是	否	String	数据库引擎示例值： MySQL
DbVersion	是	否	String	数据库引擎版本示例值： 8.0
DcnDstNum	是	是	Int64	DCN灾备实例数示例值： 0
DcnFlag	是	是	Int64	DCN标志，0-无，1-主实例，2-灾备实例示例值： 0
DcnStatus	是	是	Int64	DCN状态，0-无，1-创建中，2-同步中，3-已断开示例值： 0
ExclusterId	是	否	String	独享集群ID，为空表示非独享集群实例示例值： Resource_pool1
Id	是	否	Uint64	数字实例ID（过时字段，请勿依赖该值）示例值： 312
InstanceId	是	否	String	实例ID 示例值： tdsqlshard-ef88yrr8
InstanceName	是	否	String	实例名称示例值： tdsqlshard-ef88yrr8
Ipv6Flag	是	是	Uint64	实例IPv6标志示例值： 0
IsAuditSupported	是	否	Uint64	该实例是否支持审计。1-支持；0-不支持示例值： 1
IsTmp	是	否	Int64	临时实例标记，0 为非临时实例，1为临时实例示例值： 0
IsolatedTimestamp	是	否	Datetime	隔离时间示例值： 2024-11-13 18:10:22
Locker	是	是	Int64	实例处于异步任务状态时，表示异步任务流程ID 示例值： 0
Memory	是	否	Int64	内存大小，单位 GB 示例值： 4
NodeCount	是	否	Int64	节点数，2 为一主一从， 3 为一主二从示例值： 2
Paymode	是	否	String	付费模式。prepaid-预付费；postpaid-按量计费示例值： postpaid
PeriodEndTime	是	否	Datetime	到期时间示例值： 0001-01-01 00:00:00
Pid	是	否	Int64	产品类型 ID（过时字段，请勿依赖该值）示例值： 14319
ProjectId	是	否	Int64	项目ID 示例值： 0
Region	是	否	String	地域示例值： ap-region-jcctest-ops
ShardCount	是	否	Int64	分片个数示例值： 2
ShardDetail	是	否	Array of ShardInfo	分片详情示例值：查看
Status	是	否	Int64	状态示例值： 2
StatusDesc	是	否	String	状态中文描述示例值：运行中
Storage	是	否	Int64	存储大小，单位 GB 示例值： 10
SubnetId	是	否	Int64	Subnet数字ID 示例值： 187
Uin	是	否	String	账号ID 示例值： 110000002385
UniqueSubnetId	是	否	String	字符串型的私有网络子网ID 示例值： subnet-l9bprnz2
UniqueVpcId	是	否	String	字符串型的私有网络ID 示例值： vpc-1iy15ozp
UpdateTime	是	否	Datetime	实例最后更新时间，格式为 2006-01-02 15:04:05 示例值： 2024-11-15 16:22:26
Vip	是	否	String	内网IP 示例值： 10.0.0.85
Vipv6	是	是	String	内网IPv6 示例值： FC00:0000:130F:0000:0000:09C0:876A:130B
VpcId	是	否	Int64	VPC数字ID 示例值： 67071
Vport	是	否	Int64	内网端口示例值： 3306
WanDomain	是	否	String	外网访问的域名，公网可解析示例值： ceshi.cn
WanPort	是	否	Int64	外网端口示例值： 8888
WanPortIpv6	是	是	Uint64	外网IPv6端口示例值： 8888
WanStatus	是	否	Int64	外网状态，0-未开通；1-已开通；2-关闭；3-开通中示例值： 1
WanStatusIpv6	是	是	Uint64	外网IPv6状态示例值： 1
WanVip	是	否	String	外网 IP 地址，公网可访问示例值： 192.168.1.1
WanVipv6	是	是	String	外网IPv6 示例值： FC00:0000:130F:0000:0000:09C0:876A:130B
Zone	是	否	String	可用区示例值： ap-region1-1
InstanceType	是	是	Int64	1：主实例（独享型）, 2: 主实例, 3：灾备实例, 4：灾备实例（独享型）示例值： 2
CpuArch	否	否	String	Cpu架构示例值： x86
ExclusterName	否	否	String	资源池名称示例值： Resource_pool1
AccountName	否	否	String	实例创建人账号名称示例值： johnnylli@test.com
AccountId	否	否	Int64	实例创建人账号ID（uin）示例值： 110000002385
StorageUsage	否	否	Float	实例存储空间使用率，计算方式为：各个分片已经使用的磁盘大小的和/各个分片的磁盘大小的和。示例值： 0.01

Inbound

安全组入站规则

被如下接口引用：DescribeDBSecurityGroups、DescribeProjectSecurityGroups

名称	必选	允许NULL	类型	描述
Action	是	否	String	策略，ACCEPT或者DROP。示例值： ACCEPT
AddressModule	是	否	String	地址组id代表的地址集合。示例值： “”
CidrIp	是	否	String	来源Ip或Ip段，例如192.168.0.0/16。示例值： 0.0.0.0/0
Desc	是	否	String	描述。示例值：测试规则
Id	是	否	String	安全组id代表的地址集合。示例值： “”
IpProtocol	是	否	String	网络协议，支持udp、tcp等。示例值： ALL
PortRange	是	否	String	端口。示例值： ALL
ServiceModule	是	否	String	服务组id代表的协议和端口集合。示例值： “”

TemplateParamConstraint

参数模板参数约束条件

被如下接口引用：DescribeConfigTemplate、DescribeDefaultConfigTemplate

名称	必选	允许NULL	类型	描述
Enum	是	否	String	约束枚举示例值： ALL,OFF,FILTER
Range	是	是	TemplateConstraintRange	约束范围示例值：查看
Str	是	否	String	约束字符串示例值： ANSI_QUOTES,IGNORE_SPACE,ONLY_FULL_GROUP_BY
Type	是	否	String	约束类型示例值： enum

ConfigValue

用户配置键值对

被如下接口引用：ModifyAccountConfig

名称	必选	允许NULL	类型	描述
Config	否	否	String	配置名示例值： max_user_connections
Value	否	否	String	配置值示例值： 1024

ParamConstraint

参数约束

被如下接口引用：DescribeDBParameters

名称	必选	允许NULL	类型	描述
Enum	是	否	String	约束类型为enum时的可选值列表示例值： ALL,OFF,FILTER
Range	是	是	ConstraintRange	约束类型为section时的范围示例值：查看
String	是	否	String	约束类型为string时的可选值列表示例值： REAL_AS_FLOAT,PIPES_AS_CONCAT
Type	是	否	String	约束类型,如枚举enum，区间section 示例值： enum

ColumnPrivilege

字段局权限

被如下接口引用：ModifyAccountPrivileges

名称	必选	允许NULL	类型	描述
Database	是	否	String	数据库示例值： userDB
Table	是	否	String	表名示例值： user
Column	是	否	String	列名示例值： name
Privileges	是	否	Array of String	权限集合示例值： [ "ALTER", "CREATE" ]

DatabaseFunction

数据库函数信息

被如下接口引用：DescribeDatabaseObjects

名称	必选	允许NULL	类型	描述
Func	是	否	String	函数名称示例值： CONCAT

ReplicaStatus

备机状态

被如下接口引用：DescribeDcnDetail

名称	必选	允许NULL	类型	描述
Status	是	否	String	RUNNING,REACHED_DUE_TIME,PAUSED 示例值： PAUSED
Delay	是	否	Int64	当前延迟情况示例值： 0

DCDBRollbackInstance

回档实例描述

被如下接口引用：DescribeDCDBRollbackInstances

名称	必选	允许NULL	类型	描述
InstanceId	否	否	String	实例ID 示例值： tdsqlshard-cq3ndzu7
InstanceName	否	否	String	实例名称示例值： tdsqlshard-cq3ndzu7
Status	否	否	Uint64	实例状态：0 创建中，1 流程处理中， 2 运行中，3 实例未初始化，-1 实例已隔离，4 实例初始化中，5 实例删除中，6 实例重启中，7 数据迁移中。示例值： 2
StatusDesc	否	否	String	状态中文描述。示例值：运行中
Region	否	否	String	实例所在地域。示例值： ap-region1
Zone	否	否	String	实例所在可用区。示例值： ap-region1-1
ProjectId	否	否	Uint64	项目ID 示例值： 0
NodeCount	否	否	Uint64	节点数，2 为一主一从， 3 为一主二从。示例值： 2
Cpu	否	否	Uint64	Cpu核数。示例值： 1
Memory	否	否	Uint64	内存大小，单位 GB。示例值： 4
Storage	否	否	Uint64	存储大小，单位 GB。示例值： 10
VpcId	否	否	String	字符串型的私有网络ID。示例值： vpc-1iy15ozp
SubnetId	否	否	String	字符串型的私有网络子网ID。示例值： subnet-l9bprnz2
Vip	否	否	String	内网IP。示例值： 10.88.0.9
Vport	否	否	Uint64	内网端口。示例值： 3306
Ipv6Flag	否	否	Uint64	实例IPv6标志。示例值： 1
Vipv6	否	否	String	内网IPv6。示例值： FC00:0000:130F:0000:0000:09C0:876A:130B
PayMode	否	否	String	付费模式。prepaid-预付费；postpaid-按量计费示例值： postpaid
RollbackTime	否	否	String	回档时间。示例值： 2024-11-13 18:10:22
PeriodEndTime	否	否	String	到期时间。示例值： 2024-11-13 18:10:22
CreateTime	否	否	String	实例创建时间。示例值： 2024-11-13 18:10:22
IsTmp	否	否	Uint64	1：非临时实例，0：临时实例。示例值： 0
ResourceTags	否	否	Array of ResourceTag	实例标签信息。示例值：查看
AccountName	否	否	String	实例创建人账号名称示例值： johnnylli@test.com
AccountId	否	否	Int64	实例创建人账号ID(uin) 示例值： 110000004633

AddShardConfig

升级实例 -- 新增分片类型

被如下接口引用：UpgradeHourDCDBInstance

名称	必选	允许NULL	类型	描述
ShardCount	是	否	Int64	新增分片的数量示例值： 1
ShardMemory	是	否	Int64	分片内存大小，单位 GB 示例值： 2
ShardStorage	是	否	Int64	分片存储大小，单位 GB 示例值： 10
ShardCpu	否	否	Int64	分片cpu大小，单位：核，可以通过 DescribeShardSpec 查询实例规格获得。示例值： 1

NodeInfo

描述DB节点信息

被如下接口引用：DescribeDCDBInstanceDetail

名称	必选	允许NULL	类型	描述
NodeId	是	否	String	DB节点ID 示例值： a8cc5889fb3d
Role	是	否	String	DB节点角色，取值为master或者slave 示例值： master

DBCharsetItem

DB字符集信息

被如下接口引用：DescribeDBCharsets

名称	必选	允许NULL	类型	描述
Version	否	否	String	DB版本号示例值： 5.7.17
DefaultCharset	否	否	String	DB默认字符集示例值： utf8
OptionalCharsets	否	否	String	DB可选字符集示例值： utf8,latin1,gbk,utf8mb4

MonitorShardInfo

分片信息

被如下接口引用：DescribeDCDBInstanceShardInfo

名称	必选	允许NULL	类型	描述
ShardId	是	否	String	分片ID 示例值： shard-rq87eg85

InstanceResource

数据库实例信息

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
AppId	是	否	Int64	账户的应用ID 示例值： 1255000355
ClusterName	是	否	String	实例所属集群的名字示例值：集群1
DbVersion	是	否	String	实例的数据库版本示例值： 8.0
Id	是	否	Int64	数据库实例的数字ID 示例值： 312
InstanceId	是	否	String	实例ID，形如 dcdbt-ifzc58fh或者tdsqlshard-ifzc58fh 示例值： tdsqlshard-ef88yrr8
InstanceName	是	否	String	实例名称示例值： tdsqlshard-ef88yrr8
NodeCount	是	否	Int64	实例的节点个数示例值： 2
OriginSerialId	是	否	String	实例的原始SerialId 示例值： group_1727253556_714339
Region	是	否	String	实例所在地域示例值： ap-region-jcctest-ops
SerialId	是	否	String	实例的当前SerialId 示例值： group_1727253556_714339
ShardDetail	是	否	Array of InstanceShardInfo	分片信息示例值：查看
Status	是	否	Int64	实例运行状态示例值： 2
SubnetId	是	否	Int64	实例所属子网的数字ID 示例值： 187
UniqueSubnetId	是	否	String	实例所属子网的字符串唯一ID 示例值： subnet-l9bprnz2
UniqueVpcId	是	否	String	实例所属VPC的字符串唯一ID 示例值： vpc-1iy15ozp
Vip	是	否	String	实例Vip 示例值： 10.0.0.85
VpcId	是	否	Int64	实例所属VPC的数字ID 示例值： 67071
Vport	是	否	Int64	实例Vport 示例值： 3306
ZkName	是	否	String	实例所属Zk的名字示例值： zk-online
Zone	是	否	String	实例所在可用区示例值： ap-region-jcctest-ops-2
MonitorType	是	否	Int64	表示实例监控页面如何展示示例值： 0

FenceInfoItem

独享资源池信息

被如下接口引用：DescribeAvailableExclusiveGroups

名称	必选	允许NULL	类型	描述
FenceId	是	否	String	独享资源池ID 示例值： Resource_pool1
FenceName	否	否	String	资源池名称示例值： Resource_pool1
Visibility	否	否	Int64	资源池是否所有人可见。0-所有人不可见；1-所有人可见示例值： 0

ShardInfo

分片信息

被如下接口引用：DescribeDCDBInstances

名称	必选	允许NULL	类型	描述
Cpu	是	否	Uint64	Cpu核数示例值： 1
Createtime	是	否	String	创建时间示例值： 2024-11-13 18:10:22
Memory	是	否	Int64	内存大小，单位 GB 示例值： 4
NodeCount	是	否	Int64	节点数，2 为一主一从， 3 为一主二从示例值： 2
Pid	是	否	Int64	产品类型 Id（过时字段，请勿依赖该值）示例值： 14319
ShardId	是	否	Int64	分片数字ID 示例值： 110
ShardInstanceId	是	否	String	分片ID 示例值： shard-12rumvwi
ShardSerialId	是	否	String	分片Set ID 示例值： set_1727254181_5
Status	是	否	Int64	状态：0 创建中，1 流程处理中， 2 运行中，3 分片未初始化，-2 分片已删除示例值： 2
Storage	是	否	Int64	存储大小，单位 GB 示例值： 10

InstanceBackupFileItem

实例备份文件详情

被如下接口引用：DescribeBackupFiles

名称	必选	允许NULL	类型	描述
InstanceId	否	否	String	实例ID 示例值： tdsqlshard-cq3ndzu7
InstanceName	否	否	String	实例名称示例值： tdsqlshard-cq3ndzu7
InstanceStatus	否	否	Int64	实例状态示例值： 2
ShardId	否	否	String	实例内的分片ID 示例值： shard-xeedfgd
FilePath	否	否	String	文件路径示例值： /backup/binlog+1731514873+20241114+002113+2007817982+binlog.000004.lz4
FileName	否	否	String	文件名称示例值： binlog+1731514873+20241114+002113+2007817982+binlog.000004.lz4
Url	否	否	String	文件下载链接示例值： /cos_backup%2ftdsql%2fgroup_1731482011_96057329%2fset_1731482512_5%2fbinlog%2f2024-11-14%2fbinlog%2b1731514873%2b20241114%2b002113%2b2007817982%2bbinlog.000004.lz4?sign=
FileSize	否	否	Int64	文件大小示例值： 1
BackupType	否	否	String	备份文件类型示例值： Binlog
ManualBackup	否	否	Int64	手动备份(仅用于冷备) 示例值： 0
StartTime	否	否	String	开始时间示例值： 2022-05-10 12:00:00
EndTime	否	否	String	结束时间示例值： 2022-05-10 12:00:00

LogFileInfo

拉取的日志信息

被如下接口引用：DescribeDBLogFiles

名称	必选	允许NULL	类型	描述
FileName	是	否	String	文件名示例值： cos_xtrabackup+1731600444+20241115+000724+2334360469+xbstream.lz4
Length	是	否	Uint64	文件长度示例值： 14000724
Mtime	是	否	Uint64	Log最后修改时间示例值： 1731600455
Uri	是	否	String	下载Log时用到的统一资源标识符示例值： /cos_backup%2ftdsql%2fset_1731557469_96057366%2fxtrabackup%2f2024-11-15%2fcos_xtrabackup%2b1731600444%2b20241115%2b000724%2b2334360469%2bxbstream.lz4?sign=

TemplateConstraintRange

参数模板中数值型参数的范围约束

被如下接口引用：DescribeConfigTemplate、DescribeDefaultConfigTemplate

名称	必选	允许NULL	类型	描述
Max	是	否	String	约束范围最大值示例值： 65535
Min	是	否	String	约束范围最小值示例值： 1

Account

用户信息

被如下接口引用：ModifyAccountPrivileges

名称	必选	允许NULL	类型	描述
User	是	否	String	用户名示例值： tdsqlsys_normal
Host	是	否	String	用户允许的访问 host，用户名+host唯一确定一个账号。示例值： %

DatabaseProcedure

数据库存储过程信息

被如下接口引用：DescribeDatabaseObjects

名称	必选	允许NULL	类型	描述
Proc	是	否	String	存储过程名称示例值： Proc

ParamDesc

DB参数描述

被如下接口引用：DescribeDBParameters

名称	必选	允许NULL	类型	描述
Constraint	是	否	ParamConstraint	参数限制示例值：查看
Default	是	否	String	系统默认值示例值： 1
HaveSetValue	是	否	Bool	是否有设置过值，false:没有设置过值，true:有设置过值。示例值： true
Param	是	否	String	参数名字示例值： long_query_time
SetValue	是	是	String	设置过的值，参数生效后，该值和value一样。未设置过就不返回该字段。示例值： 2
Value	是	否	String	当前参数值示例值： 1
IsTenantShow	是	否	Bool	租户端是否可见示例值： true
IsTenantEditable	是	否	Bool	租户端是否可修改示例值： true
NeedRestart	是	否	Bool	是否需要重启生效示例值： true

ConstraintRange

约束类型值的范围

被如下接口引用：DescribeDBParameters、DescribeInstanceProxyConfig

名称	必选	允许NULL	类型	描述
Max	是	否	String	约束类型为section时的最大值示例值： 1000
Min	是	否	String	约束类型为section时的最小值示例值： 10

ParamModifyResult

修改参数结果

被如下接口引用：ModifyDBParameters

名称	必选	允许NULL	类型	描述
Code	是	否	Int64	参数修改结果。0表示修改成功；-1表示修改失败；-2表示该参数值非法示例值： 0
Param	是	否	String	修改参数名字示例值： audit_txsql_audit_mode

SecurityGroup

安全组规则

被如下接口引用：DescribeDBSecurityGroups、DescribeProjectSecurityGroups

名称	必选	允许NULL	类型	描述
CreateTime	是	否	String	创建时间，时间格式：yyyy-mm-dd hh:mm:ss。示例值： 2024-09-18 16:57:03
Inbound	是	否	Array of Inbound	入站规则。示例值：查看
Outbound	是	否	Array of Outbound	出站规则。示例值：查看
ProjectId	是	否	Uint64	项目ID。示例值： 0
SecurityGroupId	是	否	String	安全组ID。示例值： sg-4fpjvk6n
SecurityGroupName	是	否	String	安全组名称。示例值： tdsql_safe_22
SecurityGroupRemark	是	否	String	安全组备注。示例值：测试安全组

TimeSlice

可用备份时间段

被如下接口引用：DescribeDCDBBinlogTime

名称	必选	允许NULL	类型	描述
StartTime	否	否	Datetime	开始时间示例值： 2019-01-01 10:00:00
EndTime	否	否	Datetime	结束时间示例值： 2019-01-01 12:00:00

DBAccount

云数据库账号信息

被如下接口引用：DescribeAccounts

名称	必选	允许NULL	类型	描述
CreateTime	是	否	Datetime	创建时间示例值： 2024-11-15 16:22:18
DelayThresh	是	否	Int64	如果备机延迟超过本参数设置值，系统将认为备机发生故障建议该参数值大于10。当ReadOnly选择1、2时该参数生效。示例值： 0
Description	是	否	String	用户备注信息示例值：测试账号
Host	是	否	String	用户可以从哪台主机登录（对应 MySQL 用户的 host 字段，UserName + Host 唯一标识一个用户，IP形式，IP段以%结尾；支持填入%；为空默认等于%）示例值： %
ReadOnly	是	否	Int64	只读标记，0：否， 1：该账号的sql请求优先选择备机执行，备机不可用时选择主机执行，2：优先选择备机执行，备机不可用时操作失败。示例值： 0
UpdateTime	是	否	Datetime	最后更新时间示例值： 2024-11-15 16:22:18
UserName	是	否	String	用户名示例值： tdsqlsys_normal
MaxUserConnections	是	否	Int64	最大用户连接数量示例值： 2
SlaveConst	是	否	Int64	备机数量示例值： 2

Outbound

安全组出站规则

被如下接口引用：DescribeDBSecurityGroups、DescribeProjectSecurityGroups

名称	必选	允许NULL	类型	描述
Action	是	否	String	策略，ACCEPT或者DROP。示例值： ACCEPT
AddressModule	是	否	String	地址组id代表的地址集合。示例值： “”
CidrIp	是	否	String	来源Ip或Ip段，例如192.168.0.0/16。示例值： 0.0.0.0/0
Desc	是	否	String	描述。示例值：测试规则
Id	是	否	String	安全组id代表的地址集合。示例值： “”
IpProtocol	是	否	String	网络协议，支持udp、tcp等。示例值： ALL
PortRange	是	否	String	端口。示例值： ALL
ServiceModule	是	否	String	服务组id代表的协议和端口集合。示例值： “”

RegionInfo

售卖可用区信息

被如下接口引用：DescribeDCDBSaleInfo

名称	必选	允许NULL	类型	描述
AvailableChoice	是	否	Array of ShardZoneChooseInfo	可选择的主可用区和从可用区示例值：查看
Region	是	否	String	地域英文ID 示例值： ap-region-jcctest-ops
RegionId	是	否	Int64	地域数字ID 示例值： 80000052
RegionName	是	否	String	地域中文名示例值：地域1
ZoneList	是	否	Array of ZonesInfo	可用区列表示例值：查看
OnSale	是	否	Bool	是否在售示例值： false

DCDBShardInfo

描述分布式数据库分片信息。

被如下接口引用：DescribeDCDBShards

名称	必选	允许NULL	类型	描述
Cpu	是	否	Int64	CPU核数示例值： 1
CreateTime	是	否	Datetime	创建时间示例值： 2024-11-13 18:10:22
InstanceId	是	否	String	所属实例Id 示例值： tdsqlshard-ef88yrr8
Memory	是	否	Int64	内存大小，单位 GB 示例值： 4
MemoryUsage	是	否	Float	内存使用率，单位为 % 示例值： 0.1
NodeCount	是	否	Int64	节点数，2 为一主一从， 3 为一主二从示例值： 2
Paymode	是	是	String	付费模式。prepaid-预付费；postpaid-按量计费示例值： postpaid
PeriodEndTime	是	否	Datetime	到期时间示例值： 2024-11-13 18:10:22
Pid	是	否	Int64	产品ProductID 示例值： 14319
ProjectId	是	否	Int64	项目ID 示例值： 0
ProxyVersion	是	否	String	Proxy版本示例值： "proxy-22.3.10"
Region	是	否	String	地域示例值： ap-region-jcctest-ops
ShardId	是	否	Int64	数字分片Id（过时字段，请勿依赖该值）示例值： 283
ShardInstanceId	是	否	String	全局唯一的分片Id 示例值： shard-29fdb0py
ShardMasterZone	是	是	String	分片的主可用区示例值： ap-region-jcctest-ops-1
ShardSerialId	是	否	String	分片SQL透传Id，用于将sql透传到指定分片执行示例值： set_1731656540_5
ShardSlaveZones	是	是	Array of String	分片的从可用区列表示例值： [ "ap-region-jcctest-ops-1" ]
Status	是	否	Int64	状态：0 创建中，1 流程处理中， 2 运行中，3 分片未初始化示例值： 2
StatusDesc	是	否	String	状态中文描述示例值：运行中
Storage	是	否	Int64	存储大小，单位 GB 示例值： 10
StorageUsage	是	否	Float	存储使用率，单位为 % 示例值： 0.01
SubnetId	是	否	String	字符串格式的私有网络子网Id 示例值： subnet-l9bprnz2
VpcId	是	否	String	字符串格式的私有网络Id 示例值： vpc-1iy15ozp
Zone	是	否	String	可用区示例值： ap-region-jcctest-ops-1
Range	是	否	String	分片ShardKey的范围（总共64个哈希值），例如： 0-31，32-63 示例值： 32-63
CpuArch	否	否	String	cpu架构示例值： x86

TableColumn

数据库列信息

被如下接口引用：DescribeDatabaseTable

名称	必选	允许NULL	类型	描述
Col	是	否	String	列名称示例值： user
Type	是	否	String	列类型示例值： string

DatabasePrivilege

数据库权限

被如下接口引用：ModifyAccountPrivileges

名称	必选	允许NULL	类型	描述
Database	是	否	String	数据库示例值： userDB
Privileges	是	否	Array of String	权限集合示例值： [SELECT,UPDATE]

ReservedNetResource

保留网络资源

被如下接口引用：DescribeDCDBInstanceDetail

名称	必选	允许NULL	类型	描述
VpcId	否	否	String	私有网络ID 示例值： vpc-1iy15ozp
SubnetId	否	否	String	子网ID 示例值： subnet-l9bprnz2
Vip	否	否	String	保留的私有网络ip 示例值： 10.107.76.25
Vports	否	否	Array of Int64	保留的端口号示例值： [3306,3307]
RecycleTime	否	否	String	回收时间示例值： 2023-02-23 10:36:17

ReplicaConfig

备机的配置信息

被如下接口引用：DescribeDcnDetail

名称	必选	允许NULL	类型	描述
RoReplicationMode	是	否	String	备机的数据复制模式:START(正常运行),STOP(暂停) 示例值： STOP
DelayReplicationType	是	否	String	延迟复制的类型:DEFAULT(正常的延迟复制)，DUE_TIME(指定时间复制) 示例值： DEFAULT
DueTime	是	否	String	延迟复制达到的目标时间点示例值： 2024-11-13 18:10:22
ReplicationDelay	是	否	Int64	延迟的时长示例值： 2

BriefNodeInfo

描述分片DB节点信息

被如下接口引用：DescribeDCDBInstanceNodeInfo

名称	必选	允许NULL	类型	描述
NodeId	是	否	String	DB节点ID 示例值： eba29f2bf561
Role	是	否	String	DB节点角色，取值为master或者slave 示例值： master
ShardId	是	否	String	节点所属分片的分片ID 示例值： shard-fkz0geb

Database

数据库信息

被如下接口引用：DescribeDatabases

名称	必选	允许NULL	类型	描述
DbName	是	否	String	数据库名称示例值： userDB

ConfigParam

配置模板参数

被如下接口引用：CreateConfigTemplate、ModifyConfigTemplate

名称	必选	允许NULL	类型	描述
Param	是	否	String	参数名示例值： audit_txsql_audit_mode
Value	是	否	String	参数值示例值： OFF

ResourceTag

标签对象，包含tagKey & tagValue

被如下接口引用：CreateHourDCDBInstance、DescribeDCDBInstanceDetail、DescribeDCDBRollbackInstances

名称	必选	允许NULL	类型	描述
TagKey	否	否	String	标签键key 示例值： label20
TagValue	否	否	String	标签值value 示例值： 20

ConfTemplate

参数模板

被如下接口引用：DescribeConfigTemplates

名称	必选	允许NULL	类型	描述
AppId	是	否	Int64	应用id 示例值： 1255000112
ConfigTemplateId	是	否	Int64	参数模板Id 示例值： 1
TemplateDefault	是	否	String	默认模板示例值： 8.0.24
TemplateDesc	是	否	String	参数模板描述示例值： 8.0_temple_dcdb
TemplateName	是	否	String	参数模板名称示例值： 8.0_temple_dcdb
DbVersionName	是	否	String	数据库版本示例值： MySQL 8.0

SlowLogData

慢查询条目信息

被如下接口引用：DescribeDBSlowLogs

名称	必选	允许NULL	类型	描述
CheckSum	是	否	String	语句校验和，用于查询详情示例值： 4177280352063002725
Db	是	否	String	数据库名称示例值： query_rewrite
ExampleSql	是	是	String	样例Sql 示例值： select sleep(10)； limit 10
FingerPrint	是	否	String	抽象的SQL语句示例值： select sleep(?)； limit ?
LockTimeAvg	是	否	String	平均的锁时间示例值： 0
LockTimeMax	是	否	String	最大锁时间示例值： 0
LockTimeMin	是	否	String	最小锁时间示例值： 0
LockTimeSum	是	否	String	锁时间总和示例值： 0
QueryCount	是	否	String	查询次数示例值： 1
QueryTimeAvg	是	否	String	平均查询时间示例值： 10
QueryTimeMax	是	否	String	最大查询时间示例值： 10
QueryTimeMin	是	否	String	最小查询时间示例值： 10
QueryTimeSum	是	否	String	查询时间总和示例值： 10
RowsExaminedSum	是	否	String	扫描行数示例值： 0
RowsSentSum	是	否	String	发送行数示例值： 1
TsMax	是	否	String	最后执行时间示例值： 2024-11-18 11:11:29
TsMin	是	否	String	首次执行时间示例值： 2024-11-18 11:11:29
User	是	否	String	帐号示例值： tdsqlsys_normal

DBBackupTimeConfig

云数据库实例备份时间配置信息

被如下接口引用：DescribeBackupTime

名称	必选	允许NULL	类型	描述
EndBackupTime	是	否	String	每天备份执行的区间的结束时间，格式 mm:ss，形如 23:00 示例值： 03:59
InstanceId	是	否	String	实例 ID 示例值： tdsqlshard-cq3ndzu7
StartBackupTime	是	否	String	每天备份执行的区间的开始时间，格式 mm:ss，形如 22:00 示例值： 03:00

SplitShardConfig

升级实例 -- 切分分片类型

被如下接口引用：UpgradeHourDCDBInstance

名称	必选	允许NULL	类型	描述
ShardInstanceIds	是	否	Array of String	分片ID数组示例值： ["shard-xeedfgd"]
ShardMemory	是	否	Int64	分片内存大小，单位 GB 示例值： 2
ShardStorage	是	否	Int64	分片存储大小，单位 GB 示例值： 10
SplitRate	是	否	Int64	数据切分比例示例值： 50
ShardCpu	否	否	Int64	分片cpu大小，单位：核，可以通过 DescribeShardSpec 查询实例规格获得。示例值： 1

NewRefineBackupConfig

新精细化备份参数

被如下接口引用：DescribeBackupConfigs、ModifyBackupConfigs

名称	必选	允许NULL	类型	描述
EnableBackupPolicy	是	否	Bool	是否开启备份策略示例值： true
BeginDate	是	否	String	备份开始时间。yy-MM-dd格式示例值： 2024-11-15
MaxRetentionDays	是	否	Int64	最大保存天数示例值： 90
Frequency	是	否	String	备份模式，支持：annually,monthly,weekly 示例值： weekly
WeekDays	否	是	Array of String	星期数组，支持：Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday 示例值： [ "Monday", "Tuesday" ]
BackupCount	否	是	Int64	备份数量，仅在Frequency为annually与monthly时生效。与WeekDays仅填一种。当mode为annually时，取值范围[1,336] 当mode为monthly时，取值范围[1,28] 示例值： 1