数据结构

AttachCBSSpec

集群内节点的规格磁盘规格描述

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

名称	类型	必选	描述
DiskType	String	否	节点磁盘类型，例如“CLOUD_SSD”"CLOUD_PREMIUM" 示例值：CLOUD_SSD
DiskSize	Integer	否	磁盘容量，单位G 示例值：100
DiskCount	Integer	否	磁盘总数 示例值：10
DiskDesc	String	否	描述 示例值：SSD

BackUpJobDisplay

备份实例详情

被如下接口引用：DescribeBackUpJob。

名称	类型	必选	描述
JobId	Integer	否	备份实例id 示例值：145
Snapshot	String	否	备份实例名 示例值：snapshot
BackUpSize	Integer	否	备份数据量 示例值：243
BackUpSingleSize	Integer	否	备份单副本数据量 示例值：365
BackUpTime	String	否	实例创建时间 示例值："2021-09-18 00:12:23"
ExpireTime	String	否	实例过期时间 示例值："2021-09-18 00:12:23"
JobStatus	String	否	实例状态 示例值："jing"
BackupType	Integer	否	0为默认。1时是对远端的doris进行备份，不周期，一次性 示例值：1
BackupTimeType	Integer	否	0为默认。1时是立即备份。2时是迁移 示例值：1
DorisSourceInfo	DorisSourceInfo	否	远端doris的连接信息 示例值：source
JobStatusNum	Integer	否	实例状态对应的数值 示例值：1
BackupCosInfo	BackupCosInfo	否	备份实例中关于cos的信息
IsUserDefineBucket	Boolean	否	是否使用的自定义桶 示例值：true
ErrorReason	String	否	错误原因 示例值：error reason detail

BackupCosInfo

备份实例中关于cos的信息

被如下接口引用：DescribeBackUpJob。

名称	类型	必选	描述
CosBucket	String	否	备份文件所在的cos桶 示例值：https://tss-gz-130551234.cos.ap-guangzhou.myqcloud.com/
CosPath	String	否	备份文件所在的完整cos路径 示例值：cdwdoris-aaxe12
SnapShotPath	String	否	备份文件名称 示例值：snapshot-axxx

BackupStatus

备份任务的进度详情

被如下接口引用：DescribeBackUpTaskDetail。

名称	类型	描述
JobId	Integer	备份任务id 示例值：1
SnapshotName	String	快照名称 示例值：snapshot-xxx-abc
DbName	String	库名 示例值：test_db
State	String	状态 示例值：FINISHED
BackupObjects	String	备份对象 示例值：[default_cluster:abc.table_hash5]
CreateTime	String	创建时间 示例值：2022-06-24 15:37:26
SnapshotFinishedTime	String	快照结束时间 示例值：2022-06-24 15:37:26
UploadFinishedTime	String	上传结束时间 示例值：2022-06-24 15:37:26
FinishedTime	String	结束时间 示例值：2022-06-24 15:37:26
UnfinishedTasks	String	未完成任务 示例值： tasks
Progress	String	进度 示例值： 20
TaskErrMsg	String	错误信息 示例值： error
Status	String	状态 示例值：[OK]
Timeout	Integer	超时信息 示例值：120
BackupJobId	Integer	备份实例id 示例值：6872
TaskId	Integer	实例对应snapshoit的id 示例值：2221

BackupTableContent

备份表信息

被如下接口引用：CreateBackUpSchedule, DescribeBackUpJobDetail, DescribeBackUpTables。

名称	类型	必选	描述
Database	String	是	数据库 示例值：db_name
Table	String	是	表 示例值：test123
TotalBytes	Integer	是	表总字节数 示例值：23124
SingleReplicaBytes	String	否	表单个副本的大小 示例值：1458
BackupStatus	Integer	否	备份状态 示例值：2
BackupErrorMsg	String	否	备份的错误信息 示例值：error
IsOpenCoolDown	Boolean	否	该库表是否绑定降冷策略 示例值：true

BindUser

资源组绑定的用户信息，需要username和host信息进行授权

被如下接口引用：ModifyUserBindWorkloadGroup。

名称	类型	必选	描述
UserName	String	否	用户名 示例值：user_a
Host	String	否	主机信息 示例值：%

