TDSQL MySQL版数据结构-API 中心-腾讯云

Account

数据库账号信息

被如下接口引用：ModifyAccountPrivileges。

名称	类型	必选	描述
User	String	是	账户的名称示例值：db_user
Host	String	是	账户的域名示例值：%

AddShardConfig

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

被如下接口引用：DescribeDCDBUpgradePrice, UpgradeDCDBInstance, UpgradeDedicatedDCDBInstance, UpgradeHourDCDBInstance。

名称	类型	必选	描述
ShardCount	Integer	是	新增分片的数量示例值：1
ShardMemory	Integer	是	分片内存大小，单位 GB 示例值：2
ShardStorage	Integer	是	分片存储大小，单位 GB 示例值：10

BackupConfig

数据库超期备份配置

被如下接口引用：DescribeBackupConfigs。

名称	类型	描述
EnableBackupPolicy	Boolean	备份策略是否启用。示例值：true
BeginDate	String	超期保留开始日期，早于开始日期的超期备份不保留，格式：yyyy-mm-dd。示例值：2023-05-30
MaxRetentionDays	Integer	超期备份保留时长，超出保留时间的超期备份将被删除，可填写1-3650整数。示例值：180
Frequency	String	备份模式，可选择按年月周模式保存 * 按年：annually * 按月：monthly * 按周：weekly 示例值：monthly
WeekDays	Array of String	Frequency等于weekly时生效。表示保留特定工作日备份。可选择周一到周日，支持多选，取星期英文： * 星期一：Monday * 星期二：Tuesday * 星期三：Wednesday * 星期四：Thursday * 星期五：Friday * 星期六：Saturday * 星期日：Sunday 示例值：Monday
BackupCount	Integer	保留备份个数，Frequency等于monthly或weekly时生效。备份模式选择按月时，可填写1-28整数；备份模式选择年时，可填写1-336整数。示例值：10

BriefNodeInfo

描述分片DB节点信息

被如下接口引用：DescribeDCDBInstanceNodeInfo。

名称	类型	描述
NodeId	String	DB节点ID 示例值：4ddc0ea18433
Role	String	DB节点角色，取值为master或者slave 示例值：master
ShardId	String	节点所属分片的分片ID 示例值：shard-ffj8mqzn

ColumnPrivilege

列权限信息

被如下接口引用：ModifyAccountPrivileges。

名称	类型	必选	描述
Database	String	是	数据库名示例值：pre_oss
Table	String	是	数据库表名示例值：work_flow
Column	String	是	数据库列名示例值：input
Privileges	Array of String	是	权限信息示例值：["SELECT", "ALTER","CREATE"]

ConfigValue

配置信息。包含配置项Config，配置值Value

被如下接口引用：ModifyAccountConfig。

名称	类型	必选	描述
Config	String	是	配置项的名称，支持填写max_user_connections 示例值：max_user_connections
Value	String	是	配置值示例值：1024

ConstraintRange

约束类型值的范围

被如下接口引用：DescribeDBParameters。

名称	类型	描述
Min	String	约束类型为section时的最小值示例值：1
Max	String	约束类型为section时的最大值示例值：65535

DBAccount

云数据库账号信息

被如下接口引用：DescribeAccounts。

名称	类型	描述
UserName	String	用户名示例值：oss_user
Host	String	用户可以从哪台主机登录（对应 MySQL 用户的 host 字段，UserName + Host 唯一标识一个用户，IP形式，IP段以%结尾；支持填入%；为空默认等于%）示例值：%
Description	String	用户备注信息示例值：oss测试账号
CreateTime	Timestamp	创建时间示例值：2024-11-19 15:04:00
UpdateTime	Timestamp	最后更新时间示例值：2024-11-19 15:05:00
ReadOnly	Integer	只读标记，0：否， 1：该账号的sql请求优先选择备机执行，备机不可用时选择主机执行，2：优先选择备机执行，备机不可用时操作失败。示例值：2
DelayThresh	Integer	如果备机延迟超过本参数设置值，系统将认为备机发生故障建议该参数值大于10。当ReadOnly选择1、2时该参数生效。示例值：100
SlaveConst	Integer	针对只读账号，设置策略是否固定备机，0：不固定备机，即备机不满足条件与客户端不断开连接，Proxy选择其他可用备机，1：备机不满足条件断开连接，确保一个连接固定备机。示例值：0
MaxUserConnections	Integer	用户最大连接数，0代表无限制示例值：1000

DBParamValue

云数据库参数信息。

被如下接口引用：CreateDCDBInstance, CreateDedicatedClusterDCDBInstance, CreateHourDCDBInstance, InitDCDBInstances, ModifyDBParameters。

名称	类型	必选	描述
Param	String	是	参数名称示例值：autocommit
Value	String	是	参数值示例值：ON

DCDBInstanceInfo

分布式数据库实例信息

被如下接口引用：DescribeDCDBInstances。

