数据结构

最近更新时间:2018-09-28 15:00:41

ConstraintRange

约束类型值的范围

被如下接口引用: DescribeDBParameters.

名称 类型 描述
Min String 约束类型为section时的最小值
Max String 约束类型为section时的最大值

DBAccount

云数据库账号信息

被如下接口引用: DescribeAccounts.

名称 类型 描述
UserName String 用户名
Host String 用户可以从哪台主机登录(对应 MySQL 用户的 host 字段,UserName + Host 唯一标识一个用户,IP形式,IP段以%结尾;支持填入%;为空默认等于%)
Description String 用户备注信息
CreateTime Timestamp 创建时间
UpdateTime Timestamp 最后更新时间
ReadOnly Integer 只读标记,0:否, 1:该账号的sql请求优先选择备机执行,备机不可用时选择主机执行,2:优先选择备机执行,备机不可用时操作失败。
DelayThresh Integer 该字段对只读帐号有意义,表示选择主备延迟小于该值的备机

DBBackupTimeConfig

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

被如下接口引用: DescribeBackupTime.

名称 类型 描述
InstanceId String 实例 Id
StartBackupTime String 每天备份执行的区间的开始时间,格式 mm:ss,形如 22:00
EndBackupTime String 每天备份执行的区间的结束时间,格式 mm:ss,形如 23:00

DBInstance

描述云数据库实例的详细信息。

被如下接口引用: DescribeDBInstances.

名称 类型 描述
InstanceId String 实例 Id,唯一标识一个 TDSQL 实例
InstanceName String 实例名称,用户可修改
AppId Integer 实例所属应用 Id
ProjectId Integer 实例所属项目 Id
Region String 实例所在地域名称,如 ap-shanghai
Zone String 实例所在可用区名称,如 ap-shanghai-1
VpcId Integer 私有网络 Id,基础网络时为 0
SubnetId Integer 子网 Id,基础网络时为 0
Status Integer 实例状态:0 创建中,1 流程处理中, 2 运行中,3 实例未初始化,-1 实例已隔离,-2 实例已删除
Vip String 内网 IP 地址
Vport Integer 内网端口
WanDomain String 外网访问的域名,公网可解析
WanVip String 外网 IP 地址,公网可访问
WanPort Integer 外网端口
CreateTime Timestamp 实例创建时间,格式为 2006-01-02 15:04:05
UpdateTime Timestamp 实例最后更新时间,格式为 2006-01-02 15:04:05
AutoRenewFlag Integer 自动续费标志:0 否,1 是
PeriodEndTime Timestamp 实例到期时间,格式为 2006-01-02 15:04:05
Uin String 实例所属账号
TdsqlVersion String TDSQL 版本信息
Memory Integer 实例内存大小,单位 GB
Storage Integer 实例存储大小,单位 GB
UniqueVpcId String 字符串型的私有网络Id
UniqueSubnetId String 字符串型的私有网络子网Id
OriginSerialId String 原始实例ID(过时字段,请勿依赖该值)
NodeCount Integer 节点数,2为一主一从,3为一主二从
IsTmp Integer 是否临时实例,0为否,非0为是
ExclusterId String 独享集群Id,为空表示为普通实例
Id Integer 数字实例Id(过时字段,请勿依赖该值)
Pid Integer 产品类型 Id
Qps Integer 最大 Qps 值
Paymode String 付费模式
Locker Integer 实例处于异步任务时的异步任务流程ID
StatusDesc String 实例目前运行状态描述

DBParamValue

云数据库参数信息。

被如下接口引用: InitDBInstances, ModifyDBParameters.

名称 类型 必选 描述
Param String 参数名称
Value String 参数值

Deal

订单信息

被如下接口引用: DescribeOrders.

名称 类型 描述
DealName String 订单号
OwnerUin String 所属账号
Count Integer 商品数量
FlowId Integer 关联的流程 Id,可用于查询流程执行状态
InstanceIds Array of String 只有创建实例的订单会填充该字段,表示该订单创建的实例的 ID。
PayMode Integer 付费模式,0后付费/1预付费

InstanceSpec

按机型归类的实例可售卖规格信息

被如下接口引用: DescribeDBInstanceSpecs.

名称 类型 必选 描述
Machine String 设备型号
SpecInfos Array of SpecConfigInfo 该机型对应的可售卖规格列表

LogFileInfo

拉取的日志信息

被如下接口引用: DescribeDBLogFiles.

名称 类型 描述
Mtime Integer Log最后修改时间
Length Integer 文件长度
Uri String 下载Log时用到的统一资源标识符

MonitorData

监控数据

被如下接口引用: DescribeDBPerformance, DescribeDBPerformanceDetails, DescribeDBResourceUsage, DescribeDBResourceUsageDetails.

名称 类型 描述
StartTime Timestamp 起始时间,形如 2018-03-24 23:59:59
EndTime Timestamp 结束时间,形如 2018-03-24 23:59:59
Data Array of Float 监控数据

