AttachCBSSpec
集群内节点的规格磁盘规格描述
被如下接口引用：DescribeInstance, DescribeInstancesNew。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DiskType | String | 否 | 节点磁盘类型，例如“CLOUD_SSD”"CLOUD_PREMIUM" |
| DiskSize | Integer | 否 | 磁盘容量，单位G |
| DiskCount | Integer | 否 | 磁盘总数 |
| DiskDesc | String | 否 | 描述 |
BackUpJobDisplay
备份任务详情
被如下接口引用：DescribeBackUpJob。
| 名称 | 类型 | 描述 |
|---|---|---|
| JobId | Integer | 备份任务id 示例值：任务id |
| Snapshot | String | 备份任务名 示例值："XXX" |
| BackUpType | String | 任务类型(元数据),(数据) 示例值："XXX" |
| BackUpSize | Integer | 备份数据量 示例值：123 |
| BackUpTime | String | 任务创建时间 示例值："2021-09-18 00:12:23" |
| ExpireTime | String | 任务过期时间 示例值："2021-09-18 00:12:23" |
| JobStatus | String | 任务状态 示例值："jing" |
BackupTableContent
备份表信息
被如下接口引用：CreateBackUpSchedule, DescribeBackUpJobDetail, DescribeBackUpSchedule, DescribeBackUpTables。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Database | String | 是 | 数据库 注意：此字段可能返回 null，表示取不到有效值。 示例值："123" |
| Table | String | 是 | 表 注意：此字段可能返回 null，表示取不到有效值。 示例值："123" |
| TotalBytes | Integer | 是 | 表总字节数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1234 |
| VCluster | String | 否 | 虚拟cluster 注意：此字段可能返回 null，表示取不到有效值。 示例值："cluster-XXX" |
| Ips | String | 否 | 表ip 注意：此字段可能返回 null，表示取不到有效值。 示例值："10.0.0.10" |
| ZooPath | String | 否 | zk路径 注意：此字段可能返回 null，表示取不到有效值。 |
| Rip | String | 否 | cvm的ip地址 注意：此字段可能返回 null，表示取不到有效值。 |
Charge
集群计费相关信息
被如下接口引用：CreateInstanceNew。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ChargeType | String | 是 | 计费类型，“PREPAID” 预付费，“POSTPAID_BY_HOUR” 后付费 示例值：PREPAID |
| RenewFlag | Integer | 否 | PREPAID需要传递，是否自动续费，1表示自动续费开启 示例值：1 |
| TimeSpan | Integer | 否 | 预付费需要传递，计费时间长度，多少个月 示例值：1 |
CkUserAlterInfo
新增或是修改ck用户
被如下接口引用：ActionAlterCkUser。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceId | String | 是 | 集群实例id 示例值：cdwch-xxxx |
| UserName | String | 是 | 用户名 示例值：test |
| PassWord | String | 是 | base64加密后的密码 示例值：password |
| Describe | String | 否 | 描述 示例值：描述 |
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，表示取不到有效值。 示例值：/etc/clickhouse-server |
ClusterInfo
clickhouse vcluster信息
被如下接口引用：DescribeInstanceClusters。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClusterName | String | vcluster名字 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxxxx |
| NodeIps | Array of String | 当前cluster的IP列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[] |
ConfigSubmitContext
配置文件修改信息
被如下接口引用：ModifyClusterConfigs。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FileName | String | 是 | 配置文件名称 示例值：config.xml |
| OldConfValue | String | 是 | 配置文件旧内容，base64编码 示例值：PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHlhbmRleD4K |
| NewConfValue | String | 是 | 配置文件新内容，base64编码 示例值：PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHlhbmRleD4K |
| FilePath | String | 否 | 保存配置文件的路径 示例值：/etc/clickhouse-server |
DatabasePrivilegeInfo
数据库权限信息
被如下接口引用：ModifyUserNewPrivilege。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DatabaseName | String | 是 | 数据库名称 示例值：db1 |
| DatabasePrivileges | Array of String | 否 | //库表权限，SELECT、INSERT_ALL、ALTER、TRUNCATE、DROP_TABLE、CREATE_TABLE、DROP_DATABASE 注意：此字段可能返回 null，表示取不到有效值。 示例值：【】 |
| TablePrivilegeList | Array of TablePrivilegeInfo | 否 | // 库下面的表权限 注意：此字段可能返回 null，表示取不到有效值。 示例值：【】 |
DiskSpec
磁盘规格描述
被如下接口引用：DescribeSpec。
| 名称 | 类型 | 描述 |
|---|---|---|
| DiskType | String | 磁盘类型，例如“CLOUD_SSD", "LOCAL_SSD"等 示例值：CLOUD_SSD |
| DiskDesc | String | 磁盘类型说明，例如"云SSD", "本地SSD"等 示例值：本地SSD |
| MinDiskSize | Integer | 磁盘最小规格大小，单位G 示例值：20 |
| MaxDiskSize | Integer | 磁盘最大规格大小，单位G 示例值：100 |
| DiskCount | Integer | 磁盘数目 示例值：10 |
GroupInfo
集群分组信息描述
被如下接口引用：DescribeInstanceNodes。
| 名称 | 类型 | 描述 |
|---|---|---|
| GroupName | String | 分组名称 示例值：default_cluster |
| ShardName | String | 分片变量名称 示例值：shard |
| ReplicaName | String | 副本变量名称 示例值：replica |
InstanceConfigInfo
集群配置信息
被如下接口引用：DescribeInstanceKeyValConfigs。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ConfKey | String | 是 | 配置项名称 示例值：max_connections |
| ConfValue | String | 是 | 配置项内容 示例值：100 |
| DefaultValue | String | 否 | 默认值 示例值：100 |
| NeedRestart | Boolean | 否 | 是否需要重启 示例值：false |
| Editable | Boolean | 否 | 是否可编辑 示例值：true |
| ConfDesc | String | 否 | 配置项解释 示例值：The maximum number of inbound connections. |
| FileName | String | 否 | 文件名称 示例值：config.xml |
| ModifyRuleType | String | 否 | 规则名称类型 示例值：number |
| ModifyRuleValue | String | 否 | 规则名称内容 示例值：bigint |
| Uin | String | 否 | 修改人的uin 示例值：1234567890 |
| ModifyTime | String | 否 | 修改时间 示例值：2021-01-01 11:11:11 |
InstanceConfigItem
KV配置
被如下接口引用：ModifyInstanceKeyValConfigs。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ConfKey | String | 是 | key 示例值：x |
| ConfValue | String | 是 | value 示例值：x |
InstanceDetail
Instance表detail字段
被如下接口引用：DescribeInstance, DescribeInstancesNew。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| EnableAlarmStrategy | Boolean | 否 | 告警策略是否可用 注意：此字段可能返回 null，表示取不到有效值。 示例值：bool |
InstanceInfo
实例描述信息
被如下接口引用：DescribeInstance, DescribeInstancesNew。
| 名称 | 类型 | 描述 |
|---|---|---|
| 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，表示取不到有效值。 |
| CommonSummary | NodesSummary | zookeeper节点描述信息 注意：此字段可能返回 null，表示取不到有效值。 |
| HA | String | 高可用，“true" "false" 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| 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 |
| IsElastic | Boolean | 是否弹性ck 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| InstanceStateInfo | InstanceStateInfo | 集群详细状态 注意：此字段可能返回 null，表示取不到有效值。 |
| HAZk | Boolean | ZK高可用 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| MountDiskType | Integer | 挂载盘,默认0:没有类型；1:裸盘;2:lvm 注意：此字段可能返回 null，表示取不到有效值。 |
| CHProxyVip | String | 无 注意：此字段可能返回 null，表示取不到有效值。 |
| CosBucketName | String | cos buket的名字 注意：此字段可能返回 null，表示取不到有效值。 |
| CanAttachCbs | Boolean | 是否可以挂载云盘 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| CanAttachCbsLvm | Boolean | 是否可以挂载云盘阵列 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| CanAttachCos | Boolean | 是否可以挂载cos 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| Components | Array of ServiceInfo | 服务信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：[] |
| UpgradeVersions | String | 可升级的内核版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxx |
| EsIndexId | String | ex-index 注意：此字段可能返回 null，表示取不到有效值。 |
| EsIndexUsername | String | username 注意：此字段可能返回 null，表示取不到有效值。 |
| EsIndexPassword | String | password 注意：此字段可能返回 null，表示取不到有效值。 |
| HasEsIndex | Boolean | true 注意：此字段可能返回 null，表示取不到有效值。 |
| IsSecondaryZone | Boolean | true 注意：此字段可能返回 null，表示取不到有效值。 |
| SecondaryZoneInfo | String | desc 注意：此字段可能返回 null，表示取不到有效值。 |
| ClickHouseKeeper | Boolean | 是否clickhouse-keeper 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| Details | InstanceDetail | 实例扩展信息 注意：此字段可能返回 null，表示取不到有效值。 |
| IsWhiteSGs | Boolean | 安全组白名单 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| BindSGs | Array of String | 绑定的安全组 注意：此字段可能返回 null，表示取不到有效值。 |
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 |
| Cluster | String | 所属clickhouse cluster名称 示例值：default_cluster |
| NodeGroups | Array of GroupInfo | 节点所属的分组信息 |
| Rip | String | VPC IP 注意：此字段可能返回 null，表示取不到有效值。 示例值：192.168.1.1 |
| IsCHProxy | Boolean | ture的时候表示该节点上部署了chproxy进程 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| Status | String | 节点状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：状态 |
| UUID | String | 节点uuid 注意：此字段可能返回 null，表示取不到有效值。 示例值：唯一id |
| Zone | String | 区 注意：此字段可能返回 null，表示取不到有效值。 |
| ZoneDesc | String | 区描述 注意：此字段可能返回 null，表示取不到有效值。 |
| RealResourceId | String | 真实资源id 示例值：ins-379ozssh |
InstanceStateInfo
集群状态抽象后的结构体
被如下接口引用：DescribeInstance, DescribeInstancesNew。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceState | String | 集群状态，例如：Serving 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| FlowCreateTime | String | 集群操作创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| FlowName | String | 集群操作名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| FlowProgress | Integer | 集群操作进度 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| InstanceStateDesc | String | 集群状态描述，例如：运行中 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| FlowMsg | String | 集群流程错误信息，例如：“创建失败，资源不足” 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| ProcessName | String | 当前步骤的名称，例如：”购买资源中“ 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| RequestId | String | 请求id 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxxx |
| ProcessSubName | String | 流程的二级名称 注意：此字段可能返回 null，表示取不到有效值。 |
MapConfigItem
kv配置，多层级item
被如下接口引用：DescribeInstanceKeyValConfigs。
| 名称 | 类型 | 描述 |
|---|---|---|
| ConfKey | String | key 示例值：xxx |
| Items | Array of InstanceConfigInfo | 列表 示例值：[] |
NodeSpec
创建集群时的规格
被如下接口引用：CreateInstanceNew。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SpecName | String | 是 | 规格名称 示例值：SCH1 |
| Count | Integer | 是 | 数量 示例值：1 |
| DiskSize | Integer | 是 | 云盘大小 示例值：200 |
NodesSummary
节点角色描述信息
被如下接口引用：DescribeInstance, DescribeInstancesNew。
| 名称 | 类型 | 描述 |
|---|---|---|
| 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，表示取不到有效值。 |
| SpecCore | Integer | 规格对应的核数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| SpecMemory | Integer | 规格对应的内存大小 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| DiskCount | Integer | 磁盘的数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MaxDiskSize | Integer | 磁盘的最大大小 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Encrypt | Integer | 是否为加密云盘 注意：此字段可能返回 null，表示取不到有效值。 示例值：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代表售罄 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| ComputeSpecDesc | String | 规格描述信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：2核4G |
| DisplayName | String | 规格名 注意：此字段可能返回 null，表示取不到有效值。 示例值：L |
| InstanceQuota | Integer | 库存数 注意：此字段可能返回 null，表示取不到有效值。 示例值：30 |
ScheduleStrategy
策略详情
被如下接口引用：DescribeBackUpSchedule。
| 名称 | 类型 | 描述 |
|---|---|---|
| CosBucketName | String | 备份桶名称 注意：此字段可能返回 null，表示取不到有效值。 示例值："cos-bucket" |
| RetainDays | Integer | 备份保留天数 示例值：7 |
| WeekDays | String | 备份的天 示例值："1,2" |
| ExecuteHour | Integer | 备份小时 示例值：3 |
| ScheduleId | Integer | 策略id 示例值：1 |
| NextBackupTime | String | 下次备份时间 注意：此字段可能返回 null，表示取不到有效值。 |
SearchTags
列表页搜索的标记列表
被如下接口引用：DescribeInstancesNew。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 否 | 标签的键 示例值：标签一 |
| TagValue | String | 否 | 标签的值 示例值：标签值一 |
| AllValue | Integer | 否 | 1表示只输入标签的键，没有输入值；0表示输入键时且输入值 示例值：1 |
ServiceInfo
服务详细信息描述。
被如下接口引用：DescribeInstance, DescribeInstancesNew。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 服务名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：cdwch-xxxx |
| Version | String | 服务的版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：v1.2.3 |
TablePrivilegeInfo
表权限
被如下接口引用：ModifyUserNewPrivilege。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TableName | String | 是 | 表名称 示例值：table1 |
| TablePrivileges | Array of String | 是 | 表权限列表 SELECT、INSERT_ALL、ALTER、TRUNCATE、DROP_TABLE 查询、插入、设置、清空表、删除表 示例值：【】 |
Tag
标签描述
被如下接口引用：CreateInstanceNew, DescribeInstance, DescribeInstancesNew。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 是 | 标签的键 示例值：标签一 |
| TagValue | String | 是 | 标签的值 示例值：内容一 |
