Model 对象定义

ObInstanceModel

参数名称	类型	描述
managementMode	String	集群管理模式。 DBaaS: 普通模式。
availableZones	List<String>	可用区列表
expireTime	String	到期时间，该值无效，以instanceExpireTime字段值为准。
instanceExpireTime	String	到期时间
productType	String	计费方式。 prepay: 预付费。 prepay: 后付费。
paymentTiming	String	计费方式。 忽略该字段。
payType	String	计费方式。 忽略该字段。
expireDate	Integer	到期天数。
tags	List<TagModel>	标签信息。
tenants	List<ObTenantModel>	租户数据。当前值无效。
version	String	数据库版本。具体版本参考：ObVerion
obRpmVersion	String	OBServer 详细版本信息。
cloudProvider	String	云厂商。
createTime	String	创建时间。
deployMode	String	集群的数据副本模式，其中 n 为各机房的 OBServer 节点数。 单机房为 n。 双机房为 n-n。 多机房为 n-n-n。
deployType	String	集群的部署类型。具体取值参考：ObDeployType
instanceClass	String	集群规格信息。
instanceId	String	集群ID。
instanceName	String	集群名称。
instanceRole	ObInstanceRole	OceanBase 实例角色。
instanceType	String	OceanBase 实例角色。具体取值参考：ObInstanceType
primaryInstanceId	String	主集群ID。当前集群为备集群时有效。
standbyInstanceIds	List	备集群列表。当前集群为主集群时有效。
region	String	地域。
status	String	实例状态。
series	String	Oceanbase 集群系列。默认 NORMAL_SSD，标准集群版（本地盘）。
cpuArchitecture	String	cpu 架构商品值：X86/ARM。
diskType	String	集群部署的存储类型。具体取值参考：ObDiskType
diskSize	Double	磁盘大小，单位GB。注意：该值为单节点磁盘大小
cpu	Integer	CPU核数。注意：该值为单节点CPU大小
mem	Long	内存大小。注意：该值为单节点内存大小
resource	ObTenantResource	集群的资源信息。注意：该值为集群总容量、总CPU、总内存信息，即单节点大小*节点数
dataMergeTime	String	数据合并时间。
nodeNum	String	节点数。
replicaMode	String	全功能型副本数。具体取值参考：ObReplicaMode
autoRenewRule	AutoRenewRuleModel	自动续费规则

ObTenantModel

参数名称	类型	描述
tenantId	String	租户ID。
tenantName	String	租户名称。
tenantMode	String	兼容模式。
status	String	租户状态。
cpu	Integer	cpu。
mem	Integer	内存大小。
unitCpu	Integer	集群中每个副本节点的 CPU，单位：核数。
unitMem	Integer	租户每个 Unit 的内存大小，单位：GiB。
unitNum	Integer	租户的 unit 个数。
createTime	String	租户创建时间。
dataMergeTime	String	数据合并时间。
deployType	String	部署方式。
primaryZone	String	租户的主可用区
tenantZones	List<ObTenantZone>	租户可用区信息。
timeZone	String	时区。
tenantResource	ObTenantResource	租户资源配置。
tenantCompatibilityMode	String	兼容模式。
tenantConnections	List<ObTenantConnection>	私网链接信息。
lowerCaseTableNamesParam	Integer	表名大小写敏感。
charset	String	字符集。
collation	String	字符序。

AutoRenewRuleModel

参数名称	类型	描述
renewTime	Integer	续费时长
renewTimeUnit	String	续费单位

ObTenantZone

参数名称	类型	描述
name	String	可用区
region	String	地域

ObTenantResource

参数名称	类型	描述
cpu	ObTenantResourceCpu	CPU信息
memory	ObTenantResourceMemory	内存信息
disk	ObTenantResourceDisk	磁盘信息
unitNum	Integer	节点数，部分情况下值可能为空，比如OB实例列表中。

ObTenantResourceCpu

参数名称	类型	描述
totalCpu	Double	总CPU核数。
usedCpu	Double	已用CPU核数。

ObTenantResourceMemory

参数名称	类型	描述
totalMemory	Double	总内存。
usedMemory	Double	已用内存。

ObTenantResourceDisk