名称	类型	描述
InstanceId	String	实例ID 示例值：tdsqlshard-qs2bd7qb
InstanceName	String	实例名称示例值：billing_item
AppId	Integer	应用ID 示例值：1253044601
ProjectId	Integer	项目ID 示例值：10243
Region	String	地域示例值：ap-guangzhou
Zone	String	可用区示例值：ap-guangzhou-3
VpcId	Integer	VPC数字ID 示例值：8554331
SubnetId	Integer	Subnet数字ID 示例值：1024106
StatusDesc	String	状态中文描述示例值：运行中
Status	Integer	实例状态：0 创建中，1 流程处理中， 2 运行中，3 实例未初始化，-1 实例已隔离，4 实例初始化中，5 实例删除中，6 实例重启中，7 数据迁移中示例值：2
Vip	String	内网IP 示例值：10.2.4.19
Vport	Integer	内网端口示例值：3306
CreateTime	Timestamp	创建时间示例值：2024-11-07 14:53:53
AutoRenewFlag	Integer	自动续费标志示例值：1
Memory	Integer	内存大小，单位 GB 示例值：32
Storage	Integer	存储大小，单位 GB 示例值：500
ShardCount	Integer	分片个数示例值：4
PeriodEndTime	Timestamp	到期时间示例值：2024-12-07 14:53:53
IsolatedTimestamp	Timestamp	隔离时间示例值：0000-00-00 00:00:00
Uin	String	账号ID 示例值：3372036805
ShardDetail	Array of ShardInfo	分片详情示例值：[{"Cpu":1,"Createtime":"2024-11-07 14:53:53","Memory":2,"NodeCount":2,"Pid":1001670,"ShardId":12984,"ShardInstanceId":"shard-4cw33xnp","ShardSerialId":"set_1693557415_1","Status":2,"Storage":300},{"Cpu":1,"Createtime":"2024-11-07 14:53:53","Memory":2,"NodeCount":2,"Pid":1001670,"ShardId":12985,"ShardInstanceId":"shard-nw0u76x9","ShardSerialId":"set_1693557529_3","Status":2,"Storage":300},{"Cpu":1,"Createtime":"2024-11-07 14:53:53","Memory":2,"NodeCount":2,"Pid":1001670,"ShardId":12987,"ShardInstanceId":"shard-wsfe8s7e","ShardSerialId":"set_1693558023_5","Status":2,"Storage":300},{"Cpu":1,"Createtime":"2024-11-07 14:53:53","Memory":2,"NodeCount":2,"Pid":1001670,"ShardId":12988,"ShardInstanceId":"shard-jwud46a9","ShardSerialId":"set_1693558125_7","Status":2,"Storage":300}]
NodeCount	Integer	节点数，2 为一主一从， 3 为一主二从示例值：2
IsTmp	Integer	临时实例标记，0 为非临时实例示例值：0
ExclusterId	String	独享集群ID，为空表示非独享集群实例示例值：dbdc-qs2bd7qb
UniqueVpcId	String	字符串型的私有网络ID 示例值：subnet-qs2bd7qb
UniqueSubnetId	String	字符串型的私有网络子网ID 示例值：vpc-qs2bd7qb
Id	Integer	数字实例ID（过时字段，请勿依赖该值）示例值：14718
WanDomain	String	外网访问的域名，公网可解析示例值：gz.tdsqlshard-qs2bd7qb.sql.tencentcdb.com
WanVip	String	外网 IP 地址，公网可访问示例值：22.1.*
WanPort	Integer	外网端口示例值：24450
Pid	Integer	产品类型 ID（过时字段，请勿依赖该值）示例值：1001670
UpdateTime	Timestamp	实例最后更新时间，格式为 2006-01-02 15:04:05 示例值：2024-11-07 14:53:53
DbEngine	String	数据库引擎示例值：MySQL
DbVersion	String	数据库引擎版本示例值：8.0
Paymode	String	付费模式示例值：1
Locker	Integer	实例处于异步任务状态时，表示异步任务流程ID 注意：此字段可能返回 null，表示取不到有效值。示例值：0
WanStatus	Integer	外网状态，0-未开通；1-已开通；2-关闭；3-开通中示例值：2
IsAuditSupported	Integer	该实例是否支持审计。1-支持；0-不支持示例值：1
Cpu	Integer	Cpu核数示例值：4
Ipv6Flag	Integer	实例IPv6标志注意：此字段可能返回 null，表示取不到有效值。示例值：1
Vipv6	String	内网IPv6 注意：此字段可能返回 null，表示取不到有效值。示例值：240d:c000:f05f:b200:f200:b20f
WanVipv6	String	外网IPv6 注意：此字段可能返回 null，表示取不到有效值。示例值：140f:c010:*
WanPortIpv6	Integer	外网IPv6端口注意：此字段可能返回 null，表示取不到有效值。示例值：24450
WanStatusIpv6	Integer	外网IPv6状态注意：此字段可能返回 null，表示取不到有效值。示例值：1
DcnFlag	Integer	DCN标志，0-无，1-主实例，2-灾备实例注意：此字段可能返回 null，表示取不到有效值。示例值：1
DcnStatus	Integer	DCN状态，0-无，1-创建中，2-同步中，3-已断开注意：此字段可能返回 null，表示取不到有效值。示例值：2
DcnDstNum	Integer	DCN灾备实例数注意：此字段可能返回 null，表示取不到有效值。示例值：2
InstanceType	Integer	1：主实例（独享型）, 2: 主实例, 3：灾备实例, 4：灾备实例（独享型）注意：此字段可能返回 null，表示取不到有效值。示例值：2
ResourceTags	Array of ResourceTag	实例标签信息注意：此字段可能返回 null，表示取不到有效值。示例值：[{"TagKey":"qta_tdsql54","TagValue":"other54"},{"TagKey":"qta_tdsql50","TagValue":"other50"}]
DbVersionId	String	数据库引擎版本注意：此字段可能返回 null，表示取不到有效值。示例值：8.0

