AttachCBSSpec
集群内节点的规格磁盘规格描述
被如下接口引用:DescribeInstance, DescribeInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DiskType | String | 否 | 节点磁盘类型,例如“CLOUD_SSD”"CLOUD_PREMIUM" |
DiskSize | Integer | 否 | 磁盘容量,单位G |
DiskCount | Integer | 否 | 磁盘总数 |
DiskDesc | String | 否 | 描述 |
BackUpJobDisplay
备份实例详情
被如下接口引用:DescribeBackUpJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
JobId | Integer | 否 | 备份实例id 示例值:123 |
Snapshot | String | 否 | 备份实例名 示例值:"XXX" |
BackUpSize | Integer | 否 | 备份数据量 示例值:123 |
BackUpSingleSize | Integer | 否 | 备份单副本数据量 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
BackUpTime | String | 否 | 实例创建时间 示例值:"2021-09-18 00:12:23" |
ExpireTime | String | 否 | 实例过期时间 示例值:"2021-09-18 00:12:23" |
JobStatus | String | 否 | 实例状态 示例值:"jing" |
BackupType | Integer | 否 | 0为默认。1时是对远端的doris进行备份,不周期,一次性 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
BackupTimeType | Integer | 否 | 0为默认。1时是立即备份。2时是迁移 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DorisSourceInfo | DorisSourceInfo | 否 | 远端doris的连接信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:{} |
JobStatusNum | Integer | 否 | 实例状态对应的数值 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
BackupCosInfo | BackupCosInfo | 否 | 备份实例中关于cos的信息 注意:此字段可能返回 null,表示取不到有效值。 |
BackupCosInfo
备份实例中关于cos的信息
被如下接口引用:DescribeBackUpJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CosBucket | String | 否 | 备份文件所在的cos桶 注意:此字段可能返回 null,表示取不到有效值。 |
CosPath | String | 否 | 备份文件所在的完整cos路径 注意:此字段可能返回 null,表示取不到有效值。 |
SnapShotPath | String | 否 | 备份文件名称 注意:此字段可能返回 null,表示取不到有效值。 |
BackupStatus
备份任务的进度详情
被如下接口引用:DescribeBackUpTaskDetail。
名称 | 类型 | 描述 |
---|---|---|
JobId | Integer | 备份任务id 示例值:1 |
SnapshotName | String | 快照名称 示例值:snapshot-xxx-abc |
DbName | String | 库名 示例值:abc |
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 | 未完成任务 示例值: a |
Progress | String | 进度 示例值: 20 |
TaskErrMsg | String | 错误信息 示例值: error |
Status | String | 状态 示例值:[OK] |
Timeout | Integer | 超时信息 示例值:111 |
BackupJobId | Integer | 备份实例id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
TaskId | Integer | 实例对应snapshoit的id 注意:此字段可能返回 null,表示取不到有效值。 示例值:2221 |
BackupTableContent
备份表信息
被如下接口引用:CreateBackUpSchedule, DescribeBackUpJobDetail, DescribeBackUpTables。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Database | String | 是 | 数据库 注意:此字段可能返回 null,表示取不到有效值。 示例值:"123" |
Table | String | 是 | 表 注意:此字段可能返回 null,表示取不到有效值。 示例值:"123" |
TotalBytes | Integer | 是 | 表总字节数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1234 |
SingleReplicaBytes | String | 否 | 表单个副本的大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
BackupStatus | Integer | 否 | 备份状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
BackupErrorMsg | String | 否 | 备份的错误信息 注意:此字段可能返回 null,表示取不到有效值。 |
IsOpenCoolDown | Boolean | 否 | 改库表是否绑定降冷策略 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
BindUser
资源组绑定的用户信息,需要username和host信息进行授权
被如下接口引用:ModifyUserBindWorkloadGroup。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
UserName | String | 否 | 用户名 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
Host | String | 否 | 主机信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:% |
ChargeProperties
集群计费相关信息
被如下接口引用:CreateInstanceNew。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ChargeType | String | 否 | 计费类型,“PREPAID” 预付费,“POSTPAID_BY_HOUR” 后付费 注意:此字段可能返回 null,表示取不到有效值。 |
RenewFlag | Integer | 否 | 是否自动续费,1表示自动续费开启 注意:此字段可能返回 null,表示取不到有效值。 |
TimeSpan | Integer | 否 | 计费时间长度 注意:此字段可能返回 null,表示取不到有效值。 |
TimeUnit | String | 否 | 计费时间单位,“m”表示月等 注意:此字段可能返回 null,表示取不到有效值。 |
ClusterConfigsHistory
集群的配置文件的修改历史
被如下接口引用:DescribeClusterConfigsHistory。
名称 | 类型 | 描述 |
---|---|---|
FileName | String | 配置文件名称 示例值:config.xml |
NewConfValue | String | 修改后的配置文件内容,base64编码 示例值:PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHlhbmRleD4K |
OldConfValue | String | 修改前的配置文件内容,base64编码 示例值:PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHlhbmRleD4K |
Remark | String | 修改原因 注意:此字段可能返回 null,表示取不到有效值。 示例值:为了修改配置 |
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 | 配置文件路径 注意:此字段可能返回 null,表示取不到有效值。 示例值::"/usr/local/service/doris/conf" |
FileKeyValuesNew | Array of ConfigKeyValue | 配置文件kv值 注意:此字段可能返回 null,表示取不到有效值。 |
ConfigKeyValue
返回配置的文件内容(key-value)
被如下接口引用:DescribeClusterConfigs。
名称 | 类型 | 描述 |
---|---|---|
KeyName | String | key 注意:此字段可能返回 null,表示取不到有效值。 |
Value | String | 值 注意:此字段可能返回 null,表示取不到有效值。 |
Message | String | 备注 注意:此字段可能返回 null,表示取不到有效值。 |
Display | Integer | 1-只读,2-可修改但不可删除,3-可删除 注意:此字段可能返回 null,表示取不到有效值。 |
SupportHotUpdate | Integer | 0不支持 1支持热更新 注意:此字段可能返回 null,表示取不到有效值。 |
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 注意:此字段可能返回 null,表示取不到有效值。 |
DataUsedCapacity | String | 否 | 字段:DataUsedCapacity 注意:此字段可能返回 null,表示取不到有效值。 |
TotalCapacity | String | 否 | 字段:TotalCapacity 注意:此字段可能返回 null,表示取不到有效值。 |
RemoteUsedCapacity | String | 否 | 字段:RemoteUsedCapacity 注意:此字段可能返回 null,表示取不到有效值。 |
CoolDownPolicyInfo
冷热分层策略
被如下接口引用:DescribeCoolDownPolicies。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
PolicyName | String | 否 | 策略名称 注意:此字段可能返回 null,表示取不到有效值。 |
CooldownDatetime | String | 否 | cooldown_ttl 注意:此字段可能返回 null,表示取不到有效值。 |
CooldownTtl | String | 否 | cooldown_datetime 注意:此字段可能返回 null,表示取不到有效值。 |
CoolDownTableDataInfo
冷热分层Table数据信息
被如下接口引用:DescribeCoolDownTableData。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DatabaseName | String | 否 | 列:DatabaseName 注意:此字段可能返回 null,表示取不到有效值。 |
TableName | String | 否 | 列:TableName 注意:此字段可能返回 null,表示取不到有效值。 |
Size | String | 否 | 列:Size 注意:此字段可能返回 null,表示取不到有效值。 |
RemoteSize | String | 否 | 列:RemoteSize 注意:此字段可能返回 null,表示取不到有效值。 |
CosSourceInfo
客户提供cos认证信息。
被如下接口引用:CreateBackUpSchedule, DescribeBackUpTables, RecoverBackUpJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
SecretId | String | 否 | cos认证中的Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc |
SecretKey | String | 否 | cos认证中的key 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc |
CosPath | String | 否 | cos认证中的路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc |
CreateInstanceSpec
集群规格
被如下接口引用:CreateInstanceNew。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
SpecName | String | 是 | 规格名字 |
Count | Integer | 是 | 数量 |
DiskSize | Integer | 是 | 云盘大小 |
DataBaseAuditRecord
数据库审计
被如下接口引用:DescribeDatabaseAuditRecords。
名称 | 类型 | 描述 |
---|---|---|
OsUser | String | 查询用户 注意:此字段可能返回 null,表示取不到有效值。 |
InitialQueryId | String | 查询ID 注意:此字段可能返回 null,表示取不到有效值。 |
Sql | String | SQL语句 注意:此字段可能返回 null,表示取不到有效值。 |
QueryStartTime | String | 开始时间 注意:此字段可能返回 null,表示取不到有效值。 |
DurationMs | Integer | 执行耗时 注意:此字段可能返回 null,表示取不到有效值。 |
ReadRows | Integer | 读取行数 注意:此字段可能返回 null,表示取不到有效值。 |
ResultRows | Integer | 读取字节数 注意:此字段可能返回 null,表示取不到有效值。 |
ResultBytes | Integer | 结果字节数 注意:此字段可能返回 null,表示取不到有效值。 |
MemoryUsage | Integer | 内存 注意:此字段可能返回 null,表示取不到有效值。 |
InitialAddress | String | 初始查询IP 注意:此字段可能返回 null,表示取不到有效值。 |
DbName | String | 数据库 注意:此字段可能返回 null,表示取不到有效值。 |
SqlType | String | sql类型 注意:此字段可能返回 null,表示取不到有效值。 |
Catalog | String | catalog名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxx |
DiskSpec
磁盘规格描述
被如下接口引用:DescribeSpec。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DiskType | String | 是 | 磁盘类型,例如“CLOUD_SSD", "LOCAL_SSD"等 |
DiskDesc | String | 是 | 磁盘类型说明,例如"云SSD", "本地SSD"等 |
MinDiskSize | Integer | 是 | 磁盘最小规格大小,单位G |
MaxDiskSize | Integer | 是 | 磁盘最大规格大小,单位G |
DiskCount | Integer | 是 | 磁盘数目 |
DorisSourceInfo
外部doris集群的连接信息
被如下接口引用:CreateBackUpSchedule, DescribeBackUpJob, DescribeBackUpTables。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Host | String | 否 | doris集群的fe的ip 注意:此字段可能返回 null,表示取不到有效值。 示例值:127.0.0.1 |
Port | Integer | 否 | doris集群的fe的端口号 注意:此字段可能返回 null,表示取不到有效值。 示例值:9030 |
User | String | 否 | doris集群的账号 注意:此字段可能返回 null,表示取不到有效值。 示例值:root |
Password | String | 否 | base64编码的doris集群对应用户的密码 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxx |
FrontEndRule
前端规则描述
被如下接口引用:DescribeAreaRegion。
名称 | 类型 | 描述 |
---|---|---|
ID | Integer | id序列 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Name | String | 规则名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:promforbidden |
Rule | String | 详细规则 注意:此字段可能返回 null,表示取不到有效值。 示例值:["ap-guangzhou"] |
InstanceConfigItem
KV配置
被如下接口引用:ModifyInstanceKeyValConfigs。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ConfKey | String | 是 | key 示例值:x |
ConfValue | String | 是 | value 示例值:x |
InstanceDetail
Instance表detail字段
被如下接口引用:DescribeInstance, DescribeInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
EnableAlarmStrategy | Boolean | 否 | 告警策略是否可用 注意:此字段可能返回 null,表示取不到有效值。 示例值:bool |
InstanceInfo
实例描述信息
被如下接口引用:DescribeInstance, DescribeInstances。
名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 集群实例ID, "cdw-xxxx" 字符串类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:cdwch-xxxxxxxx |
InstanceName | String | 集群实例名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:clickhouse集群 |
Status | String | 状态, Init 创建中; Serving 运行中; Deleted已销毁;Deleting 销毁中; Modify 集群变更中; 注意:此字段可能返回 null,表示取不到有效值。 示例值:Running |
Version | String | 版本 注意:此字段可能返回 null,表示取不到有效值。 示例值:20.7.2.30 |
Region | String | 地域, ap-guangzhou 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-guangzhou |
Zone | String | 可用区, ap-guangzhou-3 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-guangzhou-3 |
VpcId | String | 私有网络名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:vpc-xxxxxx |
SubnetId | String | 子网名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:subnet-xxxxx |
PayMode | String | 付费类型,"hour", "prepay" 注意:此字段可能返回 null,表示取不到有效值。 示例值:hour |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2020-01-01 11:11:11 |
ExpireTime | String | 过期时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2020-02-01 11:11:11 |
MasterSummary | NodesSummary | 数据节点描述信息 注意:此字段可能返回 null,表示取不到有效值。 |
CoreSummary | NodesSummary | zookeeper节点描述信息 注意:此字段可能返回 null,表示取不到有效值。 |
HA | String | 高可用,“true" "false" 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
HaType | Integer | 高可用类型: 0:非高可用 1:读高可用 2:读写高可用。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
AccessInfo | String | 访问地址,例如 "10.0.0.1:9000" 注意:此字段可能返回 null,表示取不到有效值。 示例值:"10.0.0.1:9000" |
Id | Integer | 记录ID,数值型 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RegionId | Integer | regionId, 表示地域 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ZoneDesc | String | 可用区说明,例如 "广州二区" 注意:此字段可能返回 null,表示取不到有效值。 示例值:广州三区 |
FlowMsg | String | 错误流程说明信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
StatusDesc | String | 状态描述,例如“运行中”等 注意:此字段可能返回 null,表示取不到有效值。 示例值:运行中 |
RenewFlag | Boolean | 自动续费标记 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
Tags | Array of Tag | 标签列表 注意:此字段可能返回 null,表示取不到有效值。 |
Monitor | String | 监控信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:prom-aaaaa |
HasClsTopic | Boolean | 是否开通日志 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
ClsTopicId | String | 日志主题ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxx |
ClsLogSetId | String | 日志集ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxx |
EnableXMLConfig | Integer | 是否支持xml配置管理 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RegionDesc | String | 区域 注意:此字段可能返回 null,表示取不到有效值。 示例值:广州 |
Eip | String | 弹性网卡地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:127.0.0.1 |
CosMoveFactor | Integer | 冷热分层系数 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
Kind | String | external/local/yunti 注意:此字段可能返回 null,表示取不到有效值。 示例值:yunti |
CosBucketName | String | cos桶 注意:此字段可能返回 null,表示取不到有效值。 |
CanAttachCbs | Boolean | cbs 注意:此字段可能返回 null,表示取不到有效值。 |
BuildVersion | String | 小版本 注意:此字段可能返回 null,表示取不到有效值。 |
Components | String | 组件信息 注:这里返回类型实际为map[string]struct类型,并非显示的string类型,可以参考“示例值”进行数据的解析。 注意:此字段可能返回 null,表示取不到有效值。 示例值:{ "BE": { "name": "BE", "version": "1.0" } } |
Characteristic | Array of String | 页面特性,用于前端屏蔽一些页面入口 注意:此字段可能返回 null,表示取不到有效值。 示例值:["catalog","xx"] |
RestartTimeout | String | 超时时间 单位s 注意:此字段可能返回 null,表示取不到有效值。 |
GraceShutdownWaitSeconds | String | 内核优雅重启超时时间,如果为-1说明未设置 注意:此字段可能返回 null,表示取不到有效值。 |
CaseSensitive | Integer | 表名大小写是否敏感,0:敏感;1:不敏感,以小写进行比较;2:不敏感,表名改为以小写存储 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
IsWhiteSGs | Boolean | 用户是否可以绑定安全组 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
BindSGs | Array of String | 已绑定的安全组信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:["sg-dasda"] |
EnableMultiZones | Boolean | 是否为多可用区 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
UserNetworkInfos | String | 用户可用区和子网信息 注意:此字段可能返回 null,表示取不到有效值。 |
EnableCoolDown | Integer | 是否启用冷热分层。0:未开启 1:已开启 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
CoolDownBucket | String | 冷热分层使用COS桶 注意:此字段可能返回 null,表示取不到有效值。 |
Details | InstanceDetail | 实例扩展信息 注意:此字段可能返回 null,表示取不到有效值。 |
EnableDlc | Integer | 是否启用DLC 0:关闭 1:开启 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
AccountType | Integer | 账户类型 0:普通用户 1:CAM用户 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
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 | 状态 注意:此字段可能返回 null,表示取不到有效值。 |
Rip | String | rip 注意:此字段可能返回 null,表示取不到有效值。 |
FeRole | String | FE节点角色 注意:此字段可能返回 null,表示取不到有效值。 示例值:leader |
UUID | String | UUID 注意:此字段可能返回 null,表示取不到有效值。 示例值:2e8ed58d-bbf8-48f2-bfa6-3c5b3f4b9xas |
InstanceOperation
集群操作描述
被如下接口引用:DescribeInstanceOperations。
名称 | 类型 | 描述 |
---|---|---|
Name | String | 操作名称,例如“create_instance"、“scaleout_instance”等 示例值:- |
Result | String | 操作结果,“Success"表示成功,”Fail"表示失败 示例值:- |
Desc | String | 操作名称描述,例如“创建”,“修改集群名称”等 示例值:- |
Level | String | 操作级别,例如“Critical", "Normal"等 示例值:- |
LevelDesc | String | 操作级别描述,例如“高危”,“一般”等 示例值:- |
StartTime | String | 操作开始时间 示例值:- |
EndTime | String | 操作结束时间 示例值:- |
ResultDesc | String | 操作结果描述,例如“成功”,“失败” 示例值:- |
OperateUin | String | 操作用户ID 示例值:- |
JobId | Integer | 操作对应的jobid 示例值:- |
OperationDetail | String | 操作明细 |
NetworkInfo
网络信息
被如下接口引用:CreateInstanceNew。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Zone | String | 否 | 可用区 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-guangzhou-1 |
SubnetId | String | 否 | 子网id 注意:此字段可能返回 null,表示取不到有效值。 示例值:subnet-xxxxxxx |
SubnetIpNum | Integer | 否 | 当前子网可用ip数 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
NodeInfo
NodeInfo
被如下接口引用:DescribeInstanceNodesInfo。
名称 | 类型 | 描述 |
---|---|---|
Ip | String | 用户IP 注意:此字段可能返回 null,表示取不到有效值。 |
Status | Integer | 节点状态 注意:此字段可能返回 null,表示取不到有效值。 |
NodeName | String | 节点角色名 注意:此字段可能返回 null,表示取不到有效值。 示例值:MASTER |
ComponentName | String | 组件名 注意:此字段可能返回 null,表示取不到有效值。 示例值:FE |
NodeRole | String | 节点角色 注意:此字段可能返回 null,表示取不到有效值。 示例值:core |
LastRestartTime | String | 节点上次重启的时间 注意:此字段可能返回 null,表示取不到有效值。 |
Zone | String | 节点所在可用区 注意:此字段可能返回 null,表示取不到有效值。 |
Id | String | Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
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 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
Zone | String | 否 | 可用区 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-guangzhou-3 |
NodesSummary
节点角色描述信息
被如下接口引用:DescribeInstance, DescribeInstances。
名称 | 类型 | 描述 |
---|---|---|
Spec | String | 机型,如 S1 |
NodeSize | Integer | 节点数目 示例值:1 |
Core | Integer | cpu核数,单位个 示例值:2 |
Memory | Integer | 内存大小,单位G 示例值:4 |
Disk | Integer | 磁盘大小,单位G |
DiskType | String | 磁盘类型 |
DiskDesc | String | 磁盘描述 |
AttachCBSSpec | AttachCBSSpec | 挂载云盘信息 注意:此字段可能返回 null,表示取不到有效值。 |
SubProductType | String | 子产品名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:cdwdoris |
SpecCore | Integer | 规格核数 注意:此字段可能返回 null,表示取不到有效值。 |
SpecMemory | Integer | 规格内存 注意:此字段可能返回 null,表示取不到有效值。 |
DiskCount | Integer | 磁盘大小 注意:此字段可能返回 null,表示取不到有效值。 |
Encrypt | Integer | 是否加密 注意:此字段可能返回 null,表示取不到有效值。 |
MaxDiskSize | Integer | 最大磁盘 注意:此字段可能返回 null,表示取不到有效值。 |
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" |
Desc | String | 地域描述,例如"广州” |
RegionId | Integer | 地域唯一标记 |
Zones | Array of ZoneInfo | 地域下所有可用区列表 注意:此字段可能返回 null,表示取不到有效值。 |
Count | Integer | 该地域下集群数目 |
IsInternationalSite | Integer | 0代表是国际站 1代表不是 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Bucket | String | 桶 注意:此字段可能返回 null,表示取不到有效值。 |
ResourceSpec
资源规格描述信息
被如下接口引用:DescribeSpec。
名称 | 类型 | 描述 |
---|---|---|
Name | String | 规格名称,例如“SCH1" 示例值:SCH1 |
Cpu | Integer | cpu核数 示例值:4 |
Mem | Integer | 内存大小,单位G 示例值:16 |
Type | String | 分类标记,STANDARD/BIGDATA/HIGHIO分别表示标准型/大数据型/高IO 示例值:STANDARD |
SystemDisk | DiskSpec | 系统盘描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:复杂结构 |
DataDisk | DiskSpec | 数据盘描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:复杂结构 |
MaxNodeSize | Integer | 最大节点数目限制 注意:此字段可能返回 null,表示取不到有效值。 示例值:50 |
Available | Boolean | 是否可用,false代表售罄 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
ComputeSpecDesc | String | 规格描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:2核4G |
InstanceQuota | Integer | cvm库存 注意:此字段可能返回 null,表示取不到有效值。 |
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 | 恢复对象 示例值:{} |
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 | 未完成任务 示例值:aa |
Progress | String | 进度 示例值:20 |
TaskErrMsg | String | 错误信息 示例值:error |
Status | String | 状态 示例值:[OK] |
Timeout | Integer | 作业超时时间 示例值:111 |
ReserveReplica | Boolean | 是否保持源表中的副本数 示例值:false |
ReserveDynamicPartitionEnable | Boolean | 是否保持源表中的动态分区 示例值:false |
BackupJobId | Integer | 备份实例id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
TaskId | Integer | 实例对应snapshot的id 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
ScheduleInfo
调度信息
被如下接口引用:CreateBackUpSchedule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
EffectivePeriod | String | 否 | 生效时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-09-07 00:00:00~2023-09-21 00:00:00 |
ScheduleType | String | 否 | 调度类型: Day-天 Week-周 Month-月 Once-单次 注意:此字段可能返回 null,表示取不到有效值。 示例值:Day |
ScheduleData | String | 否 | 执行调度的日期。调度类型为周和月时以英文逗号分隔; 调度类型为单次时,该值是个日期 注意:此字段可能返回 null,表示取不到有效值。 示例值:3,4,5 |
ScheduleHour | Integer | 否 | 执行时间:时 注意:此字段可能返回 null,表示取不到有效值。 示例值:11 |
ScheduleMin | Integer | 否 | 执行时间:分 注意:此字段可能返回 null,表示取不到有效值。 示例值:30 |
BackupScope | String | 否 | 备份粒度: All-全量 Database-按库 Table-按表 注意:此字段可能返回 null,表示取不到有效值。 示例值:All |
BackupDatabase | String | 否 | 备份库:如果是按库备份,则需要该字段,库之间用英文逗号分割 注意:此字段可能返回 null,表示取不到有效值。 示例值:demo1,demo2 |
SearchTags
列表页搜索的标记列表
被如下接口引用:DescribeInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TagKey | String | 否 | 标签的键 示例值:标签一 |
TagValue | String | 否 | 标签的值 示例值:标签值一 |
AllValue | Integer | 否 | 1表示只输入标签的键,没有输入值;非1则表示输入键时且输入值 示例值:1 |
SlowQueryRecord
慢查询记录
被如下接口引用:DescribeSlowQueryRecords。
名称 | 类型 | 描述 |
---|---|---|
OsUser | String | 查询用户 |
InitialQueryId | String | 查询ID |
Sql | String | SQL语句 |
QueryStartTime | String | 开始时间 |
DurationMs | Integer | 执行耗时 |
ReadRows | Integer | 读取行数 |
ResultRows | Integer | 读取字节数 |
ResultBytes | Integer | 结果字节数 |
MemoryUsage | Integer | 内存 |
InitialAddress | String | 初始查询IP |
DbName | String | 数据库名 注意:此字段可能返回 null,表示取不到有效值。 |
IsQuery | Integer | 是否是查询,0:否,1:查询语句 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ResultBytesMB | Float | ResultBytes的MB格式 注意:此字段可能返回 null,表示取不到有效值。 示例值:3.415 |
MemoryUsageMB | Float | MemoryUsage的MB表示 注意:此字段可能返回 null,表示取不到有效值。 示例值:99.863 |
DurationSec | Float | DurationMs的秒表示 注意:此字段可能返回 null,表示取不到有效值。 示例值:0.361 |
State | String | 状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:OK |
CatalogName | String | Catalog Name 注意:此字段可能返回 null,表示取不到有效值。 |
Tag
标签描述
被如下接口引用:CreateInstanceNew, DescribeInstance, DescribeInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TagKey | String | 是 | 标签的键 示例值:标签一 |
TagValue | String | 是 | 标签的值 示例值:内容一 |
UpdateUserPrivileges
更新用户权限结构体
被如下接口引用:ModifyUserPrivilegesV3。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
IsSetGlobalCatalog | Boolean | 否 | 是否设置catalog权限 |
UserInfo
新增或是修改用户
被如下接口引用:ActionAlterUser。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
InstanceId | String | 是 | 集群实例id 示例值:cdwch-xxxx |
UserName | String | 是 | 用户名 示例值:test |
PassWord | String | 是 | 密码 示例值:password |
WhiteHost | String | 否 | 用户链接来自的 IP 示例值:10.0.2.123 |
OldWhiteHost | String | 否 | 修改前用户链接来自的 IP 示例值:10.0.2.1 |
Describe | String | 否 | 描述 示例值:描述 |
OldPwd | String | 否 | 旧密码 示例值:pwd—*** |
CamUin | String | 否 | 绑定的子用户uin 示例值:123124123 |
CamRangerGroupIds | Array of Integer | 否 | ranger group id列表 示例值:[] |
UserWorkloadGroup
用户绑定资源组信息
被如下接口引用:DescribeUserBindWorkloadGroup。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
UserName | String | 否 | test 注意:此字段可能返回 null,表示取不到有效值。 示例值:用户名 |
WorkloadGroupName | String | 否 | normal 注意:此字段可能返回 null,表示取不到有效值。 示例值:资源组名称 |
WorkloadGroupConfig
资源组相关配置
被如下接口引用:CreateWorkloadGroup, DescribeWorkloadGroup, ModifyWorkloadGroup。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
WorkloadGroupName | String | 否 | 资源组名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:test1 |
CpuShare | Integer | 否 | CPU权重 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
MemoryLimit | Integer | 否 | 内存限制,所有资源组的内存限制值之和应该小于等于100 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
EnableMemoryOverCommit | Boolean | 否 | 是否允许超配分配 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
CpuHardLimit | String | 否 | cpu硬限制 注意:此字段可能返回 null,表示取不到有效值。 示例值:30% |
ZoneInfo
可用区描述信息
被如下接口引用:DescribeAreaRegion。
名称 | 类型 | 描述 |
---|---|---|
Name | String | 可用区名称,例如"ap-guangzhou-1" |
Desc | String | 可用区描述信息,例如“广州一区” |
ZoneId | Integer | 可用区唯一标记 |
Encrypt | Integer | Encryptid 注意:此字段可能返回 null,表示取不到有效值。 |
Main | Boolean | 是否为主力园区 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |