数据结构

最近更新时间:2026-05-22 02:46:42

我的收藏

AnalysisInstanceInfo

分析引擎实例信息

被如下接口引用:DescribeDBInstanceDetail。

名称 类型 描述
ReplicasNum Integer

副本数


示例值:0

AnalysisRelationInfo

分析引擎关联关系

被如下接口引用:DescribeDBInstanceDetail, DescribeDBInstances。

名称 类型 描述
PrimaryInstanceId String

源实例Id


示例值:tdsql-12345678
AnalysisInstanceId String

分析引擎实例Id


示例值:tdsql-87654321
Status String

分析引擎关系状态

枚举值:

  • creating: 创建中
  • running: 运行中
  • destroyed: 已销毁

示例值:running
CreateAt String

创建时间


示例值:2026-01-15 10:30:00
UpdateAt String

更新时间


示例值:2026-05-06 12:00:00

ArchiveLogInterval

可恢复时间区间

被如下接口引用:DescribeDBSAvailableRecoveryTime。

名称 类型 必选 描述
EndTime String 结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2024-05-18 00:00:57
MajorVersion String 大版本
注意:此字段可能返回 null,表示取不到有效值。
MinorVersion String 小版本
注意:此字段可能返回 null,表示取不到有效值。
StartTime String 开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2024-05-18 00:00:57

ArchiveLogModel

归档日志对象

被如下接口引用:DescribeDBSArchiveLogs。

名称 类型 必选 描述
ArchiveLogId Integer 归档日志ID
注意:此字段可能返回 null,表示取不到有效值。
BackupDuration Integer 备份耗时
注意:此字段可能返回 null,表示取不到有效值。
BackupStatus String 备份集状态
注意:此字段可能返回 null,表示取不到有效值。
EndTime String 备份结束时间
注意:此字段可能返回 null,表示取不到有效值。
ErrorMessage String 错误信息
注意:此字段可能返回 null,表示取不到有效值。
ExpiredTime String 过期时间
注意:此字段可能返回 null,表示取不到有效值。
FileName String 备份文件名
注意:此字段可能返回 null,表示取不到有效值。
FileSize Integer 备份集文件大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。
InstanceId String 实例ID
注意:此字段可能返回 null,表示取不到有效值。
StartTime String 备份开始时间
注意:此字段可能返回 null,表示取不到有效值。

AutoScalingConfig

serverless实例的ccu范围

被如下接口引用:CreateDBInstances, DescribeDBInstanceDetail, DescribeDBInstances。

名称 类型 必选 描述
RangeMin Float

ccu最小值


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RangeMax Float

ccu最大值


注意:此字段可能返回 null,表示取不到有效值。
示例值:16

BackupMethodStatisticsModel

备份方式统计对象-提供给备份空间统计接口

被如下接口引用:DescribeDBSBackupStatistics。

名称 类型 描述
AutoBackupSize Integer

自动备份大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:37748736
AverageSizePerDay Integer

总备份每天平均大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:18874368
ManualBackupSize Integer

手动备份大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:0
TotalSize Integer

总备份大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:37748736

BackupMethodStatisticsOutPut

备份方式统计对象,提供给 备份集统计详情 接口

被如下接口引用:DescribeDBSBackupStatisticsDetail。

名称 类型 描述
AutoBackupSize Array of Integer

自动备份大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:[9437184]
ManualBackupSize Array of Integer

手动备份大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:[0]

BackupPolicyModelInput

修改备份策略对象

被如下接口引用:ModifyDBSBackupPolicy。

名称 类型 必选 描述
BackupEndTime String

备份结束时间


示例值:04:00
BackupMethod String

备份方式 physical 物理备份 snapshot 快照备份


示例值:physical
BackupStartTime String

备份开始时间


示例值:00:00
EnableFull Integer

是否开启全量备份


示例值:1
EnableLog Integer

是否开启日志备份


示例值:1
FullRetentionPeriod Integer

全备保留时间,目前只能设置7天


示例值:7
InstanceId String

实例ID


示例值:tdsql3-b8dfc518
LogRetentionPeriod Integer

日志保留天数,目前只能设置保留7天


示例值:7
PeriodTime String

一周的哪几天进行备份


示例值:0,1,2,3,4,5,6
StorageType String

存储类型:COS,SNAPSHOT

枚举值:
  • COS: COS存储
  • SNAPSHOT: 云盘快照

示例值:COS

BackupPolicyModelOutPut

备份策略对象

被如下接口引用:DescribeDBSBackupPolicy。

名称 类型 描述
BackupEndTime String

备份结束时间


注意:此字段可能返回 null,表示取不到有效值。
示例值:04:00
BackupMethod String

备份方式


注意:此字段可能返回 null,表示取不到有效值。
示例值:physical
BackupStartTime String

备份开始时间


注意:此字段可能返回 null,表示取不到有效值。
示例值:00:00
DBType String

引擎类型


注意:此字段可能返回 null,表示取不到有效值。
示例值:tdstore
DBVersion String

引擎版本


注意:此字段可能返回 null,表示取不到有效值。
示例值:21.6.1
EnableFull Integer

是否开启全量备份


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnableLog Integer

是否开启日志备份


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ExpectedNextBackupPeriod String

预计下次备份时间


注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-03-27 00:00:00 ~ 2026-03-27 04:00:00
FullRetentionPeriod Integer

全备保留时间


注意:此字段可能返回 null,表示取不到有效值。
示例值:7
ID Integer

策略ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:3260
InstanceId String

实例ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:tdsql3-3f17e49d
LogRetentionPeriod Integer

日志保留天数


注意:此字段可能返回 null,表示取不到有效值。
示例值:7
PeriodTime String

一周的哪几天进行备份


注意:此字段可能返回 null,表示取不到有效值。
示例值:0,1,2,3,4,5,6
Region String

地域


注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-chengdu
PeriodType Integer

备份周期类型 0:Weekly


注意:此字段可能返回 null,表示取不到有效值。
示例值:0

BackupSetModel

备份集对象

被如下接口引用:DescribeDBSBackupSets。

名称 类型 必选 描述
BackupDuration Integer 备份集耗时,单位 sec
注意:此字段可能返回 null,表示取不到有效值。
BackupMethod String 备份方式
注意:此字段可能返回 null,表示取不到有效值。
BackupName String 备份备注名
注意:此字段可能返回 null,表示取不到有效值。
BackupProgress Float 备份集进度百分比
注意:此字段可能返回 null,表示取不到有效值。
BackupSetId Integer 备份集ID
注意:此字段可能返回 null,表示取不到有效值。
BackupStatus String 备份集状态
注意:此字段可能返回 null,表示取不到有效值。
BackupType String 备份集类型
注意:此字段可能返回 null,表示取不到有效值。
DBVersion String 实例版本号
注意:此字段可能返回 null,表示取不到有效值。
EndTime String 备份结束时间
注意:此字段可能返回 null,表示取不到有效值。
EndTrxTime String 事务commit结束时间
注意:此字段可能返回 null,表示取不到有效值。
ErrorMessage String 错误信息
注意:此字段可能返回 null,表示取不到有效值。
ExpiredTime String 备份过期时间
注意:此字段可能返回 null,表示取不到有效值。
FileName String 备份文件名
注意:此字段可能返回 null,表示取不到有效值。
FileSize Integer 备份集文件大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。
InstanceId String 实例ID
注意:此字段可能返回 null,表示取不到有效值。
ManualBackup Integer 备份触发,0 - autobackup, 1 - manual
注意:此字段可能返回 null,表示取不到有效值。
StartTime String 备份开始时间
注意:此字段可能返回 null,表示取不到有效值。

BackupSetsReqFilter

备份集查询的filter

被如下接口引用:DescribeDBSBackupSets。

名称 类型 必选 描述
BackupMethod String

备份方式,多个值用逗号隔开

枚举值:

  • physical: 物理备份
  • snapshot: 快照备份

注意:此字段可能返回 null,表示取不到有效值。
示例值:physical,snapshot
BackupStatus String

备份状态,多个值用逗号隔开,含义说明:等待调度pending, 运行中 running, 成功success,失败 failed


注意:此字段可能返回 null,表示取不到有效值。
示例值:running,success
BackupType String

备份类型,多个值用逗号隔开,含义说明:全量备份 full

枚举值:

  • full: 全量备份