DCDBShardInfo

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

被如下接口引用：DescribeDCDBShards。

名称	类型	描述
InstanceId	String	所属实例Id 示例值：tdsqlshard-ffj8mqzn
ShardSerialId	String	分片SQL透传Id，用于将sql透传到指定分片执行示例值：set_1732083233_5
ShardInstanceId	String	全局唯一的分片Id 示例值：shard-fzqabc7d
Status	Integer	状态：0 创建中，1 流程处理中， 2 运行中，3 分片未初始化示例值：2
StatusDesc	String	状态中文描述示例值：运行中
CreateTime	Timestamp	创建时间示例值：2024-11-20 11:18:30
VpcId	String	字符串格式的私有网络Id 示例值：vpc-8tsjqux3
SubnetId	String	字符串格式的私有网络子网Id 示例值：subnet-7mbqdo2i
ProjectId	Integer	项目ID 示例值：10074
Region	String	地域示例值：ap-guangzhou
Zone	String	可用区示例值：ap-guangzhou-2
Memory	Integer	内存大小，单位 GB 示例值：4
Storage	Integer	存储大小，单位 GB 示例值：10
PeriodEndTime	Timestamp	到期时间示例值：0000-00-00 00:00:00
NodeCount	Integer	节点数，2 为一主一从， 3 为一主二从示例值：2
StorageUsage	Float	存储使用率，单位为 % 示例值：0.003
MemoryUsage	Float	内存使用率，单位为 % 示例值：0.128
ShardId	Integer	数字分片Id（过时字段，请勿依赖该值）示例值：40889
Pid	Integer	产品ProductID 示例值：1001670
ProxyVersion	String	Proxy版本示例值：proxy-22.4.2
Paymode	String	付费模型注意：此字段可能返回 null，表示取不到有效值。示例值：postpaid
ShardMasterZone	String	分片的主可用区注意：此字段可能返回 null，表示取不到有效值。示例值：ap-guangzhou-2
ShardSlaveZones	Array of String	分片的从可用区列表注意：此字段可能返回 null，表示取不到有效值。示例值：ap-guangzhou-2
Cpu	Integer	CPU核数示例值：2
Range	String	分片ShardKey的范围（总共64个哈希值），例如： 0-31，32-63 示例值：32-63

DDLDetail

DDL任务执行详情

被如下接口引用：DescribeOnlineDDLJob。

名称	类型	描述
ShardSerialId	String	分片Id 示例值：set_1729674200_1
DbName	String	数据库示例值：product_db
Table	String	表示例值：user_tbl
Alter	String	执行的DDL任务内容示例值：add column add_col_2 varchar(32);
BeginTime	String	开始执行时间示例值：2025-01-16 16:26:15 +0800 CST
Status	Integer	当前任务状态。0 成功； 1失败； 2进行中示例值：2
Desc	String	任务详细描述信息示例值：job is waiting to start
Stage	String	任务当前所处阶段示例值：wating_start
SwitchStatus	Integer	切换状态：1: 未到切换阶段；2：正在等待进行表切换；3: 正在进行切换；4: 切换成功；5: 切换失败示例值：1

Database

数据库信息

被如下接口引用：DescribeDatabases。

名称	类型	描述
DbName	String	数据库名称示例值：aIgo

DatabaseFunction

数据库函数信息

被如下接口引用：DescribeDatabaseObjects。

名称	类型	描述
Func	String	函数名称示例值：CountProc2

DatabasePrivilege

数据库权限

被如下接口引用：ModifyAccountPrivileges。

名称	类型	必选	描述
Privileges	Array of String	是	权限信息示例值：["ALTER", "INSERT", "CREATE", "SHOW VIEW"]
Database	String	是	数据库名示例值：pre_oss

DatabaseProcedure

数据库存储过程信息

被如下接口引用：DescribeDatabaseObjects。

名称	类型	描述
Proc	String	存储过程名称示例值：proc_tst

DatabaseTable

数据库表信息

被如下接口引用：DescribeDatabaseObjects。

名称	类型	描述
Table	String	表名示例值：t_preoss

DatabaseView

数据库视图信息

被如下接口引用：DescribeDatabaseObjects。

名称	类型	描述
View	String	视图名称示例值：v_bpmn

DcnDetailItem

DCN详情条目

被如下接口引用：DescribeDcnDetail。