ChargeProperties

集群计费相关信息

被如下接口引用：CreateInstanceNew。

名称	类型	必选	描述
ChargeType	String	否	计费类型，“PREPAID” 预付费，“POSTPAID_BY_HOUR” 后付费 示例值：POSTPAY
RenewFlag	Integer	否	是否自动续费，1表示自动续费开启 示例值：0
TimeSpan	Integer	否	计费时间长度 示例值：1
TimeUnit	String	否	计费时间单位，“m”表示月等 示例值：h

ClusterConfigsHistory

集群的配置文件的修改历史

被如下接口引用：DescribeClusterConfigsHistory。

名称	类型	描述
ComputeGroupId	String	计算组id 示例值：tchd-2ydhbjw5-xasd1
FileName	String	配置文件名称 示例值：config.xml
NewConfValue	String	修改后的配置文件内容，base64编码 示例值：PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHlhbmRleD4K
OldConfValue	String	修改前的配置文件内容，base64编码 示例值：PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHlhbmRleD4K
Remark	String	修改原因 示例值：为了修改配置
ModifyTime	String	修改时间 示例值：2021-06-09 16:36:12
UserUin	String	修改子账号id 示例值：100013654649

ClusterConfigsInfoFromEMR

用于返回XML格式的配置文件和内容以及其他配置文件有关的信息

被如下接口引用：DescribeClusterConfigs。

