数据结构

最近更新时间:2018-11-15 16:37:26

Account

数据库账号信息

被如下接口引用:CreateAccounts、DeleteAccounts、ModifyAccountDescription、ModifyAccountPassword、ModifyAccountPrivileges。

名称 类型 必选 描述
User String 新账户的名称
Host String 新账户的域名

AccountInfo

账号详细信息

被如下接口引用:DescribeAccounts。

名称 类型 描述
Notes String 账号备注信息
Host String 账号的域名
User String 账号的名称
ModifyTime Timestamp 账号信息修改时间
ModifyPasswordTime Timestamp 修改密码的时间
CreateTime Timestamp 账号的创建时间

BackupConfig

ECDB第二个从库的配置信息,只有ECDB实例才有这个字段

被如下接口引用:DescribeDBInstanceConfig。

名称 类型 描述
ReplicationMode String 第二个从库复制方式,可能的返回值:async-异步,semisync-半同步
Zone String 第二个从库可用区的正式名称,如ap-shanghai-1
Vip String 第二个从库内网IP地址
Vport String 第二个从库访问端口

BackupInfo

备份详细信息

被如下接口引用:DescribeBackups。

名称 类型 描述
Name String 备份文件名
Size Integer 备份文件大小,单位:Byte
Date String 备份快照时间,时间格式:2016-03-17 02:10:37
IntranetUrl String 内网下载地址
InternetUrl String 外网下载地址
Type String 日志具体类型,可能的值有:logic - 逻辑冷备,physical - 物理冷备
BackupId Integer 备份子任务的ID,删除备份文件时使用
Status String 备份任务状态
FinishTime String 备份任务的完成时间
Creator String 备份的创建者,可能的值:SYSTEM - 系统创建,Uin - 发起者Uin值

BinlogInfo

二进制日志信息

被如下接口引用:DescribeBinlogs。

名称 类型 描述
Name String 备份文件名
Size Integer 备份文件大小,单位:Byte
Date Timestamp 备份快照时间,时间格式:2016-03-17 02:10:37
IntranetUrl String 内网下载地址
InternetUrl String 外网下载地址
Type String 日志具体类型,可能的值有:binlog - 二进制日志

ColumnPrivilege

列权限信息

被如下接口引用:DescribeAccountPrivileges、ModifyAccountPrivileges。

名称 类型 必选 描述
Database String 数据库名
Table String 数据库表名
Column String 数据库列名
Privileges Array of String 权限信息

DBSwitchInfo

云数据库切换记录

被如下接口引用:DescribeDBSwitchRecords。

名称 类型 描述
SwitchTime Timestamp 切换时间,格式为:2017-09-03 01:34:31
SwitchType String 切换类型,可能的返回值为:TRANSFER - 数据迁移;MASTER2SLAVE - 主备切换;RECOVERY - 主从恢复

DatabaseName

数据库表名

被如下接口引用:DescribeBackupDatabases。

名称 类型 描述
DatabaseName String 数据库表名

DatabasePrivilege

数据库权限

被如下接口引用:DescribeAccountPrivileges、ModifyAccountPrivileges。

名称 类型 必选 描述
Privileges Array of String 权限信息
Database String 数据库名

DrInfo

灾备实例信息

被如下接口引用:DescribeDBInstances。

名称 类型 描述
Status Integer 灾备实例状态
Zone String 可用区信息
InstanceId String 实例ID
Region String 地域信息
SyncStatus Integer 实例同步状态
InstanceName String 实例名称
InstanceType Integer 实例类型

ImportRecord

导入任务记录

被如下接口引用:DescribeDBImportRecords。

名称 类型 描述
Status Integer 状态值
Code Integer 状态值
CostTime Integer 执行时间
InstanceId String 实例ID
WorkId String 后端任务ID
FileName String 导入文件名
Process Integer 执行进度
CreateTime Timestamp 任务创建时间
FileSize String 文件大小
Message String 任务执行信息
JobId Integer 任务ID
DbName String 导入库表名
AsyncRequestId String 异步任务的请求ID

Inbound

安全组入站规则

被如下接口引用:DescribeDBSecurityGroups、DescribeProjectSecurityGroups。

名称 类型 描述
Action String 策略,ACCEPT或者DROP
CidrIp String 来源Ip或Ip段,例如192.168.0.0/16
PortRange String 端口
IpProtocol String 网络协议,支持udp、tcp等
Dir String 规则限定的方向,进站规则为INPUT

InstanceInfo

实例详细信息

被如下接口引用:DescribeDBInstances。