名称	类型	描述
InstanceId	String	实例ID 示例值：tdsqlshard-jk8as7yt
InstanceName	String	实例名称示例值：jk8as7yt-dcn
Region	String	实例地域示例值：ap-guangzhou
Zone	String	实例可用区示例值：ap-guangzhou-3
Vip	String	实例IP地址示例值：10.4.3.12
Vipv6	String	实例IPv6地址示例值：240d:c000:f05f:b200:f200:b20f
Vport	Integer	实例端口示例值：3306
Status	Integer	实例状态示例值：2
StatusDesc	String	实例状态描述示例值：运行中
DcnFlag	Integer	实例DCN标志，1-主，2-备示例值：2
DcnStatus	Integer	实例DCN状态，0-无，1-创建中，2-同步中，3-已断开示例值：2
Cpu	Integer	实例CPU核数示例值：8
Memory	Integer	实例内存大小，单位 GB 示例值：64
Storage	Integer	实例存储大小，单位 GB 示例值：1000
PayMode	Integer	付费模式示例值：1
CreateTime	String	实例创建时间，格式为 2006-01-02 15:04:05 示例值：2024-11-19 15:44:03
PeriodEndTime	String	实例到期时间，格式为 2006-01-02 15:04:05 示例值：2024-12-19 15:44:03
InstanceType	Integer	1：主实例（独享型）, 2: 主实例, 3：灾备实例, 4：灾备实例（独享型）示例值：3
EncryptStatus	Integer	是否开启了 kms 示例值：0
DcnStatusDesc	String	实例DCN状态描述信息示例值：同步中
PolarisInstanceId	String	DCN实例绑定的北极星服务所属的北极星实例Id，若未绑定则为空示例值：ins-e4f68d96
PolarisInstanceName	String	DCN实例绑定的北极星服务所属的北极星实例名，若未绑定则为空示例值：ins-e4f68d96
PolarisNamespace	String	DCN实例绑定的北极星服务所属的北极星命名空间，若未绑定则为空示例值：default
PolarisService	String	DCN实例绑定的北极星服务，若未绑定则为空示例值：tdsql-pre-polaris
PolarisServiceStatus	Integer	DCN实例在北极星服务中的状态 0:未开启; 1:已开启; 2:已隔离; 3:切换中示例值：1
PolarisServiceStatusDesc	String	DCN实例在北极星服务中的状态的描述信息示例值：已开启
PolarisRegion	String	北极星管控地域示例值：ap-guangzhou
IsDcnSwitchSupported	Integer	是否支持DCN切换示例值：1

Deal

订单信息

被如下接口引用：DescribeOrders。

名称	类型	描述
DealName	String	订单号示例值：20221108006001219915661
OwnerUin	String	所属账号示例值：3078115006
Count	Integer	商品数量示例值：1
FlowId	Integer	关联的流程 Id，可用于查询流程执行状态示例值：68000008
InstanceIds	Array of String	只有创建实例且已完成发货的订单会填充该字段，表示该订单创建的实例的 ID 注意：此字段可能返回 null，表示取不到有效值。示例值：["tdsqlshard-c06stiq3"]
PayMode	Integer	付费模式，0后付费/1预付费示例值：0

ExpandShardConfig

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

被如下接口引用：DescribeDCDBUpgradePrice, UpgradeDCDBInstance, UpgradeDedicatedDCDBInstance, UpgradeHourDCDBInstance。

名称	类型	必选	描述
ShardInstanceIds	Array of String	是	分片ID数组示例值：["shard-xxxx"]
ShardMemory	Integer	是	分片内存大小，单位 GB 示例值：2
ShardStorage	Integer	是	分片存储大小，单位 GB 示例值：10
ShardNodeCount	Integer	否	分片节点数示例值：2

InstanceBackupFileItem

实例备份文件信息

被如下接口引用：DescribeBackupFiles。

名称	类型	描述
InstanceId	String	实例ID 示例值：tdsqlshard-xxx
InstanceName	String	实例名称示例值：tdsqlshard-xxx
InstanceStatus	Integer	实例状态示例值：2
ShardId	String	分片ID 示例值：shard-xxx
FilePath	String	文件路径示例值：/backup/xxx.lz4
FileName	String	文件名示例值：xxx.lz4
FileSize	Integer	文件大小示例值：1
BackupType	String	备份类型，Data:数据备份，Binlog:Binlog备份，Errlog:错误日志，Slowlog:慢日志示例值：Binlog
ManualBackup	Integer	手动备份，0:否，1:是示例值：0
StartTime	String	备份开始时间示例值：2022-05-10 12:00:00
EndTime	String	备份结束时间示例值：2022-05-10 12:00:00
StorageClass	String	对象的存储类型，枚举值：STANDARD（标准存储）、ARCHIVE（归档存储）。示例值：STANDARD

LogFileInfo

拉取的日志信息

被如下接口引用：DescribeDBLogFiles。

名称	类型	描述
Mtime	Integer	Log最后修改时间示例值：15054029
Length	Integer	文件长度示例值：1733814880
Uri	String	下载Log时用到的统一资源标识符示例值：cos_xtrabackup+1733814880+20241210+151440+471405052+xbstream.lz4
FileName	String	文件名示例值：/cos_backup%2Ftdsql%2Fset_1732784236_431669%2Fxtrabackup%2F2024-12-10%2Fcos_xtrabackup%2B1733814880%2B20241210%2B151440%2B471405052%2Bxbstream.lz4?q-sign-algorithm=sha1&q-ak=AKIDxxxx&q-sign-time=1733884388%3B1733885288&q-key-time=1733884388%3B1733885288&q-header-list=host&q-url-param-list=&q-signature=f978b91c6f7031d47fce45bb07b5164b7192b3d9

