数据结构

AccessInfo

访问信息

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

名称	类型	描述
Address	String	地址 示例值：10.0.0.89:9000
Protocol	String	协议 示例值：tcp

AccountInfo

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

被如下接口引用：DescribeAccounts。

名称	类型	描述
InstanceId	String	实例ID 示例值：cdwpg-12345678
UserName	String	账号名 示例值：cdwpg
Perms	Array of String	账户属性 示例值：[superuser]

CBSSpec

磁盘规格

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

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

CBSSpecInfo

磁盘信息

被如下接口引用：DescribeInstanceInfo。

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

CNResourceSpec

云原生资源规格描述信息

被如下接口引用：ScaleUpInstance。

名称	类型	必选	描述
Type	String	是	节点类型 示例值：cn/dn
SpecName	String	是	机型 示例值：S_8_32_P_CN
Count	Integer	是	节点个数 示例值：2
DiskSpec	CBSSpec	是	磁盘信息 示例值：{"DiskType":"CLOUD_HSSD","DiskSize":400,"DiskCount":1}

ChargeProperties

计费时间参数

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

名称	类型	必选	描述
RenewFlag	Integer	是	1-需要自动续期 示例值：1
TimeSpan	Integer	是	订单时间范围 示例值：1
TimeUnit	String	是	时间单位，一般为h和m 示例值：m
PayMode	Integer	否	计费类型0-按量计费，1-包年包月 示例值：0
ChargeType	String	否	PREPAID、POSTPAID_BY_HOUR 示例值：PREPAID

ConfigHistory

ConfigHistory1

被如下接口引用：DescribeDBConfigHistory。

名称	类型	描述
Id	Integer	id 示例值：1
InstanceId	String	实例名 示例值：cdwpg-sssccasd
CreatedAt	Timestamp ISO8601	创建时间 示例值：2012-12-12 12:12:12
UpdatedAt	Timestamp ISO8601	更新时间 示例值：2012-12-12 12:12:12
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
MaxDiskSize	Integer	否	磁盘最大值 示例值：32000
MinDiskSize	Integer	否	磁盘最小值 示例值：200
DiskType	String	否	磁盘类型 示例值：CLOUD_PREMIUM
DiskDesc	String	否	磁盘类型详情 示例值：高性能云硬盘
CvmClass	String	否	机型类型 示例值：STANDARD

ErrorLogDetail

错误日志详细信息

被如下接口引用：DescribeErrorLog。

名称	类型	描述
UserName	String	用户名称 示例值：tbase
Database	String	数据库 示例值：postgres
ErrorTime	String	报错时间 示例值：2025-03-20 12:08:05
ErrorMessage	String	报错信息 示例值：2025-03-20 12:08:05.847 CST [unknown] 9.0.107.9(44402) postgres tbase 342423 0ERROR

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	否	是否遮盖 示例值：0

InstanceInfo

云原生实例详情

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