名称 类型 描述
WanStatus Integer 外网状态,可能的返回值为:0-未开通外网;1-已开通外网;2-已关闭外网
Zone String 可用区信息
InitFlag Integer 初始化标志,可能的返回值为:0-未初始化;1-已初始化
RoVipInfo RoVipInfo 只读vip信息。单独开通只读实例访问的只读实例才有该字段
Memory Integer 内存容量,单位为MB
Status Integer 实例状态,可能的返回值:0-创建中;1-运行中;4-隔离中;5-已隔离
VpcId Integer 私有网络ID,例如:51102
SlaveInfo SlaveInfo 备机信息
InstanceId String 实例ID
Volume Integer 硬盘容量,单位为GB
AutoRenew Integer 自动续费标志,可能的返回值:0-未开通自动续费;1-已开通自动续费;2-已关闭自动续费
ProtectMode Integer 数据复制方式
RoGroups Array of RoGroup 只读组详细信息
SubnetId Integer 子网ID,例如:2333
InstanceType Integer 实例类型,可能的返回值:1-主实例;2-灾备实例;3-只读实例
ProjectId Integer 项目ID
Region String 地域信息
DeadlineTime Timestamp 实例到期时间
DeployMode Integer 可用区部署方式
TaskStatus Integer 实例任务状态
MasterInfo MasterInfo 主实例详细信息
DeviceType String 实例类型,可能的返回值:“HA”-高可用版;“BASIC”-基础版
EngineVersion String 内核版本
InstanceName String 实例名称
DrInfo Array of DrInfo 灾备实例详细信息
WanDomain String 外网域名
WanPort Integer 外网端口号
PayType Integer 付费类型,可能的返回值:0-包年包月;1-按量计费
CreateTime String 实例创建时间
Vip String 实例IP
Vport Integer 端口号
CdbError Integer 是否锁定标记
UniqVpcId String 私有网络描述符,例如:“vpc-5v8wn9mg”
UniqSubnetId String 子网描述符,例如:“subnet-1typ0s7d”

InstanceRebootTime

实例预期重启时间

被如下接口引用:DescribeDBInstanceRebootTime。

名称 类型 描述
InstanceId String 实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同
TimeInSeconds Integer 预期重启时间

InstanceRollbackRangeTime

实例可回档时间范围

被如下接口引用:DescribeRollbackRangeTime。

名称 类型 描述
Code Integer 查询数据库错误码
Message String 查询数据库错误信息
InstanceId String 实例ID列表,单个实例Id的格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同
Times Array of RollbackTimeRange 可回档时间范围

MasterInfo

主实例信息

被如下接口引用:DescribeDBInstances。

名称 类型 描述
Region String 地域信息
RegionId Integer 地域ID
ZoneId Integer 可用区ID
Zone String 可用区信息
InstanceId String 实例ID
ResourceId String 实例长ID
Status Integer 实例状态
InstanceName String 实例名称
InstanceType Integer 实例类型
TaskStatus Integer 任务状态
Memory Integer 内存容量
Volume Integer 硬盘容量
DeviceType String 实例机型
Qps Integer 每秒查询数
VpcId Integer 私有网络ID
SubnetId Integer 子网ID
ExClusterId String 独享集群ID
ExClusterName String 独享集群名称

Outbound

安全组出站规则

被如下接口引用:DescribeDBSecurityGroups、DescribeProjectSecurityGroups。

名称 类型 描述
Action String 策略,ACCEPT或者DROP
CidrIp String 目的Ip或Ip段,例如172.16.0.0/12
PortRange String 端口或者端口范围
IpProtocol String 网络协议,支持udp、tcp等
Dir String 规则限定的方向,进站规则为OUTPUT

ParamInfo

实例参数信息

被如下接口引用:CreateDBInstance、CreateDBInstanceHour、InitDBInstances。

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

Parameter

数据库实例参数

被如下接口引用:ModifyInstanceParam。

名称 类型 必选 描述
Name String 参数名称
CurrentValue String 参数值

ParameterDetail

实例参数的详细描述

被如下接口引用:DescribeInstanceParams。

名称 类型 描述
Name String 参数名称
ParamType String 参数类型
Default String 参数默认值
Description String 参数描述
CurrentValue String 参数当前值
NeedReboot Integer 修改参数后,是否需要重启数据库以使参数生效。可能的值包括:0-不需要重启;1-需要重启
Max Integer 参数允许的最大值
Min Integer 参数允许的最小值
EnumValue Array of String 参数的可选枚举值。如果为非枚举参数,则为空

RegionSellConf

地域售卖配置

被如下接口引用:DescribeDBZoneConfig。

名称 类型 描述
RegionName String 地域中文名称
Area String 所属大区
IsDefaultRegion Integer 是否为默认地域
Region String 地域名称
ZonesConf Array of ZoneSellConf 可用区售卖配置

RoGroup

只读组参数

被如下接口引用:CreateDBInstance、CreateDBInstanceHour、DescribeDBInstances。