NewBackupConfig

数据库超期备份配置

被如下接口引用：ModifyBackupConfigs。

名称	类型	必选	描述
EnableBackupPolicy	Boolean	是	备份策略是否启用。示例值：true
BeginDate	String	是	超期保留开始日期，早于开始日期的超期备份不保留，格式：yyyy-mm-dd。示例值：2023-05-30
MaxRetentionDays	Integer	是	超期备份保留时长，超出保留时间的超期备份将被删除，可填写1-3650整数。示例值：180
Frequency	String	是	备份模式，可选择按年月周模式保存 * 按年：annually * 按月：monthly * 按周：weekly 示例值：monthly
WeekDays	Array of String	否	Frequency等于weekly时生效。表示保留特定工作日备份。可选择周一到周日，支持多选，取星期英文： * 星期一：Monday * 星期二：Tuesday * 星期三：Wednesday * 星期四：Thursday * 星期五：Friday * 星期六：Saturday * 星期日：Sunday 示例值：Monday
BackupCount	Integer	否	保留备份个数，Frequency等于monthly或weekly时生效。备份模式选择按月时，可填写1-28整数；备份模式选择年时，可填写1-336整数。示例值：10

NodeInfo

描述DB节点信息

被如下接口引用：DescribeDCDBInstanceDetail。

名称	类型	描述
NodeId	String	DB节点ID 示例值：4ddc0ea18433
Role	String	DB节点角色，取值为master或者slave 示例值：master

ParamConstraint

参数约束

被如下接口引用：DescribeDBParameters。

名称	类型	描述
Type	String	约束类型,如枚举enum，区间section 示例值：section
Enum	String	约束类型为enum时的可选值列表示例值：ALL,OFF,FILTER
Range	ConstraintRange	约束类型为section时的范围注意：此字段可能返回 null，表示取不到有效值。示例值：{"max":"65535","min":"1"}
String	String	约束类型为string时的可选值列表示例值：REAL_AS_FLOAT,PIPES_AS_CONCAT,ANSI_QUOTES,IGNORE_SPACE,IGNORE_BAD_TABLE_OPTIONS,ONLY_FULL_GROUP_BY,NO_UNSIGNED_SUBTRACTION,NO_DIR_IN_CREATE,NO_KEY_OPTIONS,NO_TABLE_OPTIONS,NO_FIELD_OPTIONS,NO_AUTO_VALUE_ON_ZERO,NO_BACKSLASH_ESCAPES,STRICT_TRANS_TABLES,STRICT_ALL_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ALLOW_INVALID_DATES,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,HIGH_NOT_PRECEDENCE,NO_ENGINE_SUBSTITUTION,PAD_CHAR_TO_FULL_LENGTH

ParamDesc

DB参数描述

被如下接口引用：DescribeDBParameters。

名称	类型	描述
Param	String	参数名字示例值：long_query_time
Value	String	当前参数值示例值：1
SetValue	String	设置过的值，参数生效后，该值和value一样。未设置过就不返回该字段。注意：此字段可能返回 null，表示取不到有效值。示例值：2
Default	String	系统默认值示例值：1
Constraint	ParamConstraint	参数限制示例值：{"Enum":"","Range":{"Max":"10","Min":"0.05"},"String":"","Type":"section"}
HaveSetValue	Boolean	是否有设置过值，false:没有设置过值，true:有设置过值。示例值：true
NeedRestart	Boolean	是否需要重启生效，false:不需要重启， true:需要重启示例值：false

ParamModifyResult

修改参数结果

被如下接口引用：ModifyDBParameters。

名称	类型	描述
Param	String	修改参数名字示例值：autocommit
Code	Integer	参数修改结果。0表示修改成功；-1表示修改失败；-2表示该参数值非法示例值：0

Project

项目信息描述

被如下接口引用：DescribeProjects。

名称	类型	描述
ProjectId	Integer	项目ID 示例值：1035094
OwnerUin	Integer	资源拥有者（主账号）uin 示例值：70012255787
AppId	Integer	应用Id 示例值：1280075989
Name	String	项目名称示例值：tdsql测试
CreatorUin	Integer	创建者uin 示例值：70012255787
SrcPlat	String	来源平台示例值：qcloud
SrcAppId	Integer	来源AppId 示例值：1280075989
Status	Integer	项目状态,0正常，-1关闭。默认项目为3 示例值：0
CreateTime	Timestamp	创建时间示例值：2024-10-11 10:11:12
IsDefault	Integer	是否默认项目，1 是，0 不是示例值：0
Info	String	描述信息示例值：tdsql测试项目

RegionInfo

售卖可用区信息

被如下接口引用：DescribeDCDBSaleInfo。