参数名称	类型	描述
totalDiskSize	Double	磁盘总容量。
usedDiskSize	Double	自盘已用容量。

ObTenantConnection

参数名称	类型	描述
addressId	String	连接地址ID。
addressStatus	String	连接地址状态。
addressType	String	连接地址类型。
connectionZones	List<String>	可用区。
intranetAddressStatus	String	内网地址状态。
intranetPort	String	内网端口。
maxConnectionNum	Integer	最大连接数。
maxConnectionNumLimit	Integer	最大连接数限制。
proxyClusterId	String	代理实例ID。
proxyClusterInfo	ObProxyClusterInfo	代理实例信息。
role	String	租户权限，取值范围： READWRITE：读写。 READONLY：只读。
serviceType	ObServiceType	连接地址类型。
tenantId	String	租户ID。
privateLinkList	List<ObPrivateLink>	链接信息。
networkType	String	地址类型。取值范围： NTERNET：公网地址。 INTRANET：私网地址。

ObProxyClusterInfo

参数名称	类型	描述
createTime	String	创建时间。
proxyClusterId	String	代理实例ID。
proxyMode	ObProxyMode	代理实例类型。
proxyServiceVersion	String	代理实例service版本。
proxyVersion	String	代理实例版本。
status	String	代理实例状态。
unitNum	Integer	节点数。
unitSpec	String	单节点规格。
zone	String	可用区集合，以逗号分隔。

ObPrivateLink

参数名称	类型	描述
intranetAddress	String	内网地址。
intranetDomain	String	内网域名。
privateLinkEndpointId	String	终端节点 ID。
privateLinkEndpointSubnetId	String	终端节点 子网ID。
privateLinkEndpointVpcId	String	终端节点 私网ID。
privateLinkServiceId	String	服务 ID。
privateLinkStatus	ObPrivateLinkStatus	状态。

ObDataBaseRole

参数名称	类型	描述
database	String	数据库名称。
role	ObDataBaseRoleType	权限。
privileges	ObDataBasePrivilegeType	仅当role=other时有效，以逗号分隔的自定义权限。

TagModel

参数名称	类型	描述
tagKey	String	标签键。
tagValue	String	标签值。

ObTopSQLModel