名称 类型 必选 描述
RoGroupMode String 只读组模式,可选值为:alone-系统自动分配只读组;allinone-新建只读组;join-使用现有只读组
RoGroupId String 只读组ID
RoGroupName String 只读组名称
RoOfflineDelay Integer 是否启用延迟超限剔除功能,启用该功能后,只读实例与主实例的延迟超过延迟阈值值,只读实例将被隔离。可选值:1-启用;0-不启用
RoMaxDelayTime Integer 延迟阀值
MinRoInGroup Integer 最少实例保留个数,若购买只读实例数量小于设置数量将不做剔除
WeightMode String 读写权重分配模式,可选值:system-系统自动分配;custom-自定义
Weight Integer 权重值
RoInstances Array of RoInstanceInfo 只读组中的只读实例详情
Vip String 只读组的内网IP
Vport Integer 只读组的内网端口号

RoInstanceInfo

RO实例的详细信息

被如下接口引用:CreateDBInstance、CreateDBInstanceHour、DescribeDBInstances。

名称 类型 描述
MasterInstanceId String RO组对应的主实例的ID
RoStatus String RO实例在RO组内的状态,可能的值:online-在线,offline-下线
OfflineTime String RO实例在RO组内上一次下线的时间
Weight Integer RO实例在RO组内的权重
Region String RO实例所在区域名称,如ap-shanghai
Zone String RO可用区的正式名称,如ap-shanghai-1
InstanceId String RO实例ID,格式如:cdbro-c1nl9rpv
Status Integer RO实例状态,可能返回值:0-创建中,1-运行中,4-删除中
InstanceType Integer 实例类型,可能返回值:1-主实例,2-灾备实例,3-只读实例
InstanceName String RO实例名称
HourFeeStatus Integer 按量计费状态,可能的取值:1-正常,2-欠费
TaskStatus Integer RO实例任务状态,可能返回值:
0-没有任务
1-升级中
2-数据导入中
3-开放Slave中
4-外网访问开通中
5-批量操作执行中
6-回档中
7-外网访问关闭中
8-密码修改中
9-实例名修改中
10-重启中
12-自建迁移中
13-删除库表中
14-灾备实例创建同步中
Memory Integer RO实例内存大小,单位:MB
Volume Integer RO实例硬盘大小,单位:GB
Qps Integer 每次查询数量
Vip String RO实例的内网IP地址
Vport Integer RO实例访问端口
VpcId Integer RO实例所在私有网络ID
SubnetId Integer RO实例所在私有网络子网ID
DeviceType String RO实例规格描述,目前可取值 CUSTOM
EngineVersion String RO实例数据库引擎版本,可能返回值:5.1、5.5、5.6和5.7
DeadlineTime String RO实例到期时间,时间格式:yyyy-mm-dd hh:mm:ss,如实例为按量计费模式,则此字段值为0000-00-00 00:00:00
PayType Integer RO实例计费类型,可能返回值:0-包年包月,1-按量计费,2-后付费月结

RoVipInfo

只读vip信息

被如下接口引用:DescribeDBInstances。

名称 类型 描述
RoVipStatus Integer 只读vip状态
RoSubnetId Integer 只读vip的子网
RoVpcId Integer 只读vip的私有网络
RoVport Integer 只读vip的端口号
RoVip String 只读vip

RollbackDBName

用于回档的数据库名

被如下接口引用:StartBatchRollback。

名称 类型 必选 描述
DatabaseName String 回档前的原数据库名
NewDatabaseName String 回档后的新数据库名

RollbackInstancesInfo

用于回档的实例详情

被如下接口引用:StartBatchRollback。

名称 类型 必选 描述
InstanceId String 云数据库实例ID
Strategy String 回档策略。可选值为:table、db、full;默认值为full。table - 急速回档模式,仅导入所选中表级别的备份和binlog,如有跨表操作,且关联表未被同时选中,将会导致回档失败,该模式下参数Databases必须为空;db - 快速模式,仅导入所选中库级别的备份和binlog,如有跨库操作,且关联库未被同时选中,将会导致回档失败;full - 普通回档模式,将导入整个实例的备份和binlog,速度较慢。
RollbackTime String 数据库回档时间,时间格式为:yyyy-mm-dd hh:mm:ss
Databases Array of RollbackDBName 待回档的数据库信息,表示整库回档
Tables Array of RollbackTables 待回档的数据库表信息,表示按表回档

RollbackTableName

用于回档的数据库表名

被如下接口引用:StartBatchRollback。

名称 类型 必选 描述
TableName String 回档前的原数据库表名
NewTableName String 回档后的新数据库表名

RollbackTables

用于回档的数据库表详情

被如下接口引用:StartBatchRollback。

名称 类型 必选 描述
Database String 数据库名
Table Array of RollbackTableName 数据库表详情