名称	类型	描述
Region	String	地域英文ID 示例值：ap-guangzhou
RegionId	Integer	地域数字ID 示例值：1
RegionName	String	地域中文名示例值：广州
ZoneList	Array of ZonesInfo	可用区列表示例值：[{"Zone":"ap-guangzhou-1","ZoneId":100001,"ZoneName":"广州一区","OnSale":true},{"Zone":"ap-guangzhou-2","ZoneId":100002,"ZoneName":"广州二区","OnSale":true}]
AvailableChoice	Array of ShardZoneChooseInfo	可选择的主可用区和从可用区示例值：[{ "MasterZone":{ "Zone":"ap-guangzhou-1", "ZoneId":100001, "ZoneName":"广州一区", "OnSale":true }, "SlaveZones":[{ "Zone":"ap-guangzhou-1", "ZoneId":100001, "ZoneName":"广州一区", "OnSale":true }, { "Zone":"ap-guangzhou-2", "ZoneId":100002, "ZoneName":"广州二区", "OnSale":true }] }, { "MasterZone":{ "Zone":"ap-guangzhou-2", "ZoneId":100002, "ZoneName":"广州二区", "OnSale":true }, "SlaveZones":[{ "Zone":"ap-guangzhou-1", "ZoneId":100001, "ZoneName":"广州一区", "OnSale":true }, { "Zone":"ap-guangzhou-2", "ZoneId":100002, "ZoneName":"广州二区", "OnSale":true }] }]

ReservedNetResource

保留的网络资源信息

被如下接口引用：DescribeDCDBInstanceDetail。

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

ResourceTag

标签对象，包含tagKey & tagValue

被如下接口引用：CreateDCDBInstance, CreateDedicatedClusterDCDBInstance, CreateHourDCDBInstance, DescribeDCDBInstanceDetail, DescribeDCDBInstances。

名称	类型	必选	描述
TagKey	String	是	标签键key 示例值：qta-tdsql20
TagValue	String	是	标签值value 示例值：tdsql50

SecurityGroup

安全组详情

被如下接口引用：DescribeDBSecurityGroups, DescribeProjectSecurityGroups。

名称	类型	描述
ProjectId	Integer	项目ID 示例值：10068
CreateTime	String	创建时间，时间格式：yyyy-mm-dd hh:mm:ss 示例值：2024-11-13 20:20:05
SecurityGroupId	String	安全组ID 示例值：sg-iry0kj68
SecurityGroupName	String	安全组名称示例值：TDSQL-for-tst
SecurityGroupRemark	String	安全组备注示例值：自定义
Inbound	Array of SecurityGroupBound	入站规则示例值：[ { "Action": "ACCEPT", "AddressModule": "", "CidrIp": "211.139.*", "Desc": "", "Id": "", "IpProtocol": "tcp", "PortRange": "80,443", "ServiceModule": "" }, { "Action": "ACCEPT", "AddressModule": "ipm-b0cywwyy", "CidrIp": "", "Desc": "成都出口IP", "Id": "", "IpProtocol": "tcp", "PortRange": "80,443", "ServiceModule": "" } ]
Outbound	Array of SecurityGroupBound	出站规则示例值：[ { "Action": "ACCEPT", "AddressModule": "", "CidrIp": "0.0.0.0/0", "Desc": "", "Id": "", "IpProtocol": "ALL", "PortRange": "ALL", "ServiceModule": "" }, { "Action": "ACCEPT", "AddressModule": "", "CidrIp": "", "Desc": "", "Id": "", "IpProtocol": "ALL", "PortRange": "ALL", "ServiceModule": "" } ]

SecurityGroupBound

安全出入口规则

被如下接口引用：DescribeDBSecurityGroups, DescribeProjectSecurityGroups。

名称	类型	描述
CidrIp	String	来源 IP 或 IP 段，例如192.168.0.0/16 示例值：111.206.0.0/16
Action	String	策略，ACCEPT 或者 DROP 示例值：ACCEPT
PortRange	String	端口示例值：36000,80,22,8081,8080,32000,30089,53000,30080
IpProtocol	String	网络协议，支持 UDP、TCP 等示例值：tcp

ShardBriefInfo

DCDB分片信息

被如下接口引用：DescribeDCDBInstanceDetail。

名称	类型	描述
ShardSerialId	String	分片SerialId 示例值：set_1612751240_1
ShardInstanceId	String	分片ID，形如shard-7vg1o339 示例值：shard-lbt0utcz
Status	Integer	分片运行状态示例值：2
StatusDesc	String	分片运行状态描述示例值：运行中
CreateTime	Timestamp	分片创建时间示例值：2021-02-08 10:25:08
Memory	Integer	分片内存大小，单位GB 示例值：2
Storage	Integer	分片磁盘大小，单位GB 示例值：10
LogDisk	Integer	分片日志磁盘空间大小，单位GB 示例值：8
NodeCount	Integer	分片节点个数示例值：3
StorageUsage	Float	分片磁盘空间使用率示例值：0.007
ProxyVersion	String	分片Proxy版本信息示例值：1.14.63-M-V2R667D003
ShardMasterZone	String	分片主DB可用区示例值：ap-guangzhou-1
ShardSlaveZones	Array of String	分片从DB可用区示例值：["ap-guangzhou-1", "ap-guangzhou-2"]
Cpu	Integer	分片Cpu核数示例值：1
NodesInfo	Array of NodeInfo	DB节点信息注意：此字段可能返回 null，表示取不到有效值。示例值：[{"NodeId": "4ddc0ea18433", "Role": "master"}, { "NodeId": "5d51cf1f018c","Role": "slave" }]

ShardInfo

分片信息

被如下接口引用：DescribeDCDBInstances。