名称	类型	描述
FileName	String	配置文件名称 示例值：config.xml
FileConf	String	配置文件对应的相关属性信息 示例值：{"editable":true,"display":true,"type":"Customize","fileOwner":"
KeyConf	String	配置文件对应的其他属性信息 示例值：{"customKey":{"name":"customKey","type":"string","description":"
OriParam	String	配置文件的内容，base64编码 示例值：PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHlhbmRleD4K
NeedRestart	Integer	用于表示当前配置文件是不是有过修改后没有重启，提醒用户需要重启 示例值：1
FilePath	String	配置文件路径 示例值：:"/usr/local/service/doris/conf"
FileKeyValuesNew	Array of ConfigKeyValue	配置文件kv值

ConfigKeyValue

返回配置的文件内容（key-value）

被如下接口引用：DescribeClusterConfigs。

名称	类型	描述
KeyName	String	key 示例值：fe_port
Value	String	值 示例值：9030
Message	String	备注 示例值：message
Display	Integer	1-只读，2-可修改但不可删除，3-可删除 示例值：1
SupportHotUpdate	Integer	0不支持 1支持热更新 示例值：1

ConfigSubmitContext

配置文件修改信息

被如下接口引用：ModifyClusterConfigs。

名称	类型	必选	描述
FileName	String	是	配置文件名称 示例值：config.xml
NewConfValue	String	是	配置文件新内容，base64编码 示例值：PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHlhbmRleD4K
OldConfValue	String	否	配置文件旧内容，base64编码 示例值：PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHlhbmRleD4K
FilePath	String	否	文件路径 示例值：/use/local/server/

CoolDownBackend

冷热分层backend节点信息

被如下接口引用：DescribeCoolDownBackends。

名称	类型	必选	描述
Host	String	否	字段：Host 示例值：10.0.1.13
DataUsedCapacity	String	否	字段：DataUsedCapacity 示例值：134
TotalCapacity	String	否	字段：TotalCapacity 示例值：23451
RemoteUsedCapacity	String	否	字段：RemoteUsedCapacity 示例值：12456

CoolDownPolicyInfo

冷热分层策略

被如下接口引用：DescribeCoolDownPolicies。

名称	类型	必选	描述
PolicyName	String	否	策略名称 示例值：policy_1
CooldownDatetime	String	否	cooldown_ttl 示例值：2024-12-04 13:11:34
CooldownTtl	String	否	cooldown_datetime 示例值：120

CoolDownTableDataInfo

冷热分层Table数据信息

被如下接口引用：DescribeCoolDownTableData。

名称	类型	必选	描述
DatabaseName	String	否	列：DatabaseName 示例值：db
TableName	String	否	列：TableName 示例值：table_1
Size	String	否	列：Size 示例值：124
RemoteSize	String	否	列：RemoteSize 示例值：386

CosSourceInfo

客户提供cos认证信息。

被如下接口引用：CreateBackUpSchedule, DescribeBackUpTables。

名称	类型	必选	描述
SecretId	String	否	cos认证中的Id 示例值：ak_id
SecretKey	String	否	cos认证中的key 示例值：ak_sk
CosPath	String	否	cos认证中的路径 示例值：http://test.ap-guangzhou.co,

CreateInstanceSpec

集群规格

被如下接口引用：CreateInstanceNew。

名称	类型	必选	描述
SpecName	String	是	规格名字 示例值：S_4_16_H
Count	Integer	是	数量 示例值：3
DiskSize	Integer	是	云盘大小 示例值：300

DataBaseAuditRecord

数据库审计

被如下接口引用：DescribeDatabaseAuditRecords。

名称	类型	描述
OsUser	String	查询用户 示例值：test_user
InitialQueryId	String	查询ID 示例值：xasdxadsfa-12331x-xqwex
Sql	String	SQL语句 示例值：select * from test
QueryStartTime	String	开始时间 示例值：2025-01-02 12:23:45
DurationMs	Integer	执行耗时 示例值：289
ReadRows	Integer	读取行数 示例值：246872
ResultRows	Integer	读取字节数 示例值：186
ResultBytes	Integer	结果字节数 示例值：389547
MemoryUsage	Integer	内存 示例值：365
InitialAddress	String	初始查询IP 示例值：192.168.13.23
DbName	String	数据库 示例值：test_db
SqlType	String	sql类型 示例值：INSERT
Catalog	String	catalog名称 示例值：Catalog
State	String	状态 示例值：EOF
IsQuery	Boolean	是否是查询 示例值：true

DiskSpec

磁盘规格描述

被如下接口引用：DescribeSpec。

名称	类型	必选	描述
DiskType	String	是	磁盘类型，例如“CLOUD_SSD", "LOCAL_SSD"等 示例值：CLOUD_SSD
DiskDesc	String	是	磁盘类型说明，例如"云SSD", "本地SSD"等 示例值：云SSD
MinDiskSize	Integer	是	磁盘最小规格大小，单位G 示例值：100
MaxDiskSize	Integer	是	磁盘最大规格大小，单位G 示例值：100000
DiskCount	Integer	是	磁盘数目 示例值：10

DorisSourceInfo

外部doris集群的连接信息

被如下接口引用：CreateBackUpSchedule, DescribeBackUpJob, DescribeBackUpTables。

名称	类型	必选	描述
Host	String	否	doris集群的fe的ip 示例值：127.0.0.1
Port	Integer	否	doris集群的fe的端口号 示例值：9030
User	String	否	doris集群的账号 示例值：root
Password	String	否	base64编码的doris集群对应用户的密码 示例值：dasd***asdas

FrontEndRule

前端规则描述

被如下接口引用：DescribeAreaRegion。

名称	类型	描述
ID	Integer	id序列 示例值：1
Name	String	规则名称 示例值：promforbidden
Rule	String	详细规则 示例值：["ap-guangzhou"]

InstanceConfigItem

KV配置

被如下接口引用：ModifyInstanceKeyValConfigs。

名称	类型	必选	描述
ConfKey	String	是	key 示例值：conf_key
ConfValue	String	是	value 示例值：conf_value

InstanceDetail

Instance表detail字段

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

名称	类型	必选	描述
EnableAlarmStrategy	Boolean	否	告警策略是否可用 示例值：bool

InstanceInfo

实例描述信息

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

名称	类型	描述
InstanceId	String	集群实例ID, "cdw-xxxx" 字符串类型 示例值：cdwch-xxxxxxxx
InstanceName	String	集群实例名称 示例值：clickhouse集群
Status	String	状态, Init 创建中; Serving 运行中； Deleted已销毁；Deleting 销毁中； Modify 集群变更中； 示例值：Running
Version	String	版本 示例值：20.7.2.30
Region	String	地域, ap-guangzhou 示例值：ap-guangzhou
Zone	String	可用区， ap-guangzhou-3 示例值：ap-guangzhou-3
VpcId	String	私有网络名称 示例值：vpc-xxxxxx
SubnetId	String	子网名称 示例值：subnet-xxxxx
PayMode	String	付费类型，"hour", "prepay" 示例值：hour
CreateTime	String	创建时间 示例值：2020-01-01 11:11:11
ExpireTime	String	过期时间 示例值：2020-02-01 11:11:11
MasterSummary	NodesSummary	数据节点描述信息
CoreSummary	NodesSummary	zookeeper节点描述信息
HA	String	高可用，“true" "false" 示例值：false
HaType	Integer	高可用类型： 0：非高可用 1：读高可用 2：读写高可用。 示例值：1
AccessInfo	String	访问地址，例如 "10.0.0.1:9000" 示例值："10.0.0.1:9000"
Id	Integer	记录ID，数值型 示例值：1
RegionId	Integer	regionId, 表示地域 示例值：1
ZoneDesc	String	可用区说明，例如 "广州二区" 示例值：广州三区
FlowMsg	String	错误流程说明信息 示例值：error message
StatusDesc	String	状态描述，例如“运行中”等 示例值：运行中
RenewFlag	Boolean	自动续费标记 示例值：false
Tags	Array of Tag	标签列表
Monitor	String	监控信息 示例值：prom-aaaaa
HasClsTopic	Boolean	是否开通日志 示例值：true
ClsTopicId	String	日志主题ID 示例值：zxdasd-asdasd
ClsLogSetId	String	日志集ID 示例值：seqeas-123q1
EnableXMLConfig	Integer	是否支持xml配置管理 示例值：1
RegionDesc	String	区域 示例值：广州
Eip	String	弹性网卡地址 示例值：127.0.0.1
CosMoveFactor	Integer	冷热分层系数 示例值：20
Kind	String	external/local/yunti 示例值：yunti
CosBucketName	String	cos桶 示例值：bucketName-cos-apps-cq-12382198
CanAttachCbs	Boolean	cbs 示例值：true
BuildVersion	String	小版本 示例值：1.2.3
Components	String	组件信息 注：这里返回类型实际为map[string]struct类型，并非显示的string类型，可以参考“示例值”进行数据的解析。 示例值：{ "BE": { "name": "BE", "version": "1.0" } }
Characteristic	Array of String	页面特性，用于前端屏蔽一些页面入口 示例值：["catalog","xx"]
RestartTimeout	String	超时时间 单位s 示例值：36000
GraceShutdownWaitSeconds	String	内核优雅重启超时时间，如果为-1说明未设置 示例值：-1
CaseSensitive	Integer	表名大小写是否敏感，0：敏感；1：不敏感，以小写进行比较；2：不敏感，表名改为以小写存储 示例值：0
IsWhiteSGs	Boolean	用户是否可以绑定安全组 示例值：true
BindSGs	Array of String	已绑定的安全组信息 示例值：["sg-dasda"]
EnableMultiZones	Boolean	是否为多可用区 示例值：false
UserNetworkInfos	String	用户可用区和子网信息 示例值：subnet-dasd1
EnableCoolDown	Integer	是否启用冷热分层。0：未开启 1：已开启 示例值：0
CoolDownBucket	String	冷热分层使用COS桶 示例值：bucketName-cos-apps-cq-12382198
Details	InstanceDetail	实例扩展信息
EnableDlc	Integer	是否启用DLC 0:关闭 1:开启 示例值：0
AccountType	Integer	账户类型 0:普通用户 1:CAM用户 示例值：0
MonitorMode	Integer	监控模式 0: 老监控 1：新监控 示例值：0
CNSummary	NodesSummary	cn节点信息

InstanceNode

实例节点描述信息

被如下接口引用：DescribeInstanceNodes。

名称	类型	描述
Ip	String	IP地址 示例值：10.0.0.1
Spec	String	机型，如 S1 示例值：SCH1
Core	Integer	cpu核数 示例值：2
Memory	Integer	内存大小 示例值：4
DiskType	String	磁盘类型 示例值：CLOUD_HSSD
DiskSize	Integer	磁盘大小 示例值：100
Role	String	所属clickhouse cluster名称 示例值：default_cluster
Status	String	状态 示例值：serving
Rip	String	rip 示例值：10.0.0.2
FeRole	String	FE节点角色 示例值：leader
UUID	String	UUID 示例值：2e8ed58d-bbf8-48f2-bfa6-3c5b3f4b9xas
Zone	String	可用区 示例值：ap-guangzhou-5
CreateTime	String	创建时间 示例值：2024-12-16 12:23:11

InstanceOperation

集群操作描述

被如下接口引用：DescribeInstanceOperations。

名称	类型	描述
Name	String	操作名称，例如“create_instance"、“scaleout_instance”等 示例值：create_instance
Result	String	操作结果，“Success"表示成功，”Fail"表示失败 示例值：Success
Desc	String	操作名称描述，例如“创建”，“修改集群名称”等 示例值：创建
Level	String	操作级别，例如“Critical", "Normal"等 示例值：Normal
LevelDesc	String	操作级别描述，例如“高危”，“一般”等 示例值：一般
StartTime	String	操作开始时间 示例值：2025-01-14 14:40:01
EndTime	String	操作结束时间 示例值：2025-01-14 15:40:01
ResultDesc	String	操作结果描述，例如“成功”，“失败” 示例值：成功
OperateUin	String	操作用户ID 示例值：100025004453
JobId	Integer	操作对应的jobid 示例值：31
OperationDetail	String	操作明细 示例值：创建集群：FE节点3个/4核16G/增强型SSD云硬盘200GB,BE节点3个/4核16G/增强型SSD云硬盘200GB

NetworkInfo

网络信息

被如下接口引用：CreateInstanceNew。

名称	类型	必选	描述
Zone	String	否	可用区 示例值：ap-guangzhou-1
SubnetId	String	否	子网id 示例值：subnet-xxxxxxx
SubnetIpNum	Integer	否	当前子网可用ip数 示例值：20

NodeInfo

NodeInfo

被如下接口引用：DescribeInstanceNodesInfo。

名称	类型	描述
Ip	String	用户IP 示例值：10.0.0.1
Status	Integer	节点状态 示例值：1
NodeName	String	节点角色名 示例值：MASTER
ComponentName	String	组件名 示例值：FE
NodeRole	String	节点角色 示例值：core
LastRestartTime	String	节点上次重启的时间 示例值：2025-01-13 20:03:04
Zone	String	节点所在可用区 示例值：ap-chongqing-1
Id	String	Id 示例值：jinx1

NodeInfos

节点信息列表

被如下接口引用：DescribeInstanceNodesRole, ModifyNodeStatus。

名称	类型	必选	描述
NodeName	String	否	节点名称 示例值："BE"
Status	Integer	否	节点状态 示例值：1
Ip	String	否	节点ip 示例值："192.168.0.1"
NodeRole	String	否	节点角色 示例值："CORE”
ComponentName	String	否	组件名 示例值："FE"
LastRestartTime	String	否	上一次重启时间 示例值："2021-02-12"
Id	String	否	id 示例值：id
Zone	String	否	可用区 示例值：ap-guangzhou-3
CreateTime	String	否	创建时间 示例值：2024-12-16 12:23:13

NodesSummary

节点角色描述信息

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

名称	类型	必选	描述
Spec	String	否	机型，如 S1 示例值：S_4_16_H
NodeSize	Integer	否	节点数目 示例值：1
Core	Integer	否	cpu核数，单位个 示例值：2
Memory	Integer	否	内存大小，单位G 示例值：4
Disk	Integer	否	磁盘大小，单位G 示例值：100
DiskType	String	否	磁盘类型 示例值：SSD
DiskDesc	String	否	磁盘描述 示例值：云硬盘
AttachCBSSpec	AttachCBSSpec	否	挂载云盘信息
SubProductType	String	否	子产品名称 示例值：cdwdoris
SpecCore	Integer	否	规格核数 示例值：2
SpecMemory	Integer	否	规格内存 示例值：4
DiskCount	Integer	否	磁盘大小 示例值：10
Encrypt	Integer	否	是否加密 示例值：1
MaxDiskSize	Integer	否	最大磁盘 示例值：10000

RegionAreaInfo

可用区的地域大类描述

被如下接口引用：DescribeAreaRegion。

名称	类型	描述
Name	String	大类地域信息，如"south_china", "east_china"等 示例值：cdwch-xxxx
Desc	String	对应Name的描述，例如“华南地区”，“华东地区”等 示例值：cdwch-xxxx
Regions	Array of RegionInfo	具体地域列表1 示例值：cdwch-xxxx

RegionInfo

地域描述信息

被如下接口引用：DescribeAreaRegion。

名称	类型	描述
Name	String	地域名称，例如“ap-guangzhou" 示例值：ap-guangzhou
Desc	String	地域描述，例如"广州” 示例值：广州地域
RegionId	Integer	地域唯一标记 示例值：1
Zones	Array of ZoneInfo	地域下所有可用区列表
Count	Integer	该地域下集群数目 示例值：2
IsInternationalSite	Integer	0代表是国际站 1代表不是 示例值：1
Bucket	String	桶 示例值：gz-bucket-1

ResourceSpec

资源规格描述信息

被如下接口引用：DescribeSpec。

名称	类型	描述
Name	String	规格名称，例如“SCH1" 示例值：SCH1
Cpu	Integer	cpu核数 示例值：4
Mem	Integer	内存大小，单位G 示例值：16
Type	String	分类标记，STANDARD/BIGDATA/HIGHIO分别表示标准型/大数据型/高IO 示例值：STANDARD
SystemDisk	DiskSpec	系统盘描述信息 示例值：复杂结构
DataDisk	DiskSpec	数据盘描述信息 示例值：复杂结构
MaxNodeSize	Integer	最大节点数目限制 示例值：50
Available	Boolean	是否可用，false代表售罄 示例值：true
ComputeSpecDesc	String	规格描述信息 示例值：2核4G
InstanceQuota	Integer	cvm库存 示例值：1

RestoreStatus

恢复任务信息

被如下接口引用：DescribeRestoreTaskDetail。

名称	类型	描述
JobId	Integer	恢复任务id 示例值：10513
Label	String	恢复任务标签 示例值：snapshot-xxx-abc
Timestamp	String	恢复任务时间戳 示例值：2022-06-24-15-56-38
DbName	String	恢复任务所在库 示例值：default_cluster:abc
State	String	恢复任务状态 示例值：FINISHED
AllowLoad	Boolean	恢复时是否允许导入 示例值：false
ReplicationNum	String	副本数 示例值：1
ReplicaAllocation	String	副本数 示例值：tag.location.default: 1
RestoreObjects	String	恢复对象 示例值：{"name":"snapshot_**","database":"**","backup_time":1705558619111,"content":"ALL","olap_table_list":[{"name":"**","partition_names":["**"]}],"view_list":[],"odbc_table_list":[],"odbc_resource_list":[]}
CreateTime	String	创建时间 示例值：2022-06-24 16:36:38
MetaPreparedTime	String	元数据准备时间 示例值：2022-06-24 16:36:38
SnapshotFinishedTime	String	快照结束时间 示例值：2022-06-24 16:36:38
DownloadFinishedTime	String	下载结束时间 示例值：2022-06-24 16:36:38
FinishedTime	String	结束时间 示例值：2022-06-24 16:36:38
UnfinishedTasks	String	未完成任务 示例值：12550=10003, 12551=10003, 12552=10003, 12553=10004, 12554=10004, 12555=10004, 12556=10005, 12557=10005, 12558=10005
Progress	String	进度 示例值：20
TaskErrMsg	String	错误信息 示例值：error
Status	String	状态 示例值：[OK]
Timeout	Integer	作业超时时间 示例值：80
ReserveReplica	Boolean	是否保持源表中的副本数 示例值：false
ReserveDynamicPartitionEnable	Boolean	是否保持源表中的动态分区 示例值：false
BackupJobId	Integer	备份实例id 示例值：6331
TaskId	Integer	实例对应snapshot的id 示例值：56332

ScheduleInfo

调度信息

被如下接口引用：CreateBackUpSchedule。

名称	类型	必选	描述
EffectivePeriod	String	否	生效周期 示例值：2023-09-07 00:00:00~2023-09-21 00:00:00
ScheduleType	String	否	调度类型，不传该参数时为立即执行： Day-天 Week-周 Month-月 Once-单次 示例值：Day
ScheduleData	String	否	执行调度的日期。调度类型为周和月时以英文逗号分隔； 调度类型为单次时，该值是个日期 示例值：3,4,5
ScheduleHour	Integer	否	执行时间：时 示例值：11
ScheduleMin	Integer	否	执行时间：分 示例值：30
BackupScope	String	否	备份粒度： All-全量 Database-按库 Table-按表 示例值：All
BackupDatabase	String	否	备份库：如果是按库备份，则需要该字段，库之间用英文逗号分割 示例值：demo1,demo2

SearchTags

列表页搜索的标记列表

被如下接口引用：DescribeInstances。

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

SlowQueryRecord

慢查询记录

被如下接口引用：DescribeSlowQueryRecords。

名称	类型	描述
OsUser	String	查询用户 示例值：db_user
InitialQueryId	String	查询ID 示例值：asddf-xxx-12xas
Sql	String	SQL语句 示例值：select * from test1
QueryStartTime	String	开始时间 示例值：2025-01-02 12:11:34
DurationMs	Integer	执行耗时 示例值：120
ReadRows	Integer	读取行数 示例值：153
ResultRows	Integer	读取字节数 示例值：365
ResultBytes	Integer	结果字节数 示例值：23789476
MemoryUsage	Integer	内存 示例值：125
InitialAddress	String	初始查询IP 示例值：192.168.15.11
DbName	String	数据库名 示例值：test_db
IsQuery	Integer	是否是查询，0：否，1：查询语句 示例值：1
ResultBytesMB	Float	ResultBytes的MB格式 示例值：3.415
MemoryUsageMB	Float	MemoryUsage的MB表示 示例值：99.863
DurationSec	Float	DurationMs的秒表示 示例值：0.361
State	String	状态 示例值：OK
CatalogName	String	Catalog Name 示例值：catalog1
CpuTimeMs	Integer	cpu执行时间 示例值：1236

Tag

标签描述

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

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

UpdateUserPrivileges

更新用户权限结构体

被如下接口引用：ModifyUserPrivilegesV3。

名称	类型	必选	描述
IsSetGlobalCatalog	Boolean	否	是否设置catalog权限 示例值：true

UserInfo

新增或是修改用户

被如下接口引用：ActionAlterUser。

名称	类型	必选	描述
InstanceId	String	是	集群实例id 示例值：cdwch-xxxx
UserName	String	是	用户名 示例值：username1
PassWord	String	是	密码 示例值：pwd1
WhiteHost	String	否	用户链接来自的 IP 示例值：10.0.2.123
OldWhiteHost	String	否	修改前用户链接来自的 IP 示例值：10.0.2.1
Describe	String	否	描述 示例值："this is user desc"
OldPwd	String	否	旧密码 示例值：pwd—***
CamUin	String	否	绑定的子用户uin 示例值：123124123
CamRangerGroupIds	Array of Integer	否	ranger group id列表 示例值：1

UserWorkloadGroup

用户绑定资源组信息

被如下接口引用：DescribeUserBindWorkloadGroup。

名称	类型	必选	描述
UserName	String	否	test 示例值：用户名
WorkloadGroupName	String	否	normal 示例值：资源组名称

WorkloadGroupConfig

资源组相关配置

被如下接口引用：CreateWorkloadGroup, DescribeWorkloadGroup, ModifyWorkloadGroup。

名称	类型	必选	描述
WorkloadGroupName	String	否	资源组名称 示例值：test1
CpuShare	Integer	否	CPU权重 示例值：10
MemoryLimit	Integer	否	内存限制，所有资源组的内存限制值之和应该小于等于100 示例值：20
EnableMemoryOverCommit	Boolean	否	是否允许超配分配 示例值：false
CpuHardLimit	String	否	cpu硬限制 示例值：30%

ZoneInfo

可用区描述信息

被如下接口引用：DescribeAreaRegion。

名称	类型	描述
Name	String	可用区名称，例如"ap-guangzhou-1" 示例值：ap-shanghai-2
Desc	String	可用区描述信息，例如“广州一区” 示例值：上海二区
ZoneId	Integer	可用区唯一标记 示例值：200002
Encrypt	Integer	Encryptid 示例值：1
Main	Boolean	是否为主力园区 示例值：true