数据结构

最近更新时间:2025-03-05 14:42:26

我的收藏

AccessInfo

访问信息

被如下接口引用:DescribeInstance, DescribeInstances。

名称 类型 描述
Address String 地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.0.0.89:9000
Protocol String 协议
注意:此字段可能返回 null,表示取不到有效值。
示例值:tcp

AccountInfo

用于描述账号的实例ID、账号名

被如下接口引用:DescribeAccounts。

名称 类型 描述
InstanceId String 实例ID
示例值:cdwpg-12345678
UserName String 账号名
示例值:cdwpg
Perms Array of String 账户属性
注意:此字段可能返回 null,表示取不到有效值。
示例值:[superuser]

CBSSpec

磁盘规格

被如下接口引用:CreateInstanceByApi, ScaleUpInstance。

名称 类型 必选 描述
DiskType String 盘类型
示例值:CLOUD_SSD
DiskSize Integer 大小
示例值:20
DiskCount Integer 个数
示例值:10

CBSSpecInfo

磁盘信息

被如下接口引用:DescribeInstanceInfo。

名称 类型 必选 描述
DiskType String 盘类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:CLOUD_SSD
DiskSize Integer 大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:20
DiskCount Integer 个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10

CNResourceSpec

云原生资源规格描述信息

被如下接口引用:ScaleUpInstance。

名称 类型 必选 描述
Type String
SpecName String
Count Integer
DiskSpec CBSSpec
示例值:xxx

ChargeProperties

计费时间参数

被如下接口引用:CreateInstanceByApi, DescribeInstanceInfo。

名称 类型 必选 描述
RenewFlag Integer 1-需要自动续期
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TimeSpan Integer 订单时间范围
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TimeUnit String 时间单位,一般为h和m
注意:此字段可能返回 null,表示取不到有效值。
示例值:m
PayMode Integer 计费类型0-按量计费,1-包年包月
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ChargeType String PREPAID、POSTPAID_BY_HOUR
注意:此字段可能返回 null,表示取不到有效值。
示例值:PREPAID

ConfigHistory

ConfigHistory1

被如下接口引用:DescribeDBConfigHistory。

名称 类型 描述
Id Integer id1
示例值:1
InstanceId String 实例名
示例值:asd
CreatedAt Timestamp ISO8601 创建时间
示例值:1
UpdatedAt Timestamp ISO8601 更新时间
示例值:1
NodeType String dn/cn
示例值:dn
ParamName String 参数名
示例值:param
ParamNewValue String 新参数值
示例值:new
ParamOldValue String 旧参数值
示例值:old
Status String 状态 doing/success
示例值:doing/success

ConfigParams

参数

被如下接口引用:ModifyDBParameters。

名称 类型 必选 描述
ParameterName String 名字
示例值:Name
ParameterValue String
示例值:value
ParameterOldValue String 修改前的值
示例值:value

DiskSpecPlus

磁盘规格

被如下接口引用:DescribeInstance, DescribeInstances。

名称 类型 必选 描述
DiskCount Integer 1
注意:此字段可能返回 null,表示取不到有效值。
MaxDiskSize Integer 1
注意:此字段可能返回 null,表示取不到有效值。
MinDiskSize Integer 1
注意:此字段可能返回 null,表示取不到有效值。
DiskType String 1
注意:此字段可能返回 null,表示取不到有效值。
DiskDesc String 1
注意:此字段可能返回 null,表示取不到有效值。
CvmClass String 1
注意:此字段可能返回 null,表示取不到有效值。

ErrorLogDetail

错误日志详细信息

被如下接口引用:DescribeErrorLog。

名称 类型 描述
UserName String 用户名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
Database String 数据库
注意:此字段可能返回 null,表示取不到有效值。
示例值:cdwpg
ErrorTime String 报错时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
ErrorMessage String 报错信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:-

HbaConfig

user_config

被如下接口引用:DescribeUserHbaConfig, ModifyUserHba。