名称	类型	描述
ShardInstanceId	String	分片ID 示例值：shard-1xb2mmed
ShardSerialId	String	分片Set ID 示例值：set_1734060861_3
Status	Integer	状态：0 创建中，1 流程处理中， 2 运行中，3 分片未初始化，-2 分片已删除示例值：2
Createtime	String	创建时间示例值：2024-12-13 11:31:10
Memory	Integer	内存大小，单位 GB 示例值：2
Storage	Integer	存储大小，单位 GB 示例值：20
ShardId	Integer	分片数字ID 示例值：17732
NodeCount	Integer	节点数，2 为一主一从， 3 为一主二从示例值：2
Pid	Integer	产品类型 Id（过时字段，请勿依赖该值）示例值：1001670
Cpu	Integer	Cpu核数示例值：1

ShardZoneChooseInfo

分片节点可用区选择

被如下接口引用：DescribeDCDBSaleInfo。

名称	类型	描述
MasterZone	ZonesInfo	主可用区示例值：{ "Zone":"ap-guangzhou-1", "ZoneId":100001, "ZoneName":"广州一区", "OnSale":true }
SlaveZones	Array of ZonesInfo	可选的从可用区示例值：[{ "Zone":"ap-guangzhou-1", "ZoneId":100001, "ZoneName":"广州一区", "OnSale":true }, { "Zone":"ap-guangzhou-2", "ZoneId":100002, "ZoneName":"广州二区", "OnSale":true }]

SlowLogData

慢查询条目信息

被如下接口引用：DescribeDBSlowLogs。

名称	类型	描述
CheckSum	String	语句校验和，用于查询详情示例值：166258302
Db	String	数据库名称示例值：pre_oss
FingerPrint	String	抽象的SQL语句示例值：select id, f?, sleep(?) from t? where id % ? = ?
LockTimeAvg	String	平均的锁时间示例值：0.000101
LockTimeMax	String	最大锁时间示例值：0.000101
LockTimeMin	String	最小锁时间示例值：0.000101
LockTimeSum	String	锁时间总和示例值：0.000101
QueryCount	String	查询次数示例值：1
QueryTimeAvg	String	平均查询时间示例值：2.00033
QueryTimeMax	String	最大查询时间示例值：2.00033
QueryTimeMin	String	最小查询时间示例值：2.00033
QueryTimeSum	String	查询时间总和示例值：2.00033
RowsExaminedSum	String	扫描行数示例值：4
RowsSentSum	String	发送行数示例值：2
TsMax	String	最后执行时间示例值：2022-03-09 19:37:35
TsMin	String	首次执行时间示例值：2022-03-09 19:37:35
User	String	账号示例值：user_00
ExampleSql	String	样例Sql 注意：此字段可能返回 null，表示取不到有效值。示例值：select id, f1, sleep(1) from t1 where id % 2 = 1
Host	String	账户的域名注意：此字段可能返回 null，表示取不到有效值。示例值：%

SpecConfig

按机型分类的规格配置

被如下接口引用：DescribeShardSpec。

名称	类型	描述
Machine	String	规格机型示例值：SH12
SpecConfigInfos	Array of SpecConfigInfo	规格列表示例值：[{"Cpu":1,"MaxStorage":3000,"Memory":2,"MinStorage":10,"NodeCount":3,"Pid":1001670,"Qps":2100,"SuitInfo":"日独立用户数上百人的小型应用"},{"Cpu":1,"MaxStorage":3000,"Memory":2,"MinStorage":10,"NodeCount":4,"Pid":1001670,"Qps":2100,"SuitInfo":"日独立用户数上百人的小型应用"}]

SpecConfigInfo

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

被如下接口引用：DescribeShardSpec。

名称	类型	描述
NodeCount	Integer	节点个数，2 表示一主一从，3 表示一主二从示例值：1
Memory	Integer	内存大小，单位 GB 示例值：8
MinStorage	Integer	数据盘规格最小值，单位 GB 示例值：10
MaxStorage	Integer	数据盘规格最大值，单位 GB 示例值：3000
SuitInfo	String	推荐的使用场景示例值：日独立用户数上千人的小型应用
Pid	Integer	产品类型 Id 示例值：1001670
Qps	Integer	最大 Qps 值示例值：6500
Cpu	Integer	CPU核数示例值：4

SplitShardConfig

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

被如下接口引用：DescribeDCDBUpgradePrice, UpgradeDCDBInstance, UpgradeDedicatedDCDBInstance, UpgradeHourDCDBInstance。

名称	类型	必选	描述
ShardInstanceIds	Array of String	是	分片ID数组示例值：["shard-xxxx"]
SplitRate	Integer	是	数据切分比例，固定50% 示例值：50
ShardMemory	Integer	是	分片内存大小，单位 GB 示例值：2
ShardStorage	Integer	是	分片存储大小，单位 GB 示例值：10

TableColumn

数据库列信息

被如下接口引用：DescribeDatabaseTable。

名称	类型	描述
Col	String	列名称示例值：name
Type	String	列类型示例值：varchar(256)

TablePrivilege

数据库表权限

被如下接口引用：ModifyAccountPrivileges。

名称	类型	必选	描述
Database	String	是	数据库名示例值：pre_oss
Table	String	是	数据库表名示例值：work_flow
Privileges	Array of String	是	权限信息示例值：['SELECT']