参数	类型	说明
sqlId	String	SQL 的 ID。
server	String	SQL 执行所在的 Server。
dbName	String	SQL 执行所在的数据库。
userName	String	执行 SQL 的用户。
sqlType	String	SQL的类型，取值范围： SELECT：查询语句 INSERT：插入语句 UPDATE：更新语句 DELETE：删除语句 REPLACE：替换语句 EXPLAIN：计划解析 COMMIT：事务控制 UNKNOWN|OTHER：其它语句
sqlTextShort	String	SQL文本的前100字符。
inner	Boolean	是否为内部SQL。
waitEvent	String	在指定时间区间内，该SQL最耗时的内部事件，取值范围： system internal wait mysql response wait client sync rpc db file data read
executions	Double	SQL在期间内的总执行次数。
execPs	Double	SQL在期间内的平均每秒执行次数，保留 2 位小数。
avgAffectedRows	Double	SQL在期间内的平均更新行数，保留 2 位小数。
avgReturnRows	Double	SQL在期间内的平均返回行数，保留 2 位小数。
avgPartitionCount	Double	SQL在期间内平均访问分区数。
failCount	Double	SQL在期间内的总错误次数。
failPercentage	Double	SQL在期间内的错误百分比，返回值 [0, 1] ，保留四位小数。
retCode4012Count	Long	SQL在期间内发生超时错误（错误码4012）的总次数。
retCode4013Count	Long	SQL在期间内发生内存不足错误（错误码 4013）的总次数。
retCode5001Count	Long	SQL在期间内发生语法解析错误（错误码 5001）的总次数。
retCode5024Count	Long	SQL在期间内发生键值冲突错误（错误码 5024）的总次数。
retCode5167Count	Long	SQL在期间内发生数据超长错误（错误码 5167）的总次数。
retCode5217Count	Long	SQL在期间内发生未知列错误（错误码 5217）的总次数。
retCode6002Count	Long	SQL在期间内发生事务回滚错误（错误码 6002）的总次数。
avgExpectedWorkerCount	Double	期间内平均并行度。
avgUsedWorkerCount	Double	期间内 SQL 平均使用线程数。
avgApplicationWaitTime	Double	期间内的平均Application事件等待时间（毫秒）。
avgWaitTime	Double	SQL在期间内平均等待时间。
avgWaitCount	Double	SQL在期间内的平均等待次数。
avgRpcCount	Double	SQL在期间内的平均发送RPC次数。
localPlanPercentage	Double	SQL在期间内的本地计划百分比。
remotePlanPercentage	Double	SQL在期间内的远程计划百分比。
avgElapsedTime	Double	SQL在期间内的平均响应时间（毫秒）。
maxElapsedTime	Double	SQL在期间内的最大响应时间（毫秒）。
avgCpuTime	Double	SQL在期间内的平均CPU时间（毫秒）。
maxCpuTime	Double	SQL在期间内的最大CPU时间（毫秒）。
avgNetTime	Double	SQL在期间内的平均网络传输时间（毫秒）。
avgNetWaitTime	Double	SQL在期间内的平均网络入队时间（毫秒）。
avgQueueTime	Double	SQL在期间内的平均排队时间（毫秒）。
avgDecodeTime	Double	SQL在期间内的平均语法解析时间（毫秒）。
avgGetPlanTime	Double	SQL在期间内的平均计划生成时间（毫秒）。
avgExecuteTime	Double	SQL在期间内的平均计划执行时间（毫秒）。
avgExecutorRpcCount	Double	SQL在期间内的平均执行RPC请求次数。
missPlanPercentage	Double	SQL在期间内的计划未命中率，返回值 [0, 1] ，保留四位小数。
missPlans	Double	期间未命中执行计划的次数。
avgConcurrencyWaitTime	Double	SQL在期间内的平均Concurrency事件等待时间（毫秒）。
avgUserIoWaitTime	Double	SQL在期间内的平均UserIO事件等待时间（毫秒）。
avgScheduleTime	Double	SQL在期间内的平均Schedule事件等待时间（毫秒）。
avgRowCacheHit	Double	SQL在期间内的平均RowCache命中次数。
avgBloomFilterCacheHit	Double	SQL在期间内的平均BloomFilterCache命中次数。
avgBlockCacheHit	Double	SQL在期间内的平均BlockCache命中次数。
avgBlockIndexCacheHit	Double	SQL在期间内的平均BlockIndexCache命中次数。
avgDiskReads	Double	SQL在期间内的平均磁盘读次数。
retryCount	Integer	SQL在期间内的总计重试次数。
tableScanPercentage	Double	SQL在期间内的表扫描百分比。
strongConsistencyPercentage	Double	SQL在期间内的强一致性事务百分比，返回值 [0, 1] ，保留四位小数。
weakConsistencyPercentage	Double	SQL在期间内的弱一致性事务百分比，返回值 [0, 1] ，保留四位小数。
avgMemstoreReadRows	Double	SQL在期间内的平均MemStore读行数。
avgSsstoreReadRows	Double	SQL在期间内的平均SsStore读行数。
avgLogicalReads	Double	期间内 SQL 平均逻辑读。
cpuPercentage	Double	CPU 占比。
distPlanPercentage	Double	期间内的分布式计划百分比。
maxAffectedRows	Double	期间内的最大影响行数。
maxReturnRows	Double	期间内的最大返回行数。
remotePlans	Double	期间的远程执行次数。
sumElapsedTime	Double	期间内的总响应时间（毫秒）。
sumLogicalReads	Double	期间内 SQL 总逻辑读。
sumWaitTime	Double	期间内的总等待时间（毫秒）。

ObSlowSqlModel