名称 类型 必选 描述
Type String 类型
示例值:host
Database String 数据库
示例值:all
User String 用户
示例值:all
Address String ip地址
示例值:0.0.0.0/0
Method String 方法
示例值:md5
Mask String 是否遮盖
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

InstanceInfo

云原生实例详情

被如下接口引用:DescribeInstance, DescribeInstances。

名称 类型 描述
ID Integer ID值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
InstanceType String cdwpg-cn或者其他
注意:此字段可能返回 null,表示取不到有效值。
示例值:cdwpg-cn
InstanceName String cdwpg-cn或者其他
注意:此字段可能返回 null,表示取不到有效值。
示例值:cdwpg-xxxx
Status String Running
注意:此字段可能返回 null,表示取不到有效值。
示例值:Running
StatusDesc String 运行中
注意:此字段可能返回 null,表示取不到有效值。
示例值:运行中
InstanceStateInfo InstanceStateInfo
注意:此字段可能返回 null,表示取不到有效值。
InstanceID String -
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
CreateTime String 2022-09-05 20:00:01
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-09-05 20:00:01
Region String ap-chongqing
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-chongqing
Zone String ap
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-chongqing-1
RegionDesc String region
注意:此字段可能返回 null,表示取不到有效值。
示例值:region
ZoneDesc String zone
注意:此字段可能返回 null,表示取不到有效值。
示例值:zone
Tags Array of Tag 标签
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
Version String v3
注意:此字段可能返回 null,表示取不到有效值。
示例值:v3
Charset String 字符集
注意:此字段可能返回 null,表示取不到有效值。
示例值:zone
CNNodes Array of InstanceNodeGroup CN节点列表
注意:此字段可能返回 null,表示取不到有效值。
DNNodes Array of InstanceNodeGroup DN节点列表
注意:此字段可能返回 null,表示取不到有效值。
RegionId Integer 1
注意:此字段可能返回 null,表示取不到有效值。
ZoneId Integer 1
注意:此字段可能返回 null,表示取不到有效值。
VpcId String 1
注意:此字段可能返回 null,表示取不到有效值。
SubnetId String 1
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime String 1
注意:此字段可能返回 null,表示取不到有效值。
PayMode String 1
注意:此字段可能返回 null,表示取不到有效值。
RenewFlag Boolean 1
注意:此字段可能返回 null,表示取不到有效值。
InstanceId String 1
注意:此字段可能返回 null,表示取不到有效值。
AccessDetails Array of AccessInfo 访问信息
注意:此字段可能返回 null,表示取不到有效值。

InstanceNode

Instance node

被如下接口引用:DescribeInstanceNodes。

名称 类型 描述
NodeId Integer id
示例值:1
NodeType String cn
示例值:cn
NodeIp String ip
示例值:9.0.0.1

InstanceNodeGroup

集群节点信息

被如下接口引用:DescribeInstance, DescribeInstances。

名称 类型 描述
SpecName String 1
注意:此字段可能返回 null,表示取不到有效值。
DataDisk DiskSpecPlus 1
注意:此字段可能返回 null,表示取不到有效值。
CvmCount Integer 1
注意:此字段可能返回 null,表示取不到有效值。

InstanceOperation

集群操作描述

被如下接口引用:DescribeInstanceOperations。

名称 类型 描述
Id Integer 操作名称,例如“create_instance"、“scaleout_instance”等
示例值:1
InstanceId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cdwpg-xxx
Action String 操作名称描述,例如“创建”,“修改集群名称”等
注意:此字段可能返回 null,表示取不到有效值。
示例值:创建
Status Integer 状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
StartTime String 操作开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-09-08 12:00:08
EndTime String 操作结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-09-08 12:00:08
Context String 操作上下文
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
UpdateTime String 操作更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-09-08 12:00:08
Uin String 操作UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:123123124

InstanceSimpleInfoNew

精简集群信息

被如下接口引用:DescribeSimpleInstances。