名称	类型	描述
ID	Integer	ID值 示例值：101
InstanceType	String	内核版本类型 示例值：TbaseV3
InstanceName	String	集群名字 示例值：cdwpg_test
Status	String	集群状态 示例值：Serving
StatusDesc	String	集群状态详情 示例值：运行中
InstanceStateInfo	InstanceStateInfo	集群状态信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"BackupOpenStatus":1,"BackupStatus":0,"FlowCreateTime":"","FlowMsg":"","FlowName":"","FlowProgress":0,"InstanceState":"Serving","InstanceStateDesc":"运行中","ProcessName":"","RequestId":""}
InstanceID	String	集群id 示例值：cdwpg-xdfsfds
CreateTime	String	创建时间 示例值：2022-09-05 20:00:01
Region	String	地域 示例值：ap-chongqing
Zone	String	地区 示例值：ap-chongqing-1
RegionDesc	String	地域详情 示例值：ap-chongqing
ZoneDesc	String	地区详情 示例值：ap-chongqing-1
Tags	Array of Tag	标签 示例值：[{"TagKey":"k1","TagValue":"v1"}]
Version	String	内核版本 示例值：3.16.9.3
Charset	String	字符集 示例值：utf-8
CNNodes	Array of InstanceNodeGroup	CN节点列表 示例值：[{"Cpu":4,"CvmCount":2,..."SyncType":"sync2async","Type":"slave","UsedStorage":0},{"Cpu":4,"CvmCount":2,..."Type":"slave","UsedStorage":0}]
DNNodes	Array of InstanceNodeGroup	DN节点列表 示例值：[{"Cpu":4,"CvmCount":2,..."SyncType":"sync2async","Type":"slave","UsedStorage":0},{"Cpu":4,"CvmCount":2,..."Type":"slave","UsedStorage":0}]
RegionId	Integer	地域id 示例值：19
ZoneId	Integer	地区id 示例值：190001
VpcId	String	私有网络 示例值：vpc-1asw4o73
SubnetId	String	子网 示例值：subnet-rdlodajk
ExpireTime	String	过期时间 示例值：0000.00.00 00:00:00
PayMode	String	计费方式 示例值：POSTPAID_BY_HOUR
RenewFlag	Boolean	自动续费 示例值：true
InstanceId	String	集群id 示例值：cdwpg-cdsxxx
AccessDetails	Array of AccessInfo	访问信息 示例值：[{"address":"10.0.16.19:9000","protocol":"tcp"}]

InstanceNode

Instance node

被如下接口引用：DescribeInstanceNodes。

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

InstanceNodeGroup

集群节点信息

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

名称	类型	描述
SpecName	String	机型 示例值：S_4_16_P_CN
DataDisk	DiskSpecPlus	磁盘信息 示例值：{"CvmClass":"STANDARD","DiskCount":1,"DiskDesc":"高性能云硬盘","DiskType":"CLOUD_PREMIUM","MaxDiskSize":32000,"MinDiskSize":200}
CvmCount	Integer	机器个数 示例值：2

InstanceOperation

集群操作描述

被如下接口引用：DescribeInstanceOperations。