注意:此字段可能返回 null,表示取不到有效值。
示例值:full
ManualBackup String

备份触发方式

枚举值:

  • 0: 自动备份
  • 1: 手工备份

注意:此字段可能返回 null,表示取不到有效值。
示例值:0,1

BackupStatisticsModel

备份统计对象

被如下接口引用:DescribeDBSBackupStatistics。

名称 类型 描述
AverageSizePerDay Integer

总备份每天平均大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:50508288
DataBackupSize Integer

数据备份大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:37748736
LogBackupSize Integer

日志备份大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:63267840
TotalCount Integer

总备份集个数


注意:此字段可能返回 null,表示取不到有效值。
示例值:8
TotalSize Integer

总备份大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:101016576

BackupTypeStatisticsModel

备份方式统计对象,提供给 备份集统计详情 接口

被如下接口引用:DescribeDBSBackupStatisticsDetail。

名称 类型 描述
DataBackupSize Array of Integer

数据备份大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:[9437184]
LogBackupSize Array of Integer

日志备份大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:[2332672]

BinlogInfo

用于展示该节点的 Binlog 信息。

被如下接口引用:DescribeDBInstanceDetail。

名称 类型 描述
Sid String 日志服务的唯一 ID
示例值:29384942324547636
Type String 日志服务的类型
示例值:mysql
InstanceId String 实例的唯一 ID
示例值:tdsql3-5f8220ae

CloneInstanceModel

克隆实例对象

被如下接口引用:DescribeDBSCloneInstances。

名称 类型 描述
CloneEndTime String 克隆任务结束时间
注意:此字段可能返回 null,表示取不到有效值。
CloneId Integer 克隆记录ID
注意:此字段可能返回 null,表示取不到有效值。
CloneInsType String 克隆实例类型
注意:此字段可能返回 null,表示取不到有效值。
CloneInstanceId String 克隆实例ID
注意:此字段可能返回 null,表示取不到有效值。
CloneInstanceIsDeleted Boolean 克隆实例是否已经删除
注意:此字段可能返回 null,表示取不到有效值。
CloneProgress Float 克隆任务进度
注意:此字段可能返回 null,表示取不到有效值。
CloneStartTime String 克隆任务开始时间
注意:此字段可能返回 null,表示取不到有效值。
CloneStatus String 克隆任务状态
注意:此字段可能返回 null,表示取不到有效值。
CloneTime String 克隆时间
注意:此字段可能返回 null,表示取不到有效值。
CloneType String 克隆类型
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
DBType String 引擎类型
注意:此字段可能返回 null,表示取不到有效值。
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
SourceInstanceId String 源实例ID
注意:此字段可能返回 null,表示取不到有效值。

ConstraintRange

约束类型值的范围

被如下接口引用:DescribeDBParameters。

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

DBParamValue

云数据库参数信息。

被如下接口引用:ModifyDBParameters。

名称 类型 必选 描述
Param String 参数名称
示例值:"lower_case_table_names"
Value String 参数值
示例值:"0"

DataBackupStatisticsModel

数据备份统计对象

被如下接口引用:DescribeDBSBackupStatistics。

名称 类型 描述
AutoBackupCount Integer 自动备份个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AutoBackupSize Integer 自动备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。
示例值:1024
AverageSizePerBackup Integer 平均每个备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。
示例值:1024
AverageSizePerDay Integer 平均每天备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ManualBackupCount Integer 手工备份个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ManualBackupSize Integer 手工备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。
示例值:1024
TotalCount Integer 数据备份个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalSize Integer 数据备份大小,单位Byte
注意:此字段可能返回 null,表示取不到有效值。
示例值:1024

Database

数据库信息

被如下接口引用:DescribeDatabases。

名称 类型 描述
DbName String 数据库名称
示例值:tdsql3-42f40429

DatabaseFunction

数据库函数信息

被如下接口引用:DescribeDatabaseObjects。

名称 类型 描述
Func String 函数名称
示例值:123

DatabasePrivileges

Database级别权限列表

被如下接口引用:ModifyUserPrivileges。