名称 类型 描述
ID Integer 1
注意:此字段可能返回 null,表示取不到有效值。
示例值:wu
InstanceId String 1
注意:此字段可能返回 null,表示取不到有效值。
InstanceName String 1
注意:此字段可能返回 null,表示取不到有效值。
Version String 1
注意:此字段可能返回 null,表示取不到有效值。
Region String 1
注意:此字段可能返回 null,表示取不到有效值。
RegionId Integer 1
注意:此字段可能返回 null,表示取不到有效值。
RegionDesc String 1
注意:此字段可能返回 null,表示取不到有效值。
Zone String 1
注意:此字段可能返回 null,表示取不到有效值。
ZoneId Integer 1
注意:此字段可能返回 null,表示取不到有效值。
ZoneDesc String 1
注意:此字段可能返回 null,表示取不到有效值。
VpcId String 1
注意:此字段可能返回 null,表示取不到有效值。
SubnetId String 1
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 1
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime String 1
注意:此字段可能返回 null,表示取不到有效值。
AccessInfo String 1
注意:此字段可能返回 null,表示取不到有效值。
PayMode String 1
注意:此字段可能返回 null,表示取不到有效值。
RenewFlag Boolean 1
注意:此字段可能返回 null,表示取不到有效值。

InstanceStateInfo

集群状态抽象后的结构体

被如下接口引用:DescribeInstance, DescribeInstances。

名称 类型 描述
InstanceState String 集群状态,例如:Serving
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
FlowCreateTime String 集群操作创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
FlowName String 集群操作名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
FlowProgress Integer 集群操作进度
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
InstanceStateDesc String 集群状态描述,例如:运行中
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
FlowMsg String 集群流程错误信息,例如:“创建失败,资源不足”
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
ProcessName String 当前步骤的名称,例如:”购买资源中“
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
BackupStatus Integer 集群是否有备份中任务,有为1,无为0
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
RequestId String 1
注意:此字段可能返回 null,表示取不到有效值。
BackupOpenStatus Integer 1
注意:此字段可能返回 null,表示取不到有效值。

NodeConfigParams

node参数

被如下接口引用:ModifyDBParameters。

名称 类型 必选 描述
NodeType String node类型
ConfigParams Array of ConfigParams 参数

NormQueryItem

慢查询项目信息

被如下接口引用:DescribeSlowLog。

名称 类型 必选 描述
CallTimes Integer 调用次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SharedReadBlocks Integer 读共享内存块数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SharedWriteBlocks Integer 写共享内存块数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
DatabaseName String 数据库
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
NormalQuery String 脱敏后语句
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
MaxElapsedQuery String 执行时间最长的语句
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
CostTime Float 花费总时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.0
ClientIp String 客户端ip
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
UserName String 用户名
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
TotalCallTimesPercent Float 总次数占比
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.0
TotalCostTimePercent Float 总耗时占比
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.0
MinCostTime Float 花费最小时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.0
MaxCostTime Float 花费最大时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.0
FirstTime String 最早一条时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
LastTime String 最晚一条时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
ReadCostTime Float 读io总耗时
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.0
WriteCostTime Float 写io总耗时
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.0

ParamDetail

ParamDetail 详细

被如下接口引用:DescribeDBParams。

名称 类型 描述
ParamName String 参数名
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DefaultValue String 默认值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
NeedRestart Boolean 是否需要重启
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
RunningValue String 当前运行值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ValueRange ValueRange 取值范围
Unit String 单位
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ShortDesc String 英文简介
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ParameterName String 参数名
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

ParamItem

ParamItem 信息

被如下接口引用:DescribeDBParams。

名称 类型 描述
NodeType String 节点类型, cn/dn
注意:此字段可能返回 null,表示取不到有效值。
示例值:cn
NodeName String 节点名
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TotalCount Integer 参数个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Details Array of ParamDetail 参数信息
注意:此字段可能返回 null,表示取不到有效值。

Range

Range范围

被如下接口引用:DescribeDBParams。

名称 类型 描述
Min String 最小值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Max String 最大值
注意:此字段可能返回 null,表示取不到有效值。
示例值:2

ResourceInfo

资源信息

被如下接口引用:DescribeInstanceInfo。