参数	类型	说明
executions	double	期间的总执行次数。
rpcCount	double	期间的 RPC 次数。 00
remotePlans	double	期间的远程执行次数。
missPlans	double	期间未命中执行计划的次数。
maxElapsedTime	double	期间最大响应时间。
totalWaitTime	double	期间总等待时间，单位毫秒。
execPs	double	期间的平均每秒执行次数。
maxCpuTime	double	最大 CPU 时间，单位毫秒。
cpuPercentage	double	CPU 占比。
clientIp	string	客户端 IP。
userName	string	用户名。
dbName	string	数据库名称。
retCode4012Count	long	期间内结果码 4012 的发生次数。
retCode4013Count	long	期间内结果码 4013 的发生次数。
retCode5001Count	long	期间内结果码 5001 的发生次数。
retCode5024Count	long	期间内结果码 5024 的发生次数。
retCode5167Count	long	期间内结果码 5167 的发生次数。
retCode5217Count	long	期间内结果码 5217 的发生次数。
retCode6002Count	long	期间内结果码 6002 的发生次数。
failPercentage	double	期间内的错误百分比。
sumWaitTime	double	期间内的总等待时间（毫秒）。
avgWaitCount	double	期间内的平均等待次数。
avgRpcCount	double	期间内的平均发送 RPC 次数。
localPlanPercentage	double	期间内的本地计划百分比。
remotePlanPercentage	double	期间内的远程计划百分比。
distPlanPercentage	double	期间内的分布式计划百分比。
sumElapsedTime	double	期间内的总响应时间（毫秒）。
avgNetTime	double	期间内的平均网络传输时间（毫秒）。
avgExecutorRpcCount	double	期间内的平均执行 RPC 请求次数。
missPlanPercentage	double	期间内的计划命中率。
tableScanPercentage	double	期间内的表扫描百分比。
strongConsistencyPercentage	double	期间内的强一致性事务百分比。
weakConsistencyPercentage	double	期间内的弱一致性事务百分比。
maxAffectedRows	double	期间内的最大影响行数。
maxReturnRows	double	期间内的最大返回行数。
maxWaitTime	double	期间内的最大等待时间（毫秒）。
maxApplicationWaitTime	double	期间内的最大 Application 事件等待时间（毫秒）。
maxConcurrencyWaitTime	double	期间内的最大 Concurrency 事件等待时间（毫秒）。
maxUserIoWaitTime	double	期间内的最大 UserIO 事件等待时间（毫秒）。
maxDiskReads	double	期间内的最大物理读次数。
avgExpectedWorkerCount	double	期间内平均并行度。
avgUsedWorkerCount	double	期间内 SQL 平均使用线程数。
sumLogicalReads	double	期间内 SQL 总逻辑读。
server	string	SQL 执行所在的 Server。
serverIp	string	SQL 执行所在的 Server IP。
serverPort	long	SQL 执行所在的 Server Port。
sqlTextShort	string	SQL 的文本（前 100 字符）。
sqlType	string	SQL 类型。
sqlId	string	SQL ID。
inner	boolean	是否为内部 SQL。
waitEvent	string	期间内的最长等待事件。
avgAffectedRows	double	期间内平均更新行数。
avgReturnRows	double	期间内平均返回行数。
avgPartitionCount	double	期间内平均访问分区数。
failCount	double	错误次数。
avgWaitTime	double	期间内的平均等待时间（毫秒）。
avgElapsedTime	double	期间内的平均响应时间（毫秒）。
avgCpuTime	double	期间内的平均CPU时间（毫秒）。
avgNetWaitTime	double	期间内的平均网络入队时间（毫秒）。
avgQueueTime	double	期间内的平均排队时间（毫秒）。
avgDecodeTime	double	期间内的平均语法解析时间（毫秒）。
avgGetPlanTime	double	期间内的平均计划生成时间（毫秒）。
avgExecuteTime	double	期间内的平均计划执行时间（毫秒）。
avgApplicationWaitTime	double	期间内的平均Application事件等待时间（毫秒）。
avgConcurrencyWaitTime	double	期间内的平均Concurrency事件等待时间（毫秒）。
avgUserIoWaitTime	double	期间内的平均UserIO事件等待时间（毫秒）。
avgScheduleTime	double	期间内的平均Schedule事件等待时间（毫秒）。
avgRowCacheHit	double	期间内的平均 RowCache 命中次数。
avgBloomFilterCacheHit	double	期间内的平均 BloomFilterCache 命中次数。
avgBlockCacheHit	double	期间内的平均 BlockCache 命中次数。
avgBlockIndexCacheHit	double	期间内的平均 BlockIndexCache 命中次数。
avgDiskReads	double	期间内的平均物理读次数。
retryCount	double	期间内的总计重试次数。
avgMemstoreReadRows	double	读取内存行数。
avgSsstoreReadRows	double	读取磁盘行数。
avgLogicalReads	double	期间内 SQL 平均逻辑读。