名称 类型 必选 描述
Database String database名
示例值:msyql.user
Privileges Array of String 权限列表
示例值:{"SELECT","DROP”}

DatabaseProcedure

数据库存储过程信息

被如下接口引用:DescribeDatabaseObjects。

名称 类型 描述
Proc String 存储过程名称
示例值:123

DatabaseTable

数据库表信息

被如下接口引用:DescribeDatabaseObjects。

名称 类型 描述
Table String 表名
示例值:123

DatabaseView

数据库视图信息

被如下接口引用:DescribeDatabaseObjects。

名称 类型 描述
View String 视图名称
示例值:123

DescribeSaleRegionInfo

查询售卖接口,region信息返回类型

被如下接口引用:DescribeSaleInfo。

名称 类型 描述
Region String

Region英文字符串


示例值:"ap-guangzhou"
ZoneList Array of DescribeSaleZonesInfo

售卖Zone列表

RegionName String

Region中文字符串


示例值:“广州”
Enable Integer

是否售卖。1:售卖,0不售卖


示例值:1
AvailableZoneNum Integer

多可用可选数量


注意:此字段可能返回 null,表示取不到有效值。
示例值:3
IsSupportedLogReplica Boolean

是否允许使用日志副本


注意:此字段可能返回 null,表示取不到有效值。
示例值:true
ZoneGroup Array of DescribeSaleZonesGroup

可用区组合

IsSupportServerless Boolean

是否支持serverless


示例值:true

DescribeSaleZonesGroup

查询售卖地域,提供推荐的可用区组合

被如下接口引用:DescribeSaleInfo。

名称 类型 描述
ZoneNum Integer

可用区数


示例值:2
Zones Array of String

可用区组合


示例值:["ap-guangzhou-4", "ap-guangzhou-4"]
SupportTypes Array of String

支持的类型


示例值:["0"]
AvailableDiskTypes Array of String

支持的磁盘类型

枚举值:

  • CLOUD_TCS: 本地盘
  • CLOUD_HSSD: 增强型云盘

注意:此字段可能返回 null,表示取不到有效值。
示例值:["CLOUD_TCS","CLOUD_HSSD"]
IsSupportServerless Boolean

是否支持serverless


示例值:true

DescribeSaleZonesInfo

查询售卖接口,zone信息返回类型

被如下接口引用:DescribeSaleInfo。

名称 类型 描述
Zone String

Zone英文字符串


示例值:"ap-guangzhou-1"
ZoneName String

Zone中文字符串


示例值:"广州一区"
Enable Integer

是否售卖,1:售卖;0:不售卖


示例值:1
IsDefaultMaster Integer

是否是默认主可用区,0不是,1是


注意:此字段可能返回 null,表示取不到有效值。
示例值:0
AvailableDiskTypes Array of String

可用区可选磁盘类型


注意:此字段可能返回 null,表示取不到有效值。
示例值:["hssd"]
SupportTypes Array of String

是否是独享可用区


示例值:["1"]
IsSupportServerless Boolean

是否支持serverless


示例值:true

InstanceFilter

实例列表过滤条件

被如下接口引用:DescribeDBInstances。

名称 类型 必选 描述
Name String 过滤key,支持InstanceId、VpcId、SubnetId、Vip、Vport、Status、InstanceName、TagKey
示例值:"InstanceId"
Values Array of String 过滤value
示例值:["tdsql3-d8fffc3c"]

InstanceInfo

实例信息类型

被如下接口引用:DescribeDBInstances。

名称 类型 描述
Zone String

区域


示例值:"ap-guangzhou-1"
CreateVersion String

创建实例版本


注意:此字段可能返回 null,表示取不到有效值。
示例值:"0.0.1"
InitParams Array of InstanceParam

初始化实例参数


注意:此字段可能返回 null,表示取不到有效值。
Status String

实例状态:creating、created、initializing、running、modifying、isolating、isolated、destroying、destroyed


示例值:"running"
InstanceId String

实例id


示例值:"tdsql3-081bfb97"
StorageNodeNum Integer

存储节点数量


示例值:3
ResourceTags Array of ResourceTag

实例标签信息


注意:此字段可能返回 null,表示取不到有效值。
InstanceName String

实例名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:"实例名称"
VpcId String

字符型vpcid


示例值:"vpc-o7ssr1vx"
Vip String

子网IP


示例值:"172.16.113.202"
SubnetId String

字符型subnetid


示例值:"subnet-s21doiba"
Vport Integer

子网端口


示例值:3306
Disk Integer

存储节点磁盘容量,单位GB


示例值:200
CreateTime String

实例创建时间


示例值:"2006-01-02 15:04:05"
Region String

实例所属地域


示例值:"ap-guangzhou"
StatusDesc String

实例状态中文描述


示例值:"运行中"
StorageNodeCpu Integer

存储节点CPU核数


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
StorageNodeMem Integer

存储节点内存大小


注意:此字段可能返回 null,表示取不到有效值。
示例值:2
RenewFlag Integer

续费标志


注意:此字段可能返回 null,表示取不到有效值。
示例值:0
PayMode String

付费模式,0按量付费;1包年包月


示例值:0
AccountTag String

用户标签,inner:内部用户;external:外部用户


注意:此字段可能返回 null,表示取不到有效值。
示例值:inner
InstanceType String

实例架构类型,separate:分离架构;hyper:对等架构


注意:此字段可能返回 null,表示取不到有效值。
示例值:hyper
StorageType String

磁盘类型,CLOUD_HSSD增强型SSD,CLOUD_TCS本地SSD盘


注意:此字段可能返回 null,表示取不到有效值。
示例值:CLOUD_HSSD
DestroyedAt String

"0000-00-00 00:00:00"


注意:此字段可能返回 null,表示取不到有效值。
示例值:"0000-00-00 00:00:00"
ExpireAt String

"0000-00-00 00:00:00"


注意:此字段可能返回 null,表示取不到有效值。
示例值:"0000-00-00 00:00:00"
IsolatedAt String

"0000-00-00 00:00:00"


注意:此字段可能返回 null,表示取不到有效值。
示例值:"0000-00-00 00:00:00"
IsolatedFrom String

"0000-00-00 00:00:00"


注意:此字段可能返回 null,表示取不到有效值。
示例值:"0000-00-00 00:00:00"
Replications Integer

1


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
FullReplications Integer

全能型副本数


示例值:1
AppId Integer

账号信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SubAccountUin String

账号信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:"111111"
Uin String

账号信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:"111111"
Zones Array of String

AZ信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:["ap-guangzhou-1","ap-guangzhou-2"]
Nodes Array of InstanceNode

实例节点


注意:此字段可能返回 null,表示取不到有效值。
BinlogStatus Integer

binlog是否打开


示例值:1
AZMode Integer

az模式,1: 单AZ 2: 多AZ非主AZ模式 3: 多AZ主AZ模式


注意:此字段可能返回 null,表示取不到有效值。
示例值:2
StandbyFlag Integer

灾备标志位,1: 无灾备关系;2: 灾备主实例;3: 灾备备实例


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
StandbySecondaryNum Integer

连接的备实例数量(仅当 StandbyFlag == 2 时有效)


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ColumnarNodeCpu Integer

列存节点 cpu 核数


示例值:1
ColumnarNodeMem Integer

列存节点内存大小


示例值:2
ColumnarNodeNum Integer

列存节点数


示例值:1
ColumnarNodeDisk Integer

列存节点磁盘容量,单位GB


示例值:20
ColumnarNodeStorageType String

列存节点磁盘类型


示例值:CLOUD_HSSD
InstanceCategory Integer

独享标志位,1: 主实例(独享型), 2: 主实例, 3: 灾备实例, 4: 灾备实例(独享型)


示例值:1
ExclusiveClusterId String

dbdc-xxxxx


示例值:独享集群id
SQLMode String

兼容模式


示例值:MySQL
InstanceMode String

实例模式


示例值:normal
AutoScaleConfig AutoScalingConfig

自动扩容配置

AnalysisMode String

分析引擎模式

枚举值:

  • libra: LibraDB分析引擎模式

示例值:libra
AnalysisRelationInfos Array of AnalysisRelationInfo

分析引擎关系信息

InstanceNode

节点信息

被如下接口引用:DescribeDBInstances。

名称 类型 必选 描述
ID Integer 主键
注意:此字段可能返回 null,表示取不到有效值。
InstanceId String 实例id
注意:此字段可能返回 null,表示取不到有效值。
NodeId String Node Id
注意:此字段可能返回 null,表示取不到有效值。
Ip String 实例Ip
注意:此字段可能返回 null,表示取不到有效值。
EniIp String 实例EniIp
注意:此字段可能返回 null,表示取不到有效值。
Port Integer 实例Port
注意:此字段可能返回 null,表示取不到有效值。
SpecCode String 实例SpecCode
注意:此字段可能返回 null,表示取不到有效值。
NodeName String 实例NodeName
注意:此字段可能返回 null,表示取不到有效值。
Cpu Integer 实例Cpu
注意:此字段可能返回 null,表示取不到有效值。
Mem Integer 实例Mem
注意:此字段可能返回 null,表示取不到有效值。
Disk Integer 实例Disk
注意:此字段可能返回 null,表示取不到有效值。
Type String 实例类型
注意:此字段可能返回 null,表示取不到有效值。
Status String 实例状态
注意:此字段可能返回 null,表示取不到有效值。
Version String 实例版本
注意:此字段可能返回 null,表示取不到有效值。
Zone String 实例地域
注意:此字段可能返回 null,表示取不到有效值。
LocalDNS String 实例LocalDNS
注意:此字段可能返回 null,表示取不到有效值。
Region String 实例Region
注意:此字段可能返回 null,表示取不到有效值。
LogDisk Integer 实例日志盘
注意:此字段可能返回 null,表示取不到有效值。
DataDisk Integer 实例数据盘
注意:此字段可能返回 null,表示取不到有效值。
ZoneID String 实例ZoneID
注意:此字段可能返回 null,表示取不到有效值。
SpecName String 实例SpecName
注意:此字段可能返回 null,表示取不到有效值。
Replicas Integer 实例Replicas
注意:此字段可能返回 null,表示取不到有效值。
Shards Integer 实例Shards
注意:此字段可能返回 null,表示取不到有效值。
DataReplicas Integer 实例数据副本
注意:此字段可能返回 null,表示取不到有效值。
Params String 实例初始化参数
注意:此字段可能返回 null,表示取不到有效值。
StorageType String 存储介质, CLOUD_PREMIUM:高性能云盘,CLOUD_SSD: SSD 云盘,CLOUD_HSSD: HSSD 云盘
注意:此字段可能返回 null,表示取不到有效值。

InstanceParam

初始化实例参数

被如下接口引用:CreateDBInstances, DescribeDBInstanceDetail, DescribeDBInstances。

名称 类型 必选 描述
Param String 配置参数key
示例值:"lower_case_table_names"
Value String 配置参数value
示例值:“0”

LogBackupStatisticsModel

日志备份统计对象

被如下接口引用:DescribeDBSBackupStatistics。

名称 类型 描述
AverageSizePerBackup Integer

平均每个日志备份大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:15816960
AverageSizePerDay Integer

平均每天日志备份大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:31633920
TotalCount Integer

日志备份个数


注意:此字段可能返回 null,表示取不到有效值。
示例值:4
TotalSize Integer

日志备份大小,单位Byte


注意:此字段可能返回 null,表示取不到有效值。
示例值:63267840

MaintenanceWindowInfo

维护窗口配置

被如下接口引用:DescribeDBInstanceDetail。

名称 类型 必选 描述
StartTime Integer
Duration Integer
WeekDays Array of String

NodeInfo

节点信息类型

被如下接口引用:DescribeDBInstanceDetail。

名称 类型 描述
IP String

节点IP信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:"9.166.11.37"
Type String

节点类型,如sqlengine,tdstore,mc


注意:此字段可能返回 null,表示取不到有效值。
示例值:"sqlengine"
NodeId String

节点唯一标识


注意:此字段可能返回 null,表示取不到有效值。
示例值:"tdsql3-e234db15-sqlengine-0"
Port Integer

节点端口信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:3306
Zone String

节点所属可用区


注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou-4
Host String

节点所属机器ip


注意:此字段可能返回 null,表示取不到有效值。
示例值:10.0.0.1
BinlogInfo Array of BinlogInfo

节点日志服务信息

Cpu Integer

节点cpu个数


示例值:1
Mem Integer

节点mem大小


示例值:2
DataDisk Integer

节点磁盘大小


示例值:28

ParamConstraint

参数约束

被如下接口引用:DescribeDBParameters。

名称 类型 描述
Type String 约束类型,如枚举enum,区间section
示例值:"enum"
Enum String 约束类型为enum时的可选值列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:"REPEATABLE-READ,SERIALIZABLE,READ-COMMITTED,READ-UNCOMMITTED"
Range ConstraintRange 约束类型为section时的范围
注意:此字段可能返回 null,表示取不到有效值。
String String 约束类型为string时的可选值列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:"0,1"

ParamDesc

DB参数描述

被如下接口引用:DescribeDBParameters。

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

ResourceTag

tag参数

被如下接口引用:CreateCloneInstance, CreateDBInstances, DescribeDBInstanceDetail, DescribeDBInstances。

名称 类型 必选 描述
TagKey String 标签键key
示例值:"tag-key"
TagValue String 标签值value
示例值:"tag-value"

SecurityGroup

安全组详情

被如下接口引用:DescribeDBSecurityGroups。

名称 类型 描述
ProjectId Integer 项目ID
CreateTime String 创建时间,时间格式:yyyy-mm-dd hh:mm:ss
SecurityGroupId String 安全组ID
SecurityGroupName String 安全组名称
SecurityGroupRemark String 安全组备注
Inbound Array of SecurityGroupBound 入站规则
Outbound Array of SecurityGroupBound 出站规则

SecurityGroupBound

安全出入口规则

被如下接口引用:DescribeDBSecurityGroups。

名称 类型 描述
CidrIp String 来源 IP 或 IP 段,例如192.168.0.0/16
Action String 策略,ACCEPT 或者 DROP
PortRange String 端口
IpProtocol String 网络协议,支持 UDP、TCP 等

ServerlessCcu

serverless实例的ccu规格

被如下接口引用:DescribeSpecs。

名称 类型 描述
MinCcu Integer

ccu最小值


示例值:1
MaxCcu Array of Integer

ccu最大值范围


示例值:[1]

StorageNodeSpec

存储节点规格

被如下接口引用:DescribeSpecs。

名称 类型 描述
SpecCode String

规格码


注意:此字段可能返回 null,表示取不到有效值。
示例值:"mini"
StorageNodeCpu Integer

存储节点CPU核数


示例值:1
StorageNodeMem Integer

存储节点内存大小


示例值:2
StorageNodeMaxNum Integer

存储节点最大数量


示例值:16
StorageNodeMaxDisk Integer

存储节点磁盘大小上限


示例值:1000
StorageNodeMinNum Integer

存储节点最小数量


示例值:3
StorageNodeMinDisk Integer

存储节点磁盘大小下限


示例值:10
StorageType String

磁盘类型,CLOUD_HSSD增强型SSD,CLOUD_TCS本地SSD盘


注意:此字段可能返回 null,表示取不到有效值。
示例值:"CLOUD_HSSD"
StorageNodeDefaultDisk Integer

存储节点默认磁盘大小,用于前端展示


注意:此字段可能返回 null,表示取不到有效值。
示例值:20
InstanceMode Array of String

规格支持计费模式列表


示例值:["normal"]
DiskTypeCategory String

磁盘类型CLOUD_DISK:云盘LOCAL_DISK:本地盘


示例值:CLOUD_DISK

TablePrivileges

表级别权限

被如下接口引用:ModifyUserPrivileges。

名称 类型 必选 描述
Database String DATABASE名
示例值:mysql.user
Table String 表名
示例值:mssql_user
Privileges Array of String 权限列表
示例值:{"SELECT","DROP"}

User

数据库账号信息

被如下接口引用:ModifyUserPrivileges。

名称 类型 必选 描述
UserName String 用户名
示例值:sys
Host String 主机
示例值:%

UserInfo

用户信息类型

被如下接口引用:DescribeUsers。

名称 类型 描述
UserName String 用户名
示例值:"test_user"
Description String 用户描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:"test"
Host String 主机IP,IP段以%结尾,表示允许该IP段的所有IP
示例值:"%"
CreateTime String 创建时间
示例值:"2006-01-02 15:04:05"
UpdateTime String 更新时间
示例值:"2006-01-02 15:04:05"