数据结构

最近更新时间:2020-08-20 08:18:26

AccountInfo

账户信息

被如下接口引用:DescribeAccounts。

名称 类型 描述
DBInstanceId String 实例ID,形如postgres-lnp6j617
UserName String 帐号
Remark String 帐号备注
Status Integer 帐号状态。 1-创建中,2-正常,3-修改中,4-密码重置中,-1-删除中
CreateTime Timestamp 帐号创建时间
UpdateTime Timestamp 帐号最后一次更新时间

DBBackup

数据库备份信息

被如下接口引用:DescribeDBBackups。

名称 类型 描述
Id Integer 备份文件唯一标识
StartTime String 文件生成的开始时间
EndTime String 文件生成的结束时间
Size Integer 文件大小(K)
Strategy Integer 策略(0-实例备份;1-多库备份)
Way Integer 类型(0-定时)
Type Integer 备份方式(1-完整)
Status Integer 状态(1-创建中;2-成功;3-失败)
DbList Array of String DB列表
InternalAddr String 内网下载地址
ExternalAddr String 外网下载地址

DBInstance

描述实例的详细信息

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

名称 类型 描述
Region String 实例所属地域,如: ap-guangzhou,对应RegionSet的Region字段
Zone String 实例所属可用区, 如:ap-guangzhou-3,对应ZoneSet的Zone字段
ProjectId Integer 项目ID
VpcId String 私有网络ID
SubnetId String 子网ID
DBInstanceId String 实例ID
DBInstanceName String 实例名称
DBInstanceStatus String 实例状态,分别为:applying(申请中)、init(待初始化)、initing(初始化中)、running(运行中)、limited run(受限运行)、isolated(已隔离)、recycling(回收中)、recycled(已回收)、job running(任务执行中)、offline(下线)、migrating(迁移中)、expanding(扩容中)、readonly(只读)、restarting(重启中)
DBInstanceMemory Integer 实例分配的内存大小,单位:GB
DBInstanceStorage Integer 实例分配的存储空间大小,单位:GB
DBInstanceCpu Integer 实例分配的CPU数量,单位:个
DBInstanceClass String 售卖规格ID
DBInstanceType String 实例类型,类型有:1、primary(主实例);2、readonly(只读实例);3、guard(灾备实例);4、temp(临时实例)
DBInstanceVersion String 实例版本,目前只支持standard(双机高可用版, 一主一从)
DBCharset String 实例DB字符集
DBVersion String PostgreSQL内核版本
CreateTime Timestamp 实例创建时间
UpdateTime Timestamp 实例执行最后一次更新的时间
ExpireTime Timestamp 实例到期时间
IsolatedTime Timestamp 实例隔离时间
PayType String 计费模式,1、prepaid(包年包月,预付费);2、postpaid(按量计费,后付费)
AutoRenew Integer 是否自动续费,1:自动续费,0:不自动续费
DBInstanceNetInfo Array of DBInstanceNetInfo 实例网络连接信息
Type String 机器类型
AppId Integer 用户的AppId
Uid Integer 实例的Uid
SupportIpv6 Integer 实例是否支持Ipv6,1:支持,0:不支持
TagList Array of Tag 实例绑定的标签信息
注意:此字段可能返回 null,表示取不到有效值。

DBInstanceNetInfo

描述实例的网络连接信息。

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

名称 类型 描述
Address String DNS域名
Ip String IP地址
Port Integer 连接Port地址
NetType String 网络类型,1、inner(基础网络内网地址);2、private(私有网络内网地址);3、public(基础网络或私有网络的外网地址);
Status String 网络连接状态

ErrLogDetail

错误日志详情

被如下接口引用:DescribeDBErrlogs。

名称 类型 描述
UserName String 用户名
Database String 数据库名字
ErrTime String 错误发生时间
ErrMsg String 错误消息

Filter

描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称等

  • 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
  • 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。

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

名称 类型 必选 描述
Name String 过滤键的名称。
Values Array of String 一个或者多个过滤值。

NormalQueryItem

单条SlowQuery信息

被如下接口引用:DescribeDBSlowlogs。

名称 类型 描述
UserName String 用户名
Calls Integer 调用次数
CallsGrids Array of Integer 粒度点
CostTime Float 花费总时间
Rows Integer 影响的行数
MinCostTime Float 花费最小时间
MaxCostTime Float 花费最大时间
FirstTime String 最早一条慢SQL时间
LastTime String 最晚一条慢SQL时间
SharedReadBlks Integer 读共享内存块数
SharedWriteBlks Integer 写共享内存块数
ReadCostTime Integer 读io总耗时
WriteCostTime Integer 写io总耗时
DatabaseName String 数据库名字
NormalQuery String 脱敏后的慢SQL

PgDeal

订单详情

被如下接口引用:DescribeOrders。

名称 类型 描述
DealName String 订单名
OwnerUin String 所属用户
Count Integer 订单涉及多少个实例
PayMode Integer 付费模式。1-预付费;0-后付费
FlowId Integer 异步任务流程ID
DBInstanceIdSet Array of String 实例ID数组