类型编码定义

ProductType

枚举值	描述
Prepaid	包年包月（预付费）
Postpaid	按量付费（后付费）

ObVerion

枚举值	描述
4.2.1	版本号
4.2.5	版本号
4.3.5	版本号

ObTenantModeType

枚举值	描述
MySQL	兼容模式为MySQL

ObAddressType

枚举值	描述
MASTER	主地址
READONLY	只读地址
READWRITE	读写分离地址

ObProxyMode

枚举值	描述
k8s_exclusive	独享代理
k8s_shared	共享代理

ObServiceType

枚举值	描述
OBPROXY_INTRANET	主地址
OBPROXY_READONLY	只读地址
OBPROXY_READWRITE	读写分离地址

ObReplicaMode

枚举值	描述
2	即2F1A副本模式。双机房部署时支持；单机房两节点部署时支持；
3	即3F全功能型副本模式。多机房部署时支持；单机房三节点部署时支持；

ObDeployType

枚举值	描述
multiple	多机房部署
dual	双机房部署
single	单机房部署

ObDiskType

枚举值	描述
ephemeral_ssd	本地盘
enhanced_ssd_pl1	pl1云盘

ObDataBaseRoleType

枚举值	描述
readwrite	读写
DDL	DDL
DML	DML
readonly	只读
other	自定义

ObDataBasePrivilegeType

枚举值	描述
ALTER	ALTER
CREATE	CREATE
DELETE	DELETE
DROP	DROP
INSERT	INSERT
SELECT	SELECT
UPDATE	UPDATE
INDEX	INDEX
CREATE VIEW	CREATE VIEW
SHOW VIEW	SHOW VIEW

ObUserType

枚举值	描述
Admin	超级账号
Normal	普通账号
ReadonlyAccount	只读账号

ObEncodingType

枚举值	描述
utf8mb4	utf8mb4
utf16	utf16
gbk	gbk
gb18030	gb18030
binary	binary

ObCollationType

枚举值	描述
utf8mb4_general_ci	字符集为utf8mb4时有效
utf8mb4_bin	字符集为utf8mb4时有效
utf8mb4_unicode_ci	字符集为utf8mb4时有效
utf16_general_ci	字符集为utf16时有效
utf16_bin	字符集为utf16时有效
utf16_unicode_ci	字符集为utf16时有效
gbk_chinese_ci	字符集为gbk时有效
gbk_bin	字符集为gbk时有效
gb18030_chinese_ci	字符集为gb18030时有效
gb18030_bin	字符集为gb18030时有效
binary	字符集为binary时有效

ObInstanceType

枚举值	描述
CLUSTER	集群实例

ObReadonlyReplicaType

枚举值	描述
NOT_READONLY_REPLICA	非只读副本
ROW_STORE	只读副本
COLUMN_STORE	只读列存副本

ObReplicaType

枚举值	描述
FULL	全功能型副本
READONLY	只读副本

ObInstanceRole

枚举值	描述
NORMAL	普通集群
PRIMARY	主集群
PHYSICAL_STANDBY	备集群

ObParameterValueType

枚举值	描述
RANGE	数字区间类型。示例：acceptableValue=["0", "100"]，即取值范围为0-100。
ENUM	单选的枚举类型。示例：acceptableValue=["OFF", "ON"]，即取值枚举值为ON、OFF。
ENUM_MULTIPLE	可多选的枚举类型。类似ENUM类型，但是可以多选。
STRING	字符串类型。
TIME	时间区间类型。示例：acceptableValue=["1s", "3d"]，即取值范围为1秒-3天，可以是1s（1秒）、1m（1分钟）、1h（1小时）、1d（1天）。
TIME_RANGE	时间范围。
CAPACITY	容量范围类型。示例：acceptableValue=["10M", "2G"]，即取值范围为10M-2G。
MOMENT	时分时间范围
UNKNOWN	未知类型