MonitorIntData

整形监控数据

被如下接口引用: DescribeDBResourceUsageDetails.

名称 类型 描述
StartTime Timestamp 起始时间
EndTime Timestamp 结束时间
Data Integer 监控数据

ParamConstraint

参数约束

被如下接口引用: DescribeDBParameters.

名称 类型 描述
Type String 约束类型,如枚举enum,区间section
Enum String 约束类型为enum时的可选值列表
Range ConstraintRange 约束类型为section时的范围
String String 约束类型为string时的可选值列表

ParamDesc

DB参数描述

被如下接口引用: DescribeDBParameters.

名称 类型 描述
Param String 参数名字
Value String 当前参数值
SetValue String 设置过的值,参数生效后,该值和value一样。未设置过就不返回该字段。
Default String 系统默认值
Constraint ParamConstraint 参数限制

ParamModifyResult

修改参数结果

被如下接口引用: ModifyDBParameters.

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

PerformanceMonitorSet

DB性能监控指标集合

被如下接口引用: DescribeDBPerformanceDetails.

名称 类型 描述
UpdateTotal MonitorData 更新操作数UPDATE
DiskIops MonitorData 磁盘每秒IO次数
ConnActive MonitorData 活跃连接数
MemHitRate MonitorData 缓存命中率
SlaveDelay MonitorData 主备延迟
SelectTotal MonitorData 查询操作数SELECT
LongQuery MonitorData 慢查询数
DeleteTotal MonitorData 删除操作数DELETE
InsertTotal MonitorData 插入操作数INSERT
IsMasterSwitched MonitorData 是否发生主备切换,1为发生,0否

RegionInfo

售卖可用区信息

被如下接口引用: DescribeSaleInfo.

名称 类型 描述
Region String 地域英文ID
RegionId Integer 地域数字ID
RegionName String 地域中文名
ZoneList Array of ZonesInfo 可用区列表
AvailableChoice Array of ZoneChooseInfo 可选择的主可用区和从可用区

ResourceUsageMonitorSet

DB资源使用情况监控指标集合

被如下接口引用: DescribeDBResourceUsageDetails.

名称 类型 描述
BinlogDiskAvailable MonitorData binlog日志磁盘可用空间,单位GB
CpuUsageRate MonitorData CPU利用率
MemAvailable MonitorData 内存可用空间,单位GB
DataDiskAvailable MonitorIntData 磁盘可用空间,单位GB

SlowLogData

慢查询条目信息

被如下接口引用: DescribeDBSlowLogs.

名称 类型 描述
CheckSum String 语句校验和,用于查询详情
Db String 数据库名称
FingerPrint String 抽象的SQL语句
LockTimeAvg Float 平均的锁时间
LockTimeMax Float 最大锁时间
LockTimeMin Float 最小锁时间
LockTimeSum Float 锁时间总和
QueryCount Integer 查询次数
QueryTimeAvg Float 平均查询时间
QueryTimeMax Float 最大查询时间
QueryTimeMin Float 最小查询时间
QueryTimeSum Float 查询时间总和
RowsExaminedSum Integer 扫描行数
RowsSentSum Integer 发送行数
TsMax Timestamp 首次执行时间
TsMin Timestamp 最后执行时间
User String 帐号

SpecConfigInfo

实例可售卖规格详细信息,创建实例和扩容实例时 Pid+MemSize 唯一确定一种售卖规格,磁盘大小可用区间为[MinDataDisk,MaxDataDisk]

被如下接口引用: DescribeDBInstanceSpecs.

名称 类型 描述
Machine String 设备型号
Memory Integer 内存大小,单位 GB
MinStorage Integer 数据盘规格最小值,单位 GB
MaxStorage Integer 数据盘规格最大值,单位 GB
SuitInfo String 推荐的使用场景
Qps Integer 最大 Qps 值
Pid Integer 产品类型 Id
NodeCount Integer 节点个数,2 表示一主一从,3 表示一主二从

SqlLogItem

描述一条sql日志的详细信息。

被如下接口引用: DescribeSqlLogs.

名称 类型 描述
Offset Integer 本条日志在消息队列中的偏移量。
User String 执行本条sql的用户。
Client String 执行本条sql的客户端IP+端口。
DbName String 数据库名称。
Sql String 执行的sql语句。
SelectRowNum Integer 返回的数据行数。
AffectRowNum Integer 影响行数。
Timestamp Integer Sql执行时间戳。
TimeCostMs Integer Sql耗时,单位为毫秒。
ResultCode Integer Sql返回码,0为成功。

ZoneChooseInfo

分片节点可用区选择

被如下接口引用: DescribeSaleInfo.

名称 类型 描述
MasterZone ZonesInfo 主可用区
SlaveZones Array of ZonesInfo 可选的从可用区

ZonesInfo

可用区信息

被如下接口引用: DescribeSaleInfo.

名称 类型 描述
Zone String 可用区英文ID
ZoneId Integer 可用区数字ID
ZoneName String 可用区中文名