Tag

标签

被如下接口引用：DescribeDCDBInstances。

名称	类型	必选	描述
TagKey	String	否	标签键示例值：name
TagValue	String	否	标签值示例值：liu

TmpInstance

临时实例

被如下接口引用：DescribeDBTmpInstances。

名称	类型	描述
AppId	Integer	应用ID 注意：此字段可能返回 null，表示取不到有效值。示例值：128007987
CreateTime	Timestamp	创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：2024-10-11 10:00:11
InstanceRemark	String	实例备注注意：此字段可能返回 null，表示取不到有效值。示例值：tdsqlshard-fortdsql-tst
TempType	Integer	0:非临时实例 ,1:无效临时实例, 2:回档成功的有效临时实例注意：此字段可能返回 null，表示取不到有效值。示例值：0
Status	Integer	实例状态,0:待初始化,1:流程处理中,2:有效状态,-1:已隔离，-2：已下线注意：此字段可能返回 null，表示取不到有效值。示例值：2
InstanceId	String	实例 ID，形如：tdsql-ow728lmc。注意：此字段可能返回 null，表示取不到有效值。示例值：tdsqlshard-fortdsql
Vip	String	实例虚IP 注意：此字段可能返回 null，表示取不到有效值。示例值：10.1.0.1
Vport	Integer	实例虚端口注意：此字段可能返回 null，表示取不到有效值。示例值：3306
PeriodEndTime	Timestamp	有效期结束时间注意：此字段可能返回 null，表示取不到有效值。示例值：2024-12-11 10:00:11
SrcInstanceId	String	源实例 ID，形如：tdsql-ow728lmc。注意：此字段可能返回 null，表示取不到有效值。示例值：tdsql-srctdsql
StatusDesc	String	实例状态描述注意：此字段可能返回 null，表示取不到有效值。示例值：2
Region	String	实例所在地域注意：此字段可能返回 null，表示取不到有效值。示例值：ap-guangzhou
Zone	String	实例所在可用区注意：此字段可能返回 null，表示取不到有效值。示例值：ap-guangzhou-3
Vipv6	String	实例虚IPv6 注意：此字段可能返回 null，表示取不到有效值。示例值：2402:4e00:*
Ipv6Flag	Integer	实例IPv6标志注意：此字段可能返回 null，表示取不到有效值。示例值：1

UserTaskInfo

用户任务信息

被如下接口引用：DescribeUserTasks。

名称	类型	描述
Id	Integer	任务ID 示例值：15985
AppId	Integer	用户账户ID 示例值：1282064859
Status	Integer	任务状态，0-任务初始化中；1-任务运行中；2-任务成功；3-任务失败示例值：2
UserTaskType	Integer	任务类型，0-实例回档；1-实例创建；2-实例扩容；3-实例迁移；4-实例删除；5-实例重启示例值：6
CreateTime	Timestamp	任务创建时间示例值：2024-11-08 16:02:53
EndTime	Timestamp	任务结束时间示例值：2024-11-08 16:02:55
ErrMsg	String	任务错误信息示例值：instance status not ok
InputData	String	客户端参数示例值：{"AppId":1251966477,"UserType":1,"Uin":"3374998458","Operator":"3374998458","Ids":[12989],"RetreatedTime":"2019-04-26 14:40:47"}
InstanceId	String	实例ID 示例值：tdsqlshard-ow728lmc
InstanceName	String	实例名称示例值：tdsqlshard-ow728lmc-tst
RegionId	Integer	地域ID 示例值：1

ViewPrivileges

视图权限信息

被如下接口引用：ModifyAccountPrivileges。

名称	类型	必选	描述
Database	String	是	数据库名示例值：pre_oss
View	String	是	数据库视图名示例值：work_view
Privileges	Array of String	是	权限信息示例值：["SELECT"]

ZonesInfo

可用区信息

被如下接口引用：DescribeDCDBSaleInfo。

名称	类型	描述
Zone	String	可用区英文ID 示例值：ap-guangzhou-1
ZoneId	Integer	可用区数字ID 示例值：100001
ZoneName	String	可用区中文名示例值：广州一区
OnSale	Boolean	是否在售示例值：true

数据结构

本页目录：

Account

AddShardConfig

BackupConfig

BriefNodeInfo

ColumnPrivilege

ConfigValue

ConstraintRange

DBAccount

DBParamValue

DCDBInstanceInfo

DCDBShardInfo

DDLDetail

Database

DatabaseFunction

DatabasePrivilege

DatabaseProcedure

DatabaseTable

DatabaseView

DcnDetailItem

Deal

ExpandShardConfig

InstanceBackupFileItem

LogFileInfo

NewBackupConfig

NodeInfo

ParamConstraint

ParamDesc

ParamModifyResult

Project

RegionInfo

ReservedNetResource

ResourceTag

SecurityGroup

SecurityGroupBound

ShardBriefInfo

ShardInfo

ShardZoneChooseInfo

SlowLogData

SpecConfig

SpecConfigInfo

SplitShardConfig

TableColumn

TablePrivilege

Tag

TmpInstance

UserTaskInfo

ViewPrivileges

ZonesInfo