名称 类型 必选 描述
SpecName String 资源名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:nc2.large
Count Integer 资源数
注意:此字段可能返回 null,表示取不到有效值。
示例值:200
DiskSpec CBSSpecInfo 磁盘信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{ "DiskType": "CLOUD_HSSD", "DiskSize": 20, "DiskCount": 10 }
Type String 资源类型,DATA
注意:此字段可能返回 null,表示取不到有效值。
示例值:Local

ResourceSpecNew

资源规格

被如下接口引用:CreateInstanceByApi。

名称 类型 必选 描述
SpecName String 资源名称
示例值:nc2.large
Count Integer 资源数
示例值:200
DiskSpec CBSSpec 磁盘信息
示例值:{ "DiskType": "CLOUD_HSSD", "DiskSize": 20, "DiskCount": 10 }
Type String 资源类型,DATA
示例值:Local

SearchTags

列表页搜索的标记列表

被如下接口引用:DescribeInstances。

名称 类型 必选 描述
TagKey String 标签的键
示例值:标签一
TagValue String 标签的值
示例值:标签值一
AllValue Integer 1表示只输入标签的键,没有输入值;0表示输入键时且输入值
示例值:1

SimpleInstanceInfo

集群信息

被如下接口引用:DescribeInstanceInfo。

名称 类型 必选 描述
ID Integer 1
注意:此字段可能返回 null,表示取不到有效值。
示例值:wu
InstanceId String 1
注意:此字段可能返回 null,表示取不到有效值。
InstanceName String 1
注意:此字段可能返回 null,表示取不到有效值。
Version String 1
注意:此字段可能返回 null,表示取不到有效值。
Region String 1
注意:此字段可能返回 null,表示取不到有效值。
Zone String 1
注意:此字段可能返回 null,表示取不到有效值。
UserVPCID String 1
注意:此字段可能返回 null,表示取不到有效值。
UserSubnetID String 1
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 1
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime String 1
注意:此字段可能返回 null,表示取不到有效值。
AccessInfo String 1
注意:此字段可能返回 null,表示取不到有效值。
RenewFlag Integer 1
注意:此字段可能返回 null,表示取不到有效值。
ChargeProperties ChargeProperties 1
注意:此字段可能返回 null,表示取不到有效值。
Resources Array of ResourceInfo 1
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of Tag 1
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 1
注意:此字段可能返回 null,表示取不到有效值。

SlowLogDetail

慢SQL日志

被如下接口引用:DescribeSlowLog。

名称 类型 描述
TotalTime Float 花费总时间
示例值:0.0
TotalCallTimes Integer 调用总次数
示例值:0
NormalQuerys Array of NormQueryItem 慢SQL
示例值:[]

Tag

标签描述

被如下接口引用:CreateInstanceByApi, DescribeInstance, DescribeInstanceInfo, DescribeInstances。

名称 类型 必选 描述
TagKey String 标签的键
示例值:标签一
TagValue String 标签的值
示例值:内容一

UpgradeItem

升级信息

被如下接口引用:DescribeUpgradeList。

名称 类型 必选 描述
TaskName String 任务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:UpgradeTo3.15.2.0_2023-02-16 00:12:44
SourceVersion String 原有内核版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:3.15.0.1
TargetVersion String 目标内核版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:3.15.2.0
CreateTime String 任务创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-02-17 11:56:15
EndTime String 任务结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-02-17 11:56:15
Status String 任务完成状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:success
OperateUin String 操作者
注意:此字段可能返回 null,表示取不到有效值。

ValueRange

ValueRange值

被如下接口引用:DescribeDBParams。

名称 类型 描述
Type String 参数类型,可以为 enum,string,section; 其中enum表示枚举,类似: utf8,latin1,gbk; string表示返回的参数值是字符串; section表示返回的参数值是一个取值范围,类似:[4-8]
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Range Range type 取section的时候,返回的参数值
注意:此字段可能返回 null,表示取不到有效值。
Enum Array of String type 取enum的时候,返回参数值
注意:此字段可能返回 null,表示取不到有效值。
String String type 取string的时候,返回的参数值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1