AttachCBSSpec
集群内节点的规格磁盘规格描述
被如下接口引用：DescribeInstance, DescribeInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DiskType | String | 否 | 节点磁盘类型，例如“CLOUD_SSD”"CLOUD_PREMIUM" |
| DiskSize | Integer | 否 | 磁盘容量，单位G |
| DiskCount | Integer | 否 | 磁盘总数 |
| DiskDesc | String | 否 | 描述 |
ChargeProperties
集群计费相关信息
被如下接口引用：CreateInstanceNew。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ChargeType | String | 否 | 计费类型，“PREPAID” 预付费，“POSTPAID_BY_HOUR” 后付费 注意：此字段可能返回 null，表示取不到有效值。 |
| RenewFlag | Integer | 否 | 是否自动续费，1表示自动续费开启 注意：此字段可能返回 null，表示取不到有效值。 |
| TimeSpan | Integer | 否 | 计费时间长度 注意：此字段可能返回 null，表示取不到有效值。 |
| TimeUnit | String | 否 | 计费时间单位，“m”表示月等 注意：此字段可能返回 null，表示取不到有效值。 |
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，表示取不到有效值。 |
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 |
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，表示取不到有效值。 |
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 |
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，表示取不到有效值。 |
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，表示取不到有效值。 |
SearchTags
列表页搜索的标记列表
被如下接口引用：DescribeInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 否 | 标签的键 示例值：标签一 |
| TagValue | String | 否 | 标签的值 示例值：标签值一 |
| AllValue | Integer | 否 | 1表示只输入标签的键，没有输入值；0表示输入键时且输入值 示例值：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 |
Tag
标签描述
被如下接口引用：CreateInstanceNew, DescribeInstance, DescribeInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 是 | 标签的键 示例值：标签一 |
| TagValue | String | 是 | 标签的值 示例值：内容一 |