RollbackTimeRange

可回档时间范围

被如下接口引用:DescribeRollbackRangeTime。

名称 类型 描述
Begin String 实例可回档开始时间,时间格式:2016-10-29 01:06:04
End String 实例可回档结束时间,时间格式:2016-11-02 11:44:47

SecurityGroup

安全组详情

被如下接口引用:DescribeDBSecurityGroups、DescribeProjectSecurityGroups。

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

SellConfig

售卖配置详情

被如下接口引用:DescribeDBZoneConfig。

名称 类型 描述
Device String 设备类型
Type String 售卖规格描述
CdbType String 实例类型
Memory Integer 内存大小,单位为MB
Cpu Integer CPU核心数
VolumeMin Integer 磁盘最小规格,单位为GB
VolumeMax Integer 磁盘最大规格,单位为GB
VolumeStep Integer 磁盘步长,单位为GB
Connection Integer 链接数
Qps Integer 每秒查询数量
Iops Integer 每秒IO数量
Info String 应用场景描述
Status Integer 状态值

SellType

售卖实例类型

被如下接口引用:DescribeDBZoneConfig。

名称 类型 描述
TypeName String 售卖实例名称
EngineVersion Array of String 内核版本号
Configs Array of SellConfig 售卖规格详细配置

SlaveConfig

从库的配置信息

被如下接口引用:DescribeDBInstanceConfig。

名称 类型 描述
ReplicationMode String 从库复制方式,可能的返回值:aysnc-异步,semisync-半同步
Zone String 从库可用区的正式名称,如ap-shanghai-1

SlaveInfo

备机信息

被如下接口引用:DescribeDBInstances。

名称 类型 描述
First SlaveInstanceInfo 第一备机信息
Second SlaveInstanceInfo 第二备机信息

SlaveInstanceInfo

备机信息

被如下接口引用:DescribeDBInstances。

名称 类型 描述
Vport Integer 端口号
Region String 地域信息
Vip String 虚拟Ip信息
Zone String 可用区信息

SlowLogInfo

慢查询日志详情

被如下接口引用:DescribeSlowLogs。

名称 类型 描述
Name String 备份文件名
Size Integer 备份文件大小,单位:Byte
Date Timestamp 备份快照时间,时间格式:2016-03-17 02:10:37
IntranetUrl String 内网下载地址
InternetUrl String 外网下载地址
Type String 日志具体类型,可能的值:slowlog - 慢日志

SqlFileInfo

sql文件信息

被如下接口引用:DescribeUploadedFiles。

名称 类型 描述
UploadTime Timestamp 上传时间
UploadInfo UploadInfo 上传进度
FileName String 文件名
FileSize Integer 文件大小,单位为Bytes
IsUploadFinished Integer 上传是否完成标志,可选值:0 - 未完成,1 - 已完成
FileId String 文件ID

TableName

表名

被如下接口引用:DescribeBackupTables。

名称 类型 描述
TableName String 表名

TablePrivilege

数据库表权限

被如下接口引用:DescribeAccountPrivileges、ModifyAccountPrivileges。

名称 类型 必选 描述
Database String 数据库名
Table String 数据库表名
Privileges Array of String 权限信息

UploadInfo

文件上传描述

被如下接口引用:DescribeUploadedFiles。

名称 类型 描述
AllSliceNum Integer 文件所有分片数
CompleteNum Integer 已完成分片数

ZoneConf

多可用区信息

被如下接口引用:DescribeDBZoneConfig。

名称 类型 必选 描述
DeployMode Array of Integer 可用区部署方式,可能的值为:0-单可用区;1-多可用区
MasterZone Array of String 主实例所在的可用区
SlaveZone Array of String 实例为多可用区部署时,备库1所在的可用区
BackupZone Array of String 实例为多可用区部署时,备库2所在的可用区

ZoneSellConf

可用区售卖配置

被如下接口引用:DescribeDBZoneConfig。

名称 类型 描述
Status Integer 可用区状态。可能的返回值为:0-未上线;1-上线;2-开放;3-停售;4-不展示
ZoneName String 可用区中文名称
IsCustom Boolean 实例类型是否为自定义类型
IsSupportDr Boolean 是否支持灾备
IsSupportVpc Boolean 是否支持私有网络
HourInstanceSaleMaxNum Integer 小时计费实例最大售卖数量
IsDefaultZone Boolean 是否为默认可用区
IsBm Boolean 是否为黑石区
PayType Array of String 支持的付费类型。可能的返回值为:0-包年包月;1-小时计费;2-后付费
ProtectMode Array of String 数据复制类型。0-异步复制;1-半同步复制;2-强同步复制
Zone String 可用区名称
SellType Array of SellType 售卖实例类型数组
ZoneConf ZoneConf 多可用区信息