状态编码定义

ObInstanceStatus

状态值	描述
PENDING_CREATE	创建中
ONLINE	运行中
PENDING_DELETE	删除中
DELETED	已删除
CLOSING	关闭中
CLOSED	已关闭
RESTORING	备份恢复中
EXPANDING	租户规格修改中
REDUCING	节点扩容中
SPEC_UPGRADING	套餐规格扩容中
SPEC_DOWNGRADING	变配中
DISK_UPGRADING	日志盘扩容中
DISK_DOWNGRADING	变配中
UPGRADING	版本升级中
MIGRATING	迁移中
SPLITING	拆分中
NETWORK_INITIALIZING	网络初始化中
WHITE_LIST_MODIFYING	白名单修改中
PARAMETER_MODIFYING	参数修改中
TENANT_CREATING	租户创建中
TENANT_SPEC_MODIFYING	租户规格修改中
TENANT_EXPANDING	租户扩容中
PREPAID_EXPIRE_CLOSED	已隔离
ARREARS_CLOSED	已隔离
STANDBY_CREATING	备集群创建中
SSL_MODIFYING	ssl配置变更中
SPEC_MODIFYING	套餐规格修改中
RESTARTING	集群滚动重启
ABNORMAL	异常
STANDBY_DELETING	备集群删除中
SWITCHOVER_SWITCHING	主备切换中
STANDBY_DISCONNECTING	备库解耦中
LOG_DISK_UPGRADING	日志盘扩容中
DISKTYPE_MODIFYING	磁盘类型修改中
PROXY_SERVICE_CREATING	代理服务开通中
PROXY_SERVICE_DELETING	代理服务关闭中
PROXY_SERVICE_SPEC_MODIFYING	代理服务规格修改中
MODIFYING_PRIMARY_ZONE	修改主可用区
DEPLOY_MODE_MODIFYING	部署模式切换中
CREATING_TENANT_READONLY_REPLICA	租户只读副本创建中
DELETING_TENANT_READONLY_REPLICA	租户只读副本删除中

ObTenantStatus

状态值	描述
PENDING_CREATE	创建中
RESTORE	恢复中
ONLINE	运行中
SPEC_MODIFYING	规格修改中
ALLOCATING_INTERNET_ADDRESS	公网地址分配中
PENDING_OFFLINE_INTERNET_ADDRESS	公网地址关闭中
PRIMARY_ZONE_MODIFYING	切主可用区中
PARAMETER_MODIFYING	参数修改中
WHITE_LIST_MODIFYING	白名单修改中

ObAddressStatus

状态值	描述
PENDING_CREATE	创建中
ONLINE	运行中
PENDING_DELETE	删除中
DELETED	运行中

ObPrivateLinkStatus

状态值	描述
UNCREATED	未创建服务网卡
CONNECTING	创建中
CONNECTED	创建完成
DELETING	删除中
DELETED	已删除

ObParameterStatus

状态值	描述
SCHEDULING	调度中
FAILED	设置失败
APPLIED	已生效

订单信息定义

Billing

状态	类型	描述
paymentTiming	String	付费方式： 预付费：Prepaid，后付费：Postpaid
reservation	Reservation	保留信息，支付方式为后支付时不需要设置，预支付时必须设置

Reservation

状态	类型	描述
reservationLength	int	时长，[1,2,3,4,5,6,7,8,9,12,24,36]
reservationTimeUnit	String	时间单位，Month，当前仅支持按月

规格配置定义

ObSpecConfig

规格	CPU	内存（Memory）	磁盘（diskSize）
4C16G	4	16	云盘。磁盘范围：50-5000GB
8C32G	8	32	云盘。磁盘范围：100-10000GB
16C70G	16	70	云盘。磁盘范围：200-20000GB
32C180G	32	180	云盘。磁盘范围：400-40000GB
64C400G	64	400	云盘。磁盘范围：800-80000GB
16C32G	16	32	本地盘。磁盘大小3000GB
32C70G	32	70	本地盘。磁盘大小3000GB
56C160G	56	160	本地盘。磁盘大小6400GB
112C380G	112	380	本地盘。磁盘大小13200GB