数据结构

最近更新时间:2018-09-28 14:59:59

AddShardConfig

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

被如下接口引用: DescribeDCDBUpgradePrice, UpgradeDCDBInstance.

名称 类型 必选 描述
ShardCount Integer 新增分片的数量
ShardMemory Integer 分片内存大小,单位 GB
ShardStorage Integer 分片存储大小,单位 GB

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 如果备机延迟超过本参数设置值,系统将认为备机发生故障
建议该参数值大于10。当ReadOnly选择1、2时该参数生效。

DBParamValue

云数据库参数信息。

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

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

DCDBInstanceInfo

分布式数据库实例信息

被如下接口引用: DescribeDCDBInstances.

名称 类型 描述
InstanceId String 实例ID
InstanceName String 实例名称
AppId Integer APPID
ProjectId Integer 项目ID
Region String 地域
Zone String 可用区
VpcId Integer VPC数字ID
SubnetId Integer Subnet数字ID
StatusDesc String 状态中文描述
Status Integer 状态
Vip String 内网IP
Vport Integer 内网端口
CreateTime Timestamp 创建时间
AutoRenewFlag Integer 自动续费标志
Memory Integer 内存大小,单位 GB
Storage Integer 存储大小,单位 GB
ShardCount Integer 分片个数
PeriodEndTime Timestamp 到期时间
IsolatedTimestamp Timestamp 隔离时间
Uin String UIN
ShardDetail Array of ShardInfo 分片详情
NodeCount Integer 节点数,2 为一主一从, 3 为一主二从
IsTmp Integer 临时实例标记,0 为非临时实例
ExclusterId String 独享集群Id,为空表示非独享集群实例
UniqueVpcId String 字符串型的私有网络Id
UniqueSubnetId String 字符串型的私有网络子网Id
Id Integer 数字实例Id(过时字段,请勿依赖该值)
WanDomain String 外网访问的域名,公网可解析
WanVip String 外网 IP 地址,公网可访问
WanPort Integer 外网端口
Pid Integer 产品类型 Id(过时字段,请勿依赖该值)
UpdateTime Timestamp 实例最后更新时间,格式为 2006-01-02 15:04:05
DbEngine String 数据库引擎
DbVersion String 数据库引擎版本
Paymode String 付费模式
Locker Integer 实例处于异步任务状态时,表示异步任务流程ID

DCDBShardInfo

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

被如下接口引用: DescribeDCDBShards.

名称 类型 描述
InstanceId String 所属实例Id
ShardSerialId String 分片SQL透传Id,用于将sql透传到指定分片执行
ShardInstanceId String 全局唯一的分片Id
Status Integer 状态:0 创建中,1 流程处理中, 2 运行中,3 分片未初始化
StatusDesc String 状态中文描述
CreateTime Timestamp 创建时间
VpcId String 字符串格式的私有网络Id
SubnetId String 字符串格式的私有网络子网Id
ProjectId Integer 项目ID
Region String 地域
Zone String 可用区
Memory Integer 内存大小,单位 GB
Storage Integer 存储大小,单位 GB
PeriodEndTime Timestamp 到期时间
NodeCount Integer 节点数,2 为一主一从, 3 为一主二从
StorageUsage Float 存储使用率,单位为 %
MemoryUsage Float 内存使用率,单位为 %
ShardId Integer 数字分片Id(过时字段,请勿依赖该值)

Database

数据库信息

被如下接口引用: DescribeDatabases.

名称 类型 描述
DbName String 数据库名称

DatabaseFunction

数据库函数信息

被如下接口引用: DescribeDatabaseObjects.

名称 类型 描述
Func String 函数名称

DatabaseProcedure

数据库存储过程信息

被如下接口引用: DescribeDatabaseObjects.

名称 类型 描述
Proc String 存储过程名称

DatabaseTable

数据库表信息

被如下接口引用: DescribeDatabaseObjects.

名称 类型 描述
Table String 表名

DatabaseView

数据库视图信息

被如下接口引用: DescribeDatabaseObjects.

名称 类型 描述
View String 视图名称

Deal

订单信息

被如下接口引用: DescribeOrders.

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

ExpandShardConfig

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

被如下接口引用: DescribeDCDBUpgradePrice, UpgradeDCDBInstance.

名称 类型 必选 描述
ShardInstanceIds Array of String 分片ID数组
ShardMemory Integer 分片内存大小,单位 GB
ShardStorage Integer 分片存储大小,单位 GB

LogFileInfo

拉取的日志信息

被如下接口引用: DescribeDBLogFiles.

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

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表示该参数值非法

RegionInfo

售卖可用区信息

被如下接口引用: DescribeDCDBSaleInfo.

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

ShardInfo

分片信息

被如下接口引用: DescribeDCDBInstances.

名称 类型 描述
ShardInstanceId String 分片ID
ShardSerialId String 分片Set ID
Status Integer 状态:0 创建中,1 流程处理中, 2 运行中,3 分片未初始化,-2 分片已删除
Createtime String 创建时间
Memory Integer 内存大小,单位 GB
Storage Integer 存储大小,单位 GB
ShardId Integer 分片数字ID
NodeCount Integer 节点数,2 为一主一从, 3 为一主二从
Pid Integer 产品类型 Id(过时字段,请勿依赖该值)

ShardZoneChooseInfo

分片节点可用区选择

被如下接口引用: DescribeDCDBSaleInfo.

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

SpecConfig

按机型分类的规格配置

被如下接口引用: DescribeShardSpec.

名称 类型 描述
Machine String 规格机型
SpecConfigInfos Array of SpecConfigInfo 规格列表

SpecConfigInfo

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

被如下接口引用: DescribeShardSpec.

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

SplitShardConfig

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

被如下接口引用: DescribeDCDBUpgradePrice, UpgradeDCDBInstance.

名称 类型 必选 描述
ShardInstanceIds Array of String 分片ID数组
SplitRate Integer 数据切分比例
ShardMemory Integer 分片内存大小,单位 GB
ShardStorage Integer 分片存储大小,单位 GB

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为成功。

TableColumn

数据库列信息

被如下接口引用: DescribeDatabaseTable.

名称 类型 描述
Col String 列名称
Type String 列类型

ZonesInfo

可用区信息

被如下接口引用: DescribeDCDBSaleInfo.

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