名称	类型	描述
Id	Integer	操作名称，例如“create_instance"、“scaleout_instance”等 示例值：1
InstanceId	String	集群ID 示例值：cdwpg-xxx
Action	String	操作名称描述，例如“创建”，“修改集群名称”等 示例值：创建
Status	Integer	状态 示例值：2
StartTime	String	操作开始时间 示例值：2022-09-08 12:00:08
EndTime	String	操作结束时间 示例值：2022-09-08 12:00:08
Context	String	操作上下文 示例值：{"AppID":1301xxxx13,"Uin":"10001269xxxx7","Region":"ap-chongqing",UserVPCID"...}
UpdateTime	String	操作更新时间 示例值：2022-09-08 12:00:08
Uin	String	操作UIN 示例值：123123124

InstanceSimpleInfoNew

精简集群信息

被如下接口引用：DescribeSimpleInstances。

名称	类型	描述
ID	Integer	ID 示例值：1323
InstanceId	String	集群Id 示例值：cdwpg-dscxxxx
InstanceName	String	集群名字 示例值：cdwpg-test
Version	String	内核版本 示例值：3.16.4.8
Region	String	地域 示例值：ap-beijing
RegionId	Integer	地域Id 示例值：8
RegionDesc	String	地域详情 示例值：ap-beijing
Zone	String	地区 示例值：ap-beijing-6
ZoneId	Integer	地区id 示例值：800005
ZoneDesc	String	地区详情 示例值：ap-beijing-6
VpcId	String	私有网络 示例值：vpc-1asw4o73
SubnetId	String	子网 示例值：subnet-rdlodajk
CreateTime	String	开始时间 示例值：2025-02-20 11:37:11
ExpireTime	String	过期时间 示例值：0000.00.00 00:00:00
AccessInfo	String	访问地址 示例值：[{"address":"10.0.16.27:9000","protocol":"tcp"}]
PayMode	String	计费方式 示例值：POSTPAID_BY_HOUR
RenewFlag	Boolean	自动续费 示例值：true

InstanceStateInfo

集群状态抽象后的结构体

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

名称	类型	描述
InstanceState	String	集群状态，例如：Serving 示例值：Serving
FlowCreateTime	String	集群操作创建时间 示例值：2023-04-10 15:30:00
FlowName	String	集群操作名称 示例值：create
FlowProgress	Integer	集群操作进度 示例值：50
InstanceStateDesc	String	集群状态描述，例如：运行中 示例值：运行中
FlowMsg	String	集群流程错误信息，例如：“创建失败，资源不足” 示例值：Error:...
ProcessName	String	当前步骤的名称，例如：”购买资源中“ 示例值：create
BackupStatus	Integer	集群是否有备份中任务，有为1,无为0 示例值：1
RequestId	String	请求id 示例值：ad9e5842-e932-47d1-83a0-a388ccc5c19e
BackupOpenStatus	Integer	集群是否有备份中任务，有为1,无为0 示例值：1

NodeConfigParams

node参数

被如下接口引用：ModifyDBParameters。

名称	类型	必选	描述
NodeType	String	是	node类型 示例值：cn
ConfigParams	Array of ConfigParams	是	参数 示例值：[{"ParameterName":"max_connections","ParameterValue":630,"ParameterOldValue":"625"}]

NormQueryItem

慢查询项目信息

被如下接口引用：DescribeSlowLog。

名称	类型	必选	描述
CallTimes	Integer	是	调用次数 示例值：1
SharedReadBlocks	Integer	是	读共享内存块数 示例值：0
SharedWriteBlocks	Integer	是	写共享内存块数 示例值：0
DatabaseName	String	是	数据库 示例值：cran
NormalQuery	String	是	脱敏后语句 示例值：insert into row1 select * from row1;
MaxElapsedQuery	String	是	执行时间最长的语句 示例值：insert into row1 select * from row1;
CostTime	Float	是	花费总时间 示例值：10403.899
ClientIp	String	是	客户端ip 示例值：9.0.116.10
UserName	String	是	用户名 示例值：dbadmin
TotalCallTimesPercent	Float	是	总次数占比 示例值：1
TotalCostTimePercent	Float	是	总耗时占比 示例值：1
MinCostTime	Float	是	花费最小时间 示例值：10403.899
MaxCostTime	Float	是	花费最大时间 示例值：10403.899
FirstTime	String	是	最早一条时间 示例值：2025-03-25 12:07:49
LastTime	String	是	最晚一条时间 示例值：2025-03-25 12:07:49
ReadCostTime	Float	是	读io总耗时 示例值：0.0
WriteCostTime	Float	是	写io总耗时 示例值：0.0

ParamDetail

ParamDetail 详细

被如下接口引用：DescribeDBParams。

名称	类型	描述
ParamName	String	参数名 示例值：vacuum_delta
DefaultValue	String	默认值 示例值：200
NeedRestart	Boolean	是否需要重启 示例值：true
RunningValue	String	当前运行值 示例值：2000
ValueRange	ValueRange	取值范围 示例值：{"Enum":[""],"Range":{"Max":"2000","Min":"50"},"String":"","Type":"section"}
Unit	String	单位 示例值：NULL
ShortDesc	String	英文简介 示例值：The time period before which VACUUM and HOT cleanup could clean the transactions, if any
ParameterName	String	参数名 示例值：vacuum_delta

ParamItem

ParamItem 信息

被如下接口引用：DescribeDBParams。

名称	类型	描述
NodeType	String	节点类型, cn/dn 示例值：cn
NodeName	String	节点名 示例值：cn0001
TotalCount	Integer	参数个数 示例值：5
Details	Array of ParamDetail	参数信息 示例值：[{"DefaultValue":"off","LatestValue":"off",...},{"DefaultValue":"30000","LatestValue":"30000",...}]

Range

Range范围

被如下接口引用：DescribeDBParams。

名称	类型	描述
Min	String	最小值 示例值：1
Max	String	最大值 示例值：2

ResourceInfo

资源信息

被如下接口引用：DescribeInstanceInfo。

名称	类型	必选	描述
SpecName	String	是	资源名称 示例值：S_4_16_H_CN
Count	Integer	是	资源数 示例值：200
DiskSpec	CBSSpecInfo	是	磁盘信息 示例值：{ "DiskType": "CLOUD_HSSD", "DiskSize": 20, "DiskCount": 10 }
Type	String	是	节点类型，cn 或dn 示例值：cn

ResourceSpecNew

资源规格

被如下接口引用：CreateInstanceByApi。

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

SearchTags

列表页搜索的标记列表

被如下接口引用：DescribeInstances。

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

SimpleInstanceInfo

集群信息

被如下接口引用：DescribeInstanceInfo。

名称	类型	必选	描述
ID	Integer	否	ID 示例值：1232
InstanceId	String	否	集群Id 示例值：cdwpg-dscxxxx
InstanceName	String	否	集群名字 示例值：cdwpg-test
Version	String	否	内核版本 示例值：3.16.4.8
Region	String	否	地域 示例值：eu-frankfurt
Zone	String	否	地区 示例值：eu-frankfurt-1
UserVPCID	String	否	私有网络 示例值：vpc-5wsen2rn
UserSubnetID	String	否	子网 示例值：subnet-d05spb5o
CreateTime	String	否	开始时间 示例值：2025-03-03 14:25:01
ExpireTime	String	否	到期时间 示例值：0000.00.00 00:00:00
AccessInfo	String	否	访问地址 示例值：192.168.22.104:9000
RenewFlag	Integer	否	自动续费开关，0为不自动续费，1为自动续费 示例值：1
ChargeProperties	ChargeProperties	否	计费方式 示例值：{"ChargeType":"POSTPAID_BY_HOUR","RenewFlag":0,"TimeSpan":1,"TimeUnit":"h"}
Resources	Array of ResourceInfo	否	资源集合 示例值：[{"Count":2,"DiskSpec":{"DiskCount":10,"DiskSize":20,"DiskType":"CLOUD_HSSD"},"SpecName":"S_4_16_H_CN","Type":"cn"},{"Count":2,"DiskSpec":{"DiskCount":10,"DiskSize":20,"DiskType":"CLOUD_HSSD"},"SpecName":"S_4_16_H","Type":"dn"}]
Tags	Array of Tag	否	标签列表 示例值：{"TagKey":"k1"，"TagValue":"v1"}
Status	Integer	否	集群状态 示例值：0

SlowLogDetail

慢SQL日志

被如下接口引用：DescribeSlowLog。

名称	类型	描述
TotalTime	Float	花费总时间 示例值：10403.899
TotalCallTimes	Integer	调用总次数 示例值：1
NormalQuerys	Array of NormQueryItem	慢SQL 示例值：[{"CallTimes":1,"ClientIp":"9.0.116.10","CostTime":10403.899,"DatabaseName":"evidev","FirstTime":"2025-03-25 12:07:49","LastTime":"2025-03-25 12:07:49",...,"TotalCostTimePercent":1,"UserName":"dbadmin","WriteCostTime":0}]

Tag

标签描述

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

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

UpgradeItem

升级信息

被如下接口引用：DescribeUpgradeList。

名称	类型	必选	描述
TaskName	String	否	任务名称 示例值：UpgradeTo3.15.2.0_2023-02-16 00:12:44
SourceVersion	String	否	原有内核版本 示例值：3.15.0.1
TargetVersion	String	否	目标内核版本 示例值：3.15.2.0
CreateTime	String	否	任务创建时间 示例值：2023-02-17 11:56:15
EndTime	String	否	任务结束时间 示例值：2023-02-17 11:56:15
Status	String	否	任务完成状态 示例值：success
OperateUin	String	否	操作者 示例值：100021289373

ValueRange

ValueRange值

被如下接口引用：DescribeDBParams。

名称	类型	描述
Type	String	参数类型，可以为 enum，string，section; 其中enum表示枚举，类似： utf8,latin1,gbk; string表示返回的参数值是字符串; section表示返回的参数值是一个取值范围，类似：[4-8] 示例值：section
Range	Range	type 取section的时候，返回的参数值 示例值：{"Max":"2000","Min":"50"}
Enum	Array of String	type 取enum的时候，返回参数值 示例值：[""]
String	String	type 取string的时候，返回的参数值 示例值：cran