RegionInfo

描述地域的编码和状态等信息

被如下接口引用:DescribeRegions。

名称 类型 描述
Region String 该地域对应的英文名称
RegionName String 该地域对应的中文名称
RegionId Integer 该地域对应的数字编号
RegionState String 可用状态,UNAVAILABLE表示不可用,AVAILABLE表示可用

ServerlessDBAccount

serverless账号描述

被如下接口引用:DescribeServerlessDBInstances。

名称 类型 描述
DBUser String 用户名
注意:此字段可能返回 null,表示取不到有效值。
DBPassword String 密码
注意:此字段可能返回 null,表示取不到有效值。
DBConnLimit Integer 连接数限制
注意:此字段可能返回 null,表示取不到有效值。

ServerlessDBInstance

serverless实例描述

被如下接口引用:DescribeServerlessDBInstances。

名称 类型 必选 描述
DBInstanceId String 实例id,唯一标识符
注意:此字段可能返回 null,表示取不到有效值。
DBInstanceName String 实例名称
注意:此字段可能返回 null,表示取不到有效值。
DBInstanceStatus String 实例状态
注意:此字段可能返回 null,表示取不到有效值。
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
Zone String 可用区
注意:此字段可能返回 null,表示取不到有效值。
ProjectId Integer 项目id
注意:此字段可能返回 null,表示取不到有效值。
VpcId String 私有网络Id
注意:此字段可能返回 null,表示取不到有效值。
SubnetId String 子网id
注意:此字段可能返回 null,表示取不到有效值。
DBCharset String 字符集
注意:此字段可能返回 null,表示取不到有效值。
DBVersion String 数据库版本
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
DBInstanceNetInfo Array of ServerlessDBInstanceNetInfo 实例网络信息
注意:此字段可能返回 null,表示取不到有效值。
DBAccountSet Array of ServerlessDBAccount 实例账户信息
注意:此字段可能返回 null,表示取不到有效值。
DBDatabaseList Array of String 实例下的db信息
注意:此字段可能返回 null,表示取不到有效值。
TagList Array of Tag 实例绑定的标签数组
注意:此字段可能返回 null,表示取不到有效值。

ServerlessDBInstanceNetInfo

serverless实例网络信息描述

被如下接口引用:DescribeServerlessDBInstances。

名称 类型 描述
Address String 地址
注意:此字段可能返回 null,表示取不到有效值。
Ip String ip地址
注意:此字段可能返回 null,表示取不到有效值。
Port Integer 端口号
注意:此字段可能返回 null,表示取不到有效值。
Status String 状态
注意:此字段可能返回 null,表示取不到有效值。
NetType String 网络类型
注意:此字段可能返回 null,表示取不到有效值。

SlowlogDetail

慢查询详情

被如下接口引用:DescribeDBSlowlogs。

名称 类型 描述
TotalTime Float 花费总时间
TotalCalls Integer 调用总次数
NormalQueries Array of NormalQueryItem 脱敏后的慢SQL列表

SpecInfo

描述某个地域下某个可用区的可售卖规格详细信息。

被如下接口引用:DescribeProductConfig。

名称 类型 描述
Region String 地域英文编码,对应RegionSet的Region字段
Zone String 区域英文编码,对应ZoneSet的Zone字段
SpecItemInfoList Array of SpecItemInfo 规格详细信息列表

SpecItemInfo

描述一种规格的信息

被如下接口引用:DescribeProductConfig。

名称 类型 描述
SpecCode String 规格ID
Version String PostgreSQL的内核版本编号
VersionName String 内核编号对应的完整版本名称
Cpu Integer CPU核数
Memory Integer 内存大小,单位:MB
MaxStorage Integer 该规格所支持最大存储容量,单位:GB
MinStorage Integer 该规格所支持最小存储容量,单位:GB
Qps Integer 该规格的预估QPS
Pid Integer 该规格对应的计费ID
Type String 机器类型

Tag

实例绑定的标签信息,包含标签键TagKey和标签值TagValue

被如下接口引用:CreateDBInstances, CreateServerlessDBInstance, DescribeDBInstanceAttribute, DescribeDBInstances, DescribeServerlessDBInstances。

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

Xlog

数据库Xlog信息

被如下接口引用:DescribeDBXlogs。

名称 类型 描述
Id Integer 备份文件唯一标识
StartTime Timestamp 文件生成的开始时间
EndTime Timestamp 文件生成的结束时间
InternalAddr String 内网下载地址
ExternalAddr String 外网下载地址
Size Integer 备份文件大小

ZoneInfo

描述可用区的编码和状态信息

被如下接口引用:DescribeZones。

名称 类型 描述
Zone String 该可用区的英文名称
ZoneName String 该可用区的中文名称
ZoneId Integer 该可用区对应的数字编号
ZoneState String 可用状态,UNAVAILABLE表示不可用,AVAILABLE表示可用
ZoneSupportIpv6 Integer 该可用区是否支持Ipv6
目录