数据结构

最近更新时间:2019-10-18 19:40:01

BackupFile

备份文件存储信息

被如下接口引用:DescribeBackupAccess。

名称 类型 描述
ReplicateSetId String 备份文件所属的副本集/分片id
File String 备份文件保存路径

BackupInfo

备份信息

被如下接口引用:DescribeDBBackups。

名称 类型 描述
InstanceId String 实例ID
BackupType Integer 备份方式,0-自动备份,1-手动备份
BackupName String 备份名称
BackupDesc String 备份备注
注意:此字段可能返回 null,表示取不到有效值。
BackupSize Integer 备份文件大小,单位KB
注意:此字段可能返回 null,表示取不到有效值。
StartTime String 备份开始时间
注意:此字段可能返回 null,表示取不到有效值。
EndTime String 备份结束时间
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 备份状态,1-备份中,2-备份成功
BackupMethod Integer 备份方法,0-逻辑备份,1-物理备份

ClientConnection

客户端连接信息,包括客户端IP和连接数

被如下接口引用:DescribeClientConnections。

名称 类型 描述
IP String 连接的客户端IP
Count Integer 对应客户端IP的连接数

DBInstanceInfo

实例信息

被如下接口引用:DescribeDBInstances。

名称 类型 描述
InstanceId String 实例ID
Region String 地域信息

InstanceDetail

实例详情

被如下接口引用:DescribeDBInstances。

名称 类型 描述
InstanceId String 实例ID
InstanceName String 实例名称
PayMode Integer 付费类型,可能的返回值:1-包年包月;0-按量计费
ProjectId Integer 项目ID
ClusterType Integer 集群类型,可能的返回值:0-副本集实例,1-分片实例,
Region String 地域信息
Zone String 可用区信息
NetType Integer 网络类型,可能的返回值:0-基础网络,1-私有网络
VpcId String 私有网络的ID
SubnetId String 私有网络的子网ID
Status Integer 实例状态,可能的返回值:0-待初始化,1-流程处理中,2-运行中,-2-实例已过期
Vip String 实例IP
Vport Integer 端口号
CreateTime Timestamp 实例创建时间
DeadLine Timestamp 实例到期时间
MongoVersion String 实例版本信息
Memory Integer 实例内存规格,单位为MB
Volume Integer 实例磁盘规格,单位为MB
CpuNum Integer 实例CPU核心数
MachineType String 实例机器类型
SecondaryNum Integer 实例从节点数
ReplicationSetNum Integer 实例分片数
AutoRenewFlag Integer 实例自动续费标志,可能的返回值:0-手动续费,1-自动续费,2-确认不续费
UsedVolume Integer 已用容量,单位MB
MaintenanceStart String 维护窗口起始时间
MaintenanceEnd String 维护窗口结束时间
ReplicaSets Array of ShardInfo 分片信息
ReadonlyInstances Array of DBInstanceInfo 只读实例信息
StandbyInstances Array of DBInstanceInfo 灾备实例信息
CloneInstances Array of DBInstanceInfo 临时实例信息
RelatedInstance DBInstanceInfo 关联实例信息,对于正式实例,该字段表示它的临时实例信息;对于临时实例,则表示它的正式实例信息;如果为只读/灾备实例,则表示他的主实例信息
Tags Array of TagInfo 实例标签信息集合
InstanceVer Integer 实例版本标记
ClusterVer Integer 实例版本标记
Protocol Integer 协议信息,可能的返回值:1-mongodb,2-dynamodb
InstanceType Integer 实例类型,可能的返回值,1-正式实例,2-临时实例,3-只读实例,4-灾备实例
InstanceStatusDesc String 实例状态描述
RealInstanceId String 实例对应的物理实例id,回档并替换过的实例有不同的InstanceId和RealInstanceId,从barad获取监控数据等场景下需要用物理id获取

ShardInfo

实例分片详情

被如下接口引用:DescribeDBInstances。

名称 类型 描述
UsedVolume Float 分片已使用容量
ReplicaSetId String 分片ID
ReplicaSetName String 分片名
Memory Integer 分片内存规格,单位为MB
Volume Integer 分片磁盘规格,单位为MB
OplogSize Integer 分片Oplog大小,单位为MB
SecondaryNum Integer 分片从节点数
RealReplicaSetId String 分片物理id

SpecItem

mongodb售卖规格

被如下接口引用:DescribeSpecInfo。

名称 类型 描述
SpecCode String 规格信息标识
Status Integer 规格有效标志,取值:0-停止售卖,1-开放售卖
Cpu Integer 规格有效标志,取值:0-停止售卖,1-开放售卖
Memory Integer 内存规格,单位为MB
DefaultStorage Integer 默认磁盘规格,单位MB
MaxStorage Integer 最大磁盘规格,单位MB
MinStorage Integer 最小磁盘规格,单位MB
Qps Integer 可承载qps信息
Conns Integer 连接数限制
MongoVersionCode String 实例mongodb版本信息
MongoVersionValue Integer 实例mongodb版本号
Version String 实例mongodb版本号(短)
EngineName String 存储引擎
ClusterType Integer 集群类型,取值:1-分片集群,0-副本集集群
MinNodeNum Integer 最小副本集从节点数
MaxNodeNum Integer 最大副本集从节点数
MinReplicateSetNum Integer 最小分片数
MaxReplicateSetNum Integer 最大分片数
MinReplicateSetNodeNum Integer 最小分片从节点数
MaxReplicateSetNodeNum Integer 最大分片从节点数
MachineType String 机器类型,取值:0-HIO,4-HIO10G

SpecificationInfo

实例规格信息

被如下接口引用:DescribeSpecInfo。

名称 类型 描述
Region String 地域信息
Zone String 可用区信息
SpecItems Array of SpecItem 售卖规格信息

TagInfo

实例标签信息

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

名称 类型 必选 描述
TagKey String 标签键
TagValue String 标签值