AutoScaleDiskInfo
cvm 自动扩盘参数
被如下接口引用:CreateInstance, UpdateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NodeType | String | 否 | 节点类型 hotData,warmData 注意:此字段可能返回 null,表示取不到有效值。 示例值:hotData |
| ScaleType | Integer | 否 | 0:百分比扩容;1:绝对值扩容 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| Threshold | Integer | 否 | 触发阈值,单位%,例如80% 注意:此字段可能返回 null,表示取不到有效值。 示例值:80 |
| Duration | Integer | 否 | 触发持续时间,单位分钟,例如60 注意:此字段可能返回 null,表示取不到有效值。 示例值:60 |
| PercentSize | Integer | 否 | 每次扩容比例,单位%,例如20% 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
| FixSize | Integer | 否 | 绝对值扩容,单位GB,例如100GB 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
| MaxSize | Integer | 否 | 扩容上限,单位GB,例如500GB 注意:此字段可能返回 null,表示取不到有效值。 示例值:500 |
BackingIndexMetaField
后备索引元数据字段
被如下接口引用:DescribeIndexList, DescribeIndexMeta。
| 名称 | 类型 | 描述 |
|---|---|---|
| IndexName | String | 后备索引名 注意:此字段可能返回 null,表示取不到有效值。 示例值:testnew |
| IndexStatus | String | 后备索引状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:GREEN |
| IndexStorage | Integer | 后备索引存储大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:30GB |
| IndexPhrase | String | 后备索引当前生命周期 注意:此字段可能返回 null,表示取不到有效值。 示例值:hot |
| IndexCreateTime | String | 后备索引创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-03-01 10:00:00 |
ClusterView
集群维度视图数据
被如下接口引用:DescribeViews。
| 名称 | 类型 | 描述 |
|---|---|---|
| Health | Float | 集群健康状态 示例值:1 |
| Visible | Float | 集群是否可见 示例值:1 |
| Break | Float | 集群是否熔断 示例值:1 |
| AvgDiskUsage | Float | 平均磁盘使用率 示例值:0.7 |
| AvgMemUsage | Float | 平均内存使用率 示例值:0.1 |
| AvgCpuUsage | Float | 平均cpu使用率 示例值:0.1 |
| TotalDiskSize | Integer | 集群总存储大小 示例值:0.1 |
| TargetNodeTypes | Array of String | 客户端请求节点 示例值:["hot"] |
| NodeNum | Integer | 在线节点数 示例值:10 |
| TotalNodeNum | Integer | 总节点数 示例值:10 |
| DataNodeNum | Integer | 数据节点数 示例值:7 |
| IndexNum | Integer | 索引数 示例值:100 |
| DocNum | Integer | 文档数 示例值:100000 |
| DiskUsedInBytes | Integer | 磁盘已使用字节数 示例值:10000 |
| ShardNum | Integer | 分片个数 示例值:10000 |
| PrimaryShardNum | Integer | 主分片个数 示例值:1000 |
| RelocatingShardNum | Integer | 迁移中的分片个数 示例值:1 |
| InitializingShardNum | Integer | 初始化中的分片个数 示例值:1 |
| UnassignedShardNum | Integer | 未分配的分片个数 示例值:0 |
| TotalCosStorage | Integer | 企业版COS存储容量大小,单位GB 示例值:1 |
| SearchableSnapshotCosBucket | String | 企业版集群可搜索快照cos存放的bucket名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:es-3p7lkxxx-1021 |
| SearchableSnapshotCosAppId | String | 企业版集群可搜索快照cos所属appid 注意:此字段可能返回 null,表示取不到有效值。 示例值:1221 |
CommonIndexInfo
普通索引信息列表
被如下接口引用:DescribeUserCosSnapshotList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| IndexName | String | 否 | 普通索引名 注意:此字段可能返回 null,表示取不到有效值。 示例值:test1 |
| IsShardComplete | Integer | 否 | 分片状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CosBackup
ES cos自动备份信息
被如下接口引用:DescribeInstances, UpdateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| IsAutoBackup | Boolean | 是 | 是否开启cos自动备份 示例值:true |
| BackupTime | String | 是 | 自动备份执行时间(精确到小时), e.g. "22:00" 示例值:00:00 |
| EsRepositoryType | Integer | 否 | 0 腾讯云仓库; 1 客户仓库 示例值:0 |
| UserEsRepository | String | 否 | 客户快照仓库名称 示例值:testRepository |
| StorageDuration | Integer | 否 | 快照存储周期 单位天 示例值:15 |
| AutoBackupInterval | Integer | 否 | 自动备份频率单位小时 示例值:4 |
CosSnapShotInfo
无
被如下接口引用:DescribeUserCosSnapshotList。
| 名称 | 类型 | 描述 |
|---|---|---|
| CosBucket | String | cos 桶名 注意:此字段可能返回 null,表示取不到有效值。 示例值:es-ap-shanghai |
| BasePath | String | base path 注意:此字段可能返回 null,表示取不到有效值。 示例值:es_backup/es-xxxx/ |
| SnapshotName | String | 快照名 注意:此字段可能返回 null,表示取不到有效值。 示例值:test_snapshot |
| State | String | 状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:SUCCESS |
| Version | String | 快照版本 注意:此字段可能返回 null,表示取不到有效值。 示例值:7.14.2 |
| CommonIndexArr | Array of CommonIndexInfo | 普通[{"DataStreamName":"ilm-history-5","Is索引信息列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[{"IndexName":"test1","IsShardComplete":1}] |
| DataStreamArr | Array of DataStreamInfo | 自治索引信息列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[{"DataStreamName":"ilm-his1-5","IsShardComplete":1},{"DataStreamName":"index1","IsShardComplete":1}]}] |
DataStreamInfo
自治索引信息
被如下接口引用:DescribeUserCosSnapshotList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DataStreamName | String | 否 | 自治索引名 注意:此字段可能返回 null,表示取不到有效值。 示例值:index1 |
| IsShardComplete | Integer | 否 | 分片状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
DescribeInstancePluginInfo
插件信息
被如下接口引用:DescribeInstancePluginList。
| 名称 | 类型 | 描述 |
|---|---|---|
| PluginName | String | 插件名 示例值:analysis-qq |
| PluginVersion | String | 插件版本 示例值:6.4.3 |
| PluginDesc | String | 插件描述 示例值:插件描述 |
| Status | Integer | 插件状态:-2 已卸载 -1 卸载中 0 安装中 1 已安装 示例值:1 |
| Removable | Boolean | 插件是否可卸载 示例值:false |
| PluginType | Integer | 0:系统插件 示例值:0 |
| PluginUpdateTime | String | 插件变更时间 示例值:2021-03-01 10:00:00 |
DiData
数据接入信息
被如下接口引用:DescribeServerlessSpaces。
| 名称 | 类型 | 描述 |
|---|---|---|
| DiId | String | 数据接入id 注意:此字段可能返回 null,表示取不到有效值。 示例值:sdi-xxxx |
| CreateTime | String | 数据接入创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-01-08 11:48:18 |
| Status | Integer | 数据接入状态,0处理中,1正常,-2删除中,-3已删除 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| DiDataSourceCvm | DiDataSourceCvm | cvm数据源信息 注意:此字段可能返回 null,表示取不到有效值。 |
| DiDataSourceTke | DiDataSourceTke | tke数据源信息 注意:此字段可能返回 null,表示取不到有效值。 |
| DiDataSinkServerless | DiDataSinkServerless | serverless目的端信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"ServerlessId":"index-xxxxx"} |
| DiDataSourceType | String | 数据接入类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:cvm_collector |
DiDataSinkServerless
数据接入serverless目的端信息
被如下接口引用:DescribeServerlessSpaces。
| 名称 | 类型 | 描述 |
|---|---|---|
| ServerlessId | String | serverless实例id 注意:此字段可能返回 null,表示取不到有效值。 示例值:index-xxxx |
DiDataSourceCvm
数据接入cvm数据源信息
被如下接口引用:DescribeServerlessSpaces。
| 名称 | 类型 | 描述 |
|---|---|---|
| VpcId | String | vpc id 注意:此字段可能返回 null,表示取不到有效值。 示例值:vpc-xxxx |
| LogPaths | Array of String | 采集路径列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[/test, /tmp] |
| CvmInstances | Array of DiDataSourceCvmInstance | cvm实例信息列表 注意:此字段可能返回 null,表示取不到有效值。 |
| CollectorId | String | 采集器id 注意:此字段可能返回 null,表示取不到有效值。 示例值:coll-xxxxxxxx |
DiDataSourceCvmInstance
数据接入cvm实例信息
被如下接口引用:DescribeServerlessSpaces。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | cvm实例id 注意:此字段可能返回 null,表示取不到有效值。 示例值:ins-xxxx |
| VpcId | String | vpc id 注意:此字段可能返回 null,表示取不到有效值。 示例值:vpc-xxxx |
| SubnetId | String | 子网id 注意:此字段可能返回 null,表示取不到有效值。 示例值:subnet-xxxx |
| ErrMsg | String | 错误信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:ok |
DiDataSourceTke
数据接入tke数据源信息
被如下接口引用:DescribeServerlessSpaces。
| 名称 | 类型 | 描述 |
|---|---|---|
| VpcId | String | vpc id 注意:此字段可能返回 null,表示取不到有效值。 示例值:vpc-xxxx |
| TkeId | String | tke实例id 注意:此字段可能返回 null,表示取不到有效值。 示例值:cls-xxxx |
| CollectorId | String | 采集器id 注意:此字段可能返回 null,表示取不到有效值。 示例值:coll-xxxxxxxx |
| CollectorName | String | 采集源名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:sdi-xxxx_index-xxxx |
| CollectorType | String | 采集器类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:filebeat |
| CollectorVersion | String | 采集器版本 注意:此字段可能返回 null,表示取不到有效值。 示例值:7.14.0 |
| IncludeNamespaces | Array of String | tke包含的命名空间 注意:此字段可能返回 null,表示取不到有效值。 示例值:["index","apparate-acceleration","default","kube-node-lease","kube-public","kube-system","tcr-assistant-system"] |
| ExcludeNamespaces | Array of String | tke不包含的命名空间 注意:此字段可能返回 null,表示取不到有效值。 示例值:["index","apparate-acceleration","default","kube-node-lease","kube-public","kube-system","tcr-assistant-system"] |
| PodLabelKeys | Array of String | tke pod标签名 注意:此字段可能返回 null,表示取不到有效值。 示例值:["es_test"] |
| PodLabelValues | Array of String | tke pod标签值 注意:此字段可能返回 null,表示取不到有效值。 示例值:["es_test"] |
| ContainerName | String | tke容器名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:container |
| ConfigContent | String | tke采集器beat配置 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"input": test} |
| InputType | String | / 注意:此字段可能返回 null,表示取不到有效值。 示例值:container |
| InputPath | String | TKE 日志采集路径 注意:此字段可能返回 null,表示取不到有效值。 示例值:var/log/* |
DiSourceCvm
数据接入cvm数据源
被如下接口引用:CreateServerlessInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VpcId | String | 否 | 数据源所属vpc id,创建后不允许修改 示例值:vpc-xxxxxxxx |
| CvmIds | Array of String | 否 | cvm列表 示例值:[ins-xxxx, ins-xxxx] |
| LogPaths | Array of String | 否 | 采集路径列表,支持通配符 示例值:[/test, /tmp] |
DiSourceTke
数据接入tke数据源
被如下接口引用:CreateServerlessInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VpcId | String | 否 | 数据源所属vpc id,创建后不允许修改 示例值:vpc-xxxx |
| TkeId | String | 否 | tke实例id,创建后不允许修改 示例值:cls-xxxx |
| IncludeNamespaces | Array of String | 否 | tke包含的命名空间 示例值:["default"] |
| ExcludeNamespaces | Array of String | 否 | tke不包含的命名空间 示例值:["default"] |
| ContainerName | String | 否 | tke容器名称 示例值:tke |
| LogFilters | String | 否 | tke日志内容过滤 示例值:无使用 |
| ConfigContent | String | 否 | tke beats配置项 示例值:"\nprocessors:\n - decode_json_fields:\n fields: ["message"]\n process_array: false\n max_depth: 1\n target: ""\n overwrite_keys: false\n add_error_key: true\n - drop_fields:\n fields: ["field1", "field2"]\n ignore_missing: false\n" |
| PodLabel | Array of DiSourceTkePodLabel | 否 | tke pod标签 示例值:[{"Key":"logCollect","Value":"index-fafafaff"}] |
| InputType | String | 否 | / 示例值:log |
| InputPath | String | 否 | tke 日志采集路径 示例值:/var/log/*.log |
DiSourceTkePodLabel
tke pod标签
被如下接口引用:CreateServerlessInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 否 | 标签key 注意:此字段可能返回 null,表示取不到有效值。 示例值:logCollect |
| Value | String | 否 | 标签value 注意:此字段可能返回 null,表示取不到有效值。 示例值:index-xxxx |
DiagnoseJobMeta
智能运维支持的诊断项和元信息
被如下接口引用:GetDiagnoseSettings。
| 名称 | 类型 | 描述 |
|---|---|---|
| JobName | String | 智能运维诊断项英文名 示例值:cluster_health |
| JobZhName | String | 智能运维诊断项中文名 示例值:集群健康状态诊断 |
| JobDescription | String | 智能运维诊断项描述 示例值:诊断集群健康状态 |
DiagnoseJobResult
智能运维诊断项结果
被如下接口引用:DescribeDiagnose。
| 名称 | 类型 | 描述 |
|---|---|---|
| JobName | String | 诊断项名 示例值:cluster_health |
| Status | Integer | 诊断项状态:-2失败,-1待重试,0运行中,1成功 示例值:0 |
| Score | Integer | 诊断项得分 示例值:100 |
| Summary | String | 诊断摘要 示例值:配置合理 |
| Advise | String | 诊断建议 示例值:保持住 |
| Detail | String | 诊断详情 示例值:配置合理 |
| MetricDetails | Array of MetricDetail | 诊断指标详情 注意:此字段可能返回 null,表示取不到有效值。 |
| LogDetails | Array of LogDetail | 诊断日志详情 注意:此字段可能返回 null,表示取不到有效值。 |
| SettingDetails | Array of SettingDetail | 诊断配置详情 注意:此字段可能返回 null,表示取不到有效值。 |
DiagnoseResult
智能运维诊断结果
被如下接口引用:DescribeDiagnose。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | ES实例ID 示例值:es-abcdefgh |
| RequestId | String | 诊断报告ID 示例值:ewtd-xcafdg-dsaq |
| CreateTime | String | 诊断触发时间 示例值:2021-03-01 10:00:00 |
| Completed | Boolean | 诊断是否完成 示例值:true |
| Score | Integer | 诊断总得分 示例值:100 |
| JobType | Integer | 诊断类型,2 定时诊断,3 客户手动触发诊断 示例值:3 |
| JobParam | JobParam | 诊断参数,如诊断时间,诊断索引等 |
| JobResults | Array of DiagnoseJobResult | 诊断项结果列表 |
DictInfo
ik插件词典信息
被如下接口引用:DescribeInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 是 | 词典键值 示例值:test.dic |
| Name | String | 是 | 词典名称 示例值:test.dic |
| Size | Integer | 是 | 词典大小,单位B 示例值:128 |
Dimension
智能运维指标维度
被如下接口引用:DescribeDiagnose。
| 名称 | 类型 | 描述 |
|---|---|---|
| Key | String | 智能运维指标维度Key 示例值:节点ID |
| Value | String | 智能运维指标维度值 示例值:1232334652 |
EnableScheduleOperationDuration
置放群组异步任务维护的时间段
被如下接口引用:CreateInstance, DescribeInstances, RestartNodes, UpdateInstance, UpgradeInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Periods | Array of String | 否 | 支持开启异步任务的日期 注意:此字段可能返回 null,表示取不到有效值。 示例值:[2024.09.24, 2024.09.26] |
| TimeStart | String | 否 | 支持开启异步的开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:06:00 |
| TimeEnd | String | 否 | 支持开启异步的结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:08:00 |
| TimeZone | String | 否 | 支持开启异步的时区 注意:此字段可能返回 null,表示取不到有效值。 示例值:UTC+8 |
EsAcl
ES集群配置项
被如下接口引用:DescribeInstances, DescribeServerlessSpaces, UpdateInstance, UpdateServerlessSpace。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| BlackIpList | Array of String | 否 | kibana访问黑名单 示例值:["10...*"] |
| WhiteIpList | Array of String | 否 | kibana访问白名单 示例值:["127...*"] |
EsConfigSetInfo
配置组信息
被如下接口引用:DescribeInstances, UpdateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 配置组类型,如ldap,ad等 示例值:ldap |
| EsConfig | String | 是 | "{"order":0,"url":"ldap://10.0.1.72:389","bind_dn":"cn=admin,dc=tencent,dc=com","user_search.base_dn":"dc=tencent,dc=com","user_search.filter":"(cn={0})","group_search.base_dn":"dc=tencent,dc=com"}" 示例值:参考描述 |
EsDictionaryInfo
ES 词库信息
被如下接口引用:DescribeInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MainDict | Array of DictInfo | 是 | 启用词词典列表 示例值:[{"Id":0,"UserCosAddress":"https://es-cos-12577xxxx.cos.ap-guangzhou.myqcloud.com/ik_start.dic","Key":"IKPlug/100007799884/es-h687vonp/maindict/temp/ik_start.dic","Name":"ik_start.dic","Size":40,"RemotePath":""}] |
| Stopwords | Array of DictInfo | 是 | 停用词词典列表 示例值:[{"Id":0,"UserCosAddress":"https://es-cos-125778xxxx.cos.ap-guangzhou.myqcloud.com/ik_stop.dic","Key":"","Name":"ik_stop.dic","Size":116,"RemotePath":""}] |
| QQDict | Array of DictInfo | 是 | QQ分词词典列表 示例值:pwd |
| Synonym | Array of DictInfo | 是 | 同义词词典列表 示例值:[{}] |
| UpdateType | String | 是 | 更新词典类型 示例值:UpdateIkConfig |
| AnsjMain | Array of DictInfo | 否 | ansj启用词词典列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[{}] |
| AnsjStop | Array of DictInfo | 否 | ansj停用词词典列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[{}] |
| AnsjAmbiguity | Array of DictInfo | 否 | ansj歧义词库列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[{}] |
| AnsjSynonyms | Array of DictInfo | 否 | ansj同义词词典列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[{}] |
EsPublicAcl
ES公网访问控制信息
被如下接口引用:UpdateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| BlackIpList | Array of String | 否 | 访问黑名单 示例值:["123.207.123.xxx"] |
| WhiteIpList | Array of String | 否 | 访问白名单 示例值:["123.207.123.253"] |
Failures
索引备份失败的数据结构
被如下接口引用:DescribeClusterSnapshot。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Index | String | 否 | 备份失败的索引名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:index_name |
| ShardId | Integer | 否 | 快照失败的分片号 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| Reason | String | 否 | 快照失败的原因 注意:此字段可能返回 null,表示取不到有效值。 示例值:no such index [gz_test.index_monitor@2025-03-24] |
| Status | String | 否 | 快照失败的状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:401 |
GpuInfo
节点Gpu信息
被如下接口引用:CreateInstance, DescribeInstances, UpdateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| GpuCount | Integer | 否 | Gpu块数 示例值:1 |
| GpuType | String | 否 | Gpu类型 示例值:Nvidia T4 |
IndexMetaField
索引元数据字段
被如下接口引用:DescribeIndexList, DescribeIndexMeta。
| 名称 | 类型 | 描述 |
|---|---|---|
| IndexType | String | 索引类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:auto |
| IndexName | String | 索引名 注意:此字段可能返回 null,表示取不到有效值。 示例值:testnew |
| IndexMetaJson | String | 索引元数据JSON 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"mappings": {"properties":{"@timestamp":{"type":"date"}}}, "settings":{"index.number_of_replicas":"2"}} |
| IndexStatus | String | 索引状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:GREEN |
| IndexStorage | Integer | 索引存储大小,单位Byte 注意:此字段可能返回 null,表示取不到有效值。 示例值:30 |
| IndexCreateTime | String | 索引创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-03-01 10:00:00 |
| BackingIndices | Array of BackingIndexMetaField | 后备索引 注意:此字段可能返回 null,表示取不到有效值。 示例值:[{"IndexName":".ds-at-20250324190302-2025.03.24-000001","IndexStatus":"green","IndexStorage":416,"IndexPhrase":"data_hot,data_warm,data_cold","IndexCreateTime":"2025-03-24 19:03:10"}] |
| ClusterId | String | 索引所属集群ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:es-abcdefgh |
| ClusterName | String | 索引所属集群名 注意:此字段可能返回 null,表示取不到有效值。 示例值:testnew |
| ClusterVersion | String | 索引所属集群版本 注意:此字段可能返回 null,表示取不到有效值。 示例值:7.14.2 |
| IndexPolicyField | IndexPolicyField | 索引生命周期字段 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"WarmEnable":"false","WarmMinAge":"","ColdEnable":"false","ColdMinAge":"","ColdAction":"","FrozenEnable":"false","FrozenMinAge":""} |
| IndexOptionsField | IndexOptionsField | 索引自治字段 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"ExpireMaxAge":"","ExpireMaxSize":"","RolloverMaxAge":"1d","RolloverDynamic":"true","ShardNumDynamic":"true","TimestampField":"timestamp","WriteMode":"append_only"} |
| IndexSettingsField | IndexSettingsField | 索引配置字段 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"NumberOfShards":"5","RefreshInterval":"30s","CustomSetting":"{"index.number_of_shards":"5"}"} |
| IndexAliasesField | Array of String | 索引别名字段 注意:此字段可能返回 null,表示取不到有效值。 示例值:[alias1,alias2] |
| AppId | Integer | 索引所属集群APP ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:10004222 |
| IndexDocs | Integer | 索引文档数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
IndexOptionsField
索引自治字段
被如下接口引用:DescribeIndexList, DescribeIndexMeta。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ExpireMaxAge | String | 否 | 过期时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:3d |
| ExpireMaxSize | String | 否 | 过期大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:2GB |
| RolloverMaxAge | String | 否 | 滚动周期 注意:此字段可能返回 null,表示取不到有效值。 示例值:1d |
| RolloverDynamic | String | 否 | 是否开启动态滚动 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
| ShardNumDynamic | String | 否 | 是否开启动态分片 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
| TimestampField | String | 否 | 时间分区字段 注意:此字段可能返回 null,表示取不到有效值。 示例值:@timestamp |
| WriteMode | String | 否 | 写入模式 注意:此字段可能返回 null,表示取不到有效值。 示例值:append_only |
IndexPolicyField
索引生命周期字段
被如下接口引用:DescribeIndexList, DescribeIndexMeta。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| WarmEnable | String | 否 | 是否开启warm阶段 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
| WarmMinAge | String | 否 | warm阶段转入时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:3d |
| ColdEnable | String | 否 | 是否开启cold阶段 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
| ColdMinAge | String | 否 | cold阶段转入时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:3d |
| FrozenEnable | String | 否 | 是否开启frozen阶段 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
| FrozenMinAge | String | 否 | frozen阶段转入时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:3d |
| ColdAction | String | 否 | / 注意:此字段可能返回 null,表示取不到有效值。 示例值:searchable_snapshot |
IndexSettingsField
索引配置字段
被如下接口引用:DescribeIndexList, DescribeIndexMeta。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NumberOfShards | String | 否 | 索引主分片数 注意:此字段可能返回 null,表示取不到有效值。 示例值:5 |
| NumberOfReplicas | String | 否 | 索引副本分片数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| RefreshInterval | String | 否 | 索引刷新频率 注意:此字段可能返回 null,表示取不到有效值。 示例值:20s |
InstanceInfo
实例详细信息
被如下接口引用:DescribeInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值:es-xxxxxxxx |
| InstanceName | String | 实例名称 示例值:实例名称 |
| Region | String | 地域 示例值:ap-guangzhou |
| Zone | String | 可用区 示例值:ap-guangzhou-1 |
| AppId | Integer | 用户ID 示例值:12341312 |
| Uin | String | 用户UIN 示例值:100xxxxxxxx |
| VpcUid | String | 实例所属VPC的UID 示例值:vpc-xxxxxxx |
| SubnetUid | String | 实例所属子网的UID 示例值:subnet-xxxxxxx |
| Status | Integer | 实例状态,0:处理中,1:正常,-1:停止,-2:销毁中,-3:已销毁, -4:隔离中,2:创建集群时初始化中 示例值:1 |
| RenewFlag | String | 自动续费标识。取值范围: RENEW_FLAG_AUTO:自动续费 RENEW_FLAG_MANUAL:不自动续费 默认取值: RENEW_FLAG_DEFAULT:不自动续费 若该参数指定为 RENEW_FLAG_AUTO,在账户余额充足的情况下,实例到期后将按月自动续费。 示例值:NOTIFY_AND_AUTO_RENEW |
| ChargeType | String | 实例计费模式。取值范围: PREPAID:表示预付费,即包年包月 POSTPAID_BY_HOUR:表示后付费,即按量计费 CDHPAID:CDH付费,即只对CDH计费,不对CDH上的实例计费。 示例值:PREPAID |
| ChargePeriod | Integer | 包年包月购买时长,单位:月 示例值:6 |
| NodeType | String | 节点规格 示例值:ES.S1.SMALL2 |
| NodeNum | Integer | 节点个数 示例值:3 |
| CpuNum | Integer | 节点CPU核数 示例值:4 |
| MemSize | Integer | 节点内存大小,单位GB 示例值:8 |
| DiskType | String | 节点磁盘类型 示例值:CLOUD_PREMIUM |
| DiskSize | Integer | 节点磁盘大小,单位GB 示例值:100 |
| EsDomain | String | ES域名 示例值:http://es-xxxxxxxx |
| EsVip | String | ES VIP 示例值:1.1.1.1 |
| EsPort | Integer | ES端口 示例值:9200 |
| KibanaUrl | String | Kibana访问url 示例值:http://es-xxxxxxxx |
| EsVersion | String | ES版本号 示例值:5.6.4 |
| EsConfig | String | ES配置项 示例值:"{}" |
| EsAcl | EsAcl | Kibana访问控制配置 |
| CreateTime | String | 实例创建时间 示例值:2021-03-01 10:00:00 |
| UpdateTime | String | 实例最后修改操作时间 示例值:2021-03-01 10:00:00 |
| Deadline | String | 实例到期时间 示例值:2021-03-01 10:00:00 |
| InstanceType | Integer | 实例类型(实例类型标识,当前只有1,2两种) 示例值:1 |
| IkConfig | EsDictionaryInfo | Ik分词器配置 |
| MasterNodeInfo | MasterNodeInfo | 专用主节点配置 |
| CosBackup | CosBackup | cos自动备份配置 |
| AllowCosBackup | Boolean | 是否允许cos自动备份 示例值:true |
| TagList | Array of TagInfo | 实例拥有的标签列表 |
| LicenseType | String | License类型 示例值:platinum |
| EnableHotWarmMode | Boolean | 是否为冷热集群 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
| WarmNodeType | String | 温节点规格 注意:此字段可能返回 null,表示取不到有效值。 示例值:ES.S1.SMALL2 |
| WarmNodeNum | Integer | 温节点个数 注意:此字段可能返回 null,表示取不到有效值。 示例值:3 |
| WarmCpuNum | Integer | 温节点CPU核数 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
| WarmMemSize | Integer | 温节点内存内存大小,单位GB 注意:此字段可能返回 null,表示取不到有效值。 示例值:4 |
| WarmDiskType | String | 温节点磁盘类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:CLOUD_PREMIUM |
| WarmDiskSize | Integer | 温节点磁盘大小,单位GB 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
| NodeInfoList | Array of NodeInfo | 集群节点信息列表 注意:此字段可能返回 null,表示取不到有效值。 |
| EsPublicUrl | String | Es公网地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:http://es-xxxxxxxx |
| MultiZoneInfo | Array of ZoneDetail | 多可用区网络信息 注意:此字段可能返回 null,表示取不到有效值。 |
| DeployMode | Integer | 部署模式 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| PublicAccess | String | ES公网访问状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:OPEN |
| EsPublicAcl | EsAcl | ES公网访问控制配置 |
| KibanaPrivateUrl | String | Kibana内网地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:http://es-xxxxxxxx |
| KibanaPublicAccess | String | Kibana公网访问状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:OPEN |
| KibanaPrivateAccess | String | Kibana内网访问状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:OPEN |
| SecurityType | Integer | 6.8(及以上版本)基础版是否开启xpack security认证 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| SceneType | Integer | 场景化模板类型:0、不开启;1、通用场景;2、日志场景;3、搜索场景 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| KibanaConfig | String | Kibana配置项 注意:此字段可能返回 null,表示取不到有效值。 示例值:"{}" |
| KibanaNodeInfo | KibanaNodeInfo | Kibana节点信息 注意:此字段可能返回 null,表示取不到有效值。 |
| WebNodeTypeInfo | WebNodeTypeInfo | 可视化节点配置 注意:此字段可能返回 null,表示取不到有效值。 |
| Jdk | String | JDK类型,oracle或kona 注意:此字段可能返回 null,表示取不到有效值。 示例值:oracle |
| Protocol | String | 集群网络通讯协议 注意:此字段可能返回 null,表示取不到有效值。 示例值:https |
| SecurityGroups | Array of String | 安全组id 注意:此字段可能返回 null,表示取不到有效值。 示例值:["str"] |
| ColdNodeType | String | 冷节点规格 注意:此字段可能返回 null,表示取不到有效值。 示例值:ES.S1.SMALL2 |
| ColdNodeNum | Integer | 冷节点个数 注意:此字段可能返回 null,表示取不到有效值。 示例值:3 |
| ColdCpuNum | Integer | 冷节点CPU核数 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
| ColdMemSize | Integer | 冷节点内存大小,单位GB 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
| ColdDiskType | String | 冷节点磁盘类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:CLOUD_PREMIUM |
| ColdDiskSize | Integer | 冷节点磁盘大小,单位GB 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
| FrozenNodeType | String | 冻节点规格 注意:此字段可能返回 null,表示取不到有效值。 示例值:ES.S1.SMALL2 |
| FrozenNodeNum | Integer | 冻节点个数 注意:此字段可能返回 null,表示取不到有效值。 示例值:3 |
| FrozenCpuNum | Integer | 冻节点CPU核数 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
| FrozenMemSize | Integer | 冻节点内存大小,单位GB 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
| FrozenDiskType | String | 冻节点磁盘类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:CLOUD_SSD |
| FrozenDiskSize | Integer | 冻节点磁盘大小,单位GB 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
| HealthStatus | Integer | 集群健康状态 -1 未知;0 Green; 1 Yellow; 2 Red 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| EsPrivateUrl | String | https集群内网url 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://xxx.com |
| EsPrivateDomain | String | https集群内网域名 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxx.com |
| EsConfigSets | Array of EsConfigSetInfo | 集群的配置组信息 注意:此字段可能返回 null,表示取不到有效值。 |
| OperationDuration | OperationDuration | 集群可维护时间段 注意:此字段可能返回 null,表示取不到有效值。 |
| OptionalWebServiceInfos | Array of OptionalWebServiceInfo | web节点列表 注意:此字段可能返回 null,表示取不到有效值。 |
| AutoIndexEnabled | Boolean | 自治索引开关 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
| EnableHybridStorage | Boolean | 是否支持存储计算分离 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
| ProcessPercent | Float | 流程进度 注意:此字段可能返回 null,表示取不到有效值。 示例值:1.0 |
| KibanaAlteringPublicAccess | String | Kibana的alerting外网告警策略 注意:此字段可能返回 null,表示取不到有效值。 示例值:OPEN |
| HasKernelUpgrade | Boolean | 本月是否有内核可以更新:false-无,true-有 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
| CdcId | String | cdcId,使用cdc子网时传递 注意:此字段可能返回 null,表示取不到有效值。 示例值:cluster-xxxxxx |
| KibanaPrivateVip | String | kibana内网vip 注意:此字段可能返回 null,表示取不到有效值。 示例值:10.0.0.1 |
| CustomKibanaPrivateUrl | String | 自定义kibana内网url 注意:此字段可能返回 null,表示取不到有效值。 示例值:http://xxx.com |
| OutboundPublicAcls | Array of OutboundPublicAcl | 节点出站访问详细信息 注意:此字段可能返回 null,表示取不到有效值。 |
| NetConnectScheme | String | 网络连接方案 注意:此字段可能返回 null,表示取不到有效值。 示例值:PrivateLink |
| DisasterRecoverGroupAffinity | Integer | 置放群组相关参数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| SubProductCode | String | 子产品ID枚举值: 开源版:"sp_es_io2", 基础版:"sp_es_basic",白金版:"sp_es_platinum",企业版:"sp_es_enterprise",CDC白金版:"sp_es_cdc_platinum",日志增强版:"sp_es_enlogging",tsearch:"sp_tsearch_io2",logstash:"sp_es_logstash" ,可以为空,为空的时候后台取LicenseType映射该字段 注意:此字段可能返回 null,表示取不到有效值。 示例值:sp_es_platinum |
| CosBucketStorageSize | Integer | 存算分离cos用量,单位M 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| ReadWriteMode | Integer | 读写分离模式:0-不开启,1-本地读写分离,2-远端读写分离 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| EnableScheduleRecoverGroup | Boolean | 是否有置放群组异步调度任务 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
| EnableScheduleOperationDuration | EnableScheduleOperationDuration | 异步调度任务的时间 注意:此字段可能返回 null,表示取不到有效值。 |
| EnableDestroyProtection | String | 开启集群保护:OPEN-开启,CLOSE-关闭 注意:此字段可能返回 null,表示取不到有效值。 示例值:CLOSE |
| ShowKibanaIpPort | String | kibana内网访问地址 示例值:http://10.0.0.1:5601 |
| IsCdzLite | Boolean | 是否为CDZLite可用区 示例值:false |
| EsPrivateTcpUrl | String | 集群内网tcp地址 示例值:10.1.2.3:9300 |
InstanceLog
ES集群日志详细信息
被如下接口引用:DescribeInstanceLogs, DescribeLogstashInstanceLogs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Time | String | 日志时间 示例值:2025-03-24T19:36:32.240+08:00 |
| Level | String | 日志级别 示例值:ERROR |
| Ip | String | 集群节点ip 示例值:9.20.85.138 |
| Message | String | 日志内容 示例值:[o.e.x.w.i.s.ExecutableSearchInput] [167075xxx |
| NodeID | String | 集群节点ID 示例值:1670750203001429xxx |
| IndexName | String | 慢日志索引名 示例值:index |
| Shard | String | 慢日志索引分片 示例值:[index][0] |
| QueryCost | String | 慢日志索引查询耗时 示例值:100 |
IpTimePair
节点IP、访问IP、访问时间
被如下接口引用:ExportIpTraceLog。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Ip | String | 否 | IP地址 示例值:127.0.0.1 |
| Timestamp | Integer | 否 | 时间戳,毫秒 示例值:173122344 |
| NodeIp | String | 否 | 集群节点IP 示例值:127.0.0.1 |
IpTraceConfig
IP溯源配置
被如下接口引用:GetIpTraceStatus, UpdateIpTraceStatus。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| EnableRequest | Boolean | 否 | 请求溯源开关 示例值:true |
| EnableResponse | Boolean | 否 | 返回溯源开关 示例值:true |
| EnableRequestBody | Boolean | 否 | 请求消息体溯源开关 示例值:true |
| EnableResponseBody | Boolean | 否 | 返回消息体溯源开关 示例值:true |
| RemoteIpInclude | Array of String | 否 | 排除IP 示例值:["127.0.0.1"] |
| RemoteIpExclude | Array of String | 否 | 包含IP 示例值:["127.0.0.1"] |
| UriInclude | Array of String | 否 | 排除uri 示例值:["/idx/_search*"] |
| UriExclude | Array of String | 否 | 包含uri 示例值:["/abc/_search*"] |
IpTraceLogEntry
IP溯源日志
被如下接口引用:QueryIpTraceLog。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Timestamp | String | 否 | 时间 示例值:2020-12-28 14:37:36 |
| RemoteIp | String | 否 | 访问IP 示例值:127.0.0.1 |
| TraceType | String | 否 | 溯源类型rsp/req 示例值:rsp |
| NetType | String | 否 | 访问网络类型,公网/私网 示例值:Public |
| Message | String | 否 | 原始消息 示例值:[o.e.h.HttpTracer ] [1720516351009725632] [147501421][null][OK][application/json; charset=UTF-8][308090] sent response to [Netty4HttpChannel{localAddress=/9.118.68.121:9200, remoteAddress=/10.13.90.41:58078}] success [false] |
| Uri | String | 否 | 访问uri 示例值:/idx/_search |
| PublicIp | String | 否 | 公网IP 示例值:null |
| ReqTypeOrRspStatus | String | 否 | 请求类型或返回状态 示例值:OK |
| NodeIp | String | 否 | 集群节点IP 示例值:127.0.0.1 |
JobParam
智能运维诊断参数
被如下接口引用:DescribeDiagnose。
| 名称 | 类型 | 描述 |
|---|---|---|
| Jobs | Array of String | 诊断项列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[cluster_health] |
| Indices | String | 诊断索引 示例值:"*" |
| Interval | Integer | 历史诊断时间 示例值:60 |
KeyValue
OperationDetail使用此结构的数组描述新旧配置
被如下接口引用:DescribeInstanceOperations, DescribeLogstashInstanceOperations。
| 名称 | 类型 | 描述 |
|---|---|---|
| Key | String | 键 示例值:WarmDataNodeDiskCount |
| Value | String | 值 示例值:2 |
KibanaNodeInfo
实例Kibana节点相关信息
被如下接口引用:DescribeInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| KibanaNodeType | String | Kibana节点规格 示例值:ES.S1.SMALL2 |
| KibanaNodeNum | Integer | Kibana节点个数 示例值:1 |
| KibanaNodeCpuNum | Integer | Kibana节点CPU数 示例值:2 |
| KibanaNodeMemSize | Integer | Kibana节点内存GB 示例值:4 |
| KibanaNodeDiskType | String | Kibana节点磁盘类型 示例值:CLOUD_PREMIUM |
| KibanaNodeDiskSize | Integer | Kibana节点磁盘大小 示例值:50 |
KibanaPublicAcl
kibana公网域名白名单参数
被如下接口引用:UpdateServerlessInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| WhiteIpList | Array of String | 否 | kibana访问白名单 示例值:["123.1.2.4"] |
KibanaView
Kibana视图数据
被如下接口引用:DescribeViews。
| 名称 | 类型 | 描述 |
|---|---|---|
| Ip | String | Kibana节点IP 示例值:9.15.123.xxx |
| DiskSize | Integer | 节点总磁盘大小 示例值:50 |
| DiskUsage | Float | 磁盘使用率 示例值:0.1967 |
| MemSize | Integer | 节点内存大小 示例值:2 |
| MemUsage | Float | 内存使用率 示例值:0 |
| CpuNum | Integer | 节点cpu个数 示例值:1 |
| CpuUsage | Float | cpu使用率 示例值:0.029166666666667 |
| Zone | String | 可用区 示例值:ap-beijing-7 |
| NodeId | String | ts-0noqayxu-az6-hot-03222010-0 示例值:1658386193000764xxx |
LocalDiskInfo
节点本地盘信息
被如下接口引用:CreateInstance, DescribeInstances, UpdateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LocalDiskType | String | 是 | 本地盘类型 示例值:NVME_SSD |
| LocalDiskSize | Integer | 是 | 本地盘单盘大小 示例值:7311360 |
| LocalDiskCount | Integer | 是 | 本地盘块数 示例值:1 |
LogDetail
智能运维日志详情
被如下接口引用:DescribeDiagnose。
| 名称 | 类型 | 描述 |
|---|---|---|
| Key | String | 日志异常名 示例值:BreakException |
| Advise | String | 日志异常处理建议 示例值:建议处理熔断 |
| Count | Integer | 日志异常名出现次数 示例值:5 |
LogstashBindedES
Logstash绑定的ES集群信息
被如下接口引用:UpdateLogstashInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ESInstanceId | String | 是 | ES集群ID 示例值:es-xxxxxxxx |
| ESUserName | String | 是 | ES集群用户名 示例值:elastic |
| ESPassword | String | 是 | ES集群密码 示例值:G7j#kL9**** |
LogstashExtendedFile
Logstash扩展文件信息
被如下接口引用:DescribeLogstashInstances, UpdateLogstashInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 扩展文件名称 示例值:test.conf |
| Size | Integer | 是 | 扩展文件大小,单位B 示例值:1000 |
LogstashInstanceInfo
Logstash实例详细信息
被如下接口引用:DescribeLogstashInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值:es-xxxx |
| InstanceName | String | 实例名称 示例值:测试集群 |
| Region | String | 地域 示例值:ap-guangzhou |
| Zone | String | 可用区 示例值:ap-guangzhou-1 |
| AppId | Integer | 用户ID 示例值:12*488 |
| Uin | String | 用户UIN 示例值:100**638 |
| VpcId | String | 实例所属VPC的ID 示例值:vpc-xx |
| SubnetId | String | 实例所属子网的ID 示例值:subnet-xx |
| Status | Integer | 实例状态,0:处理中,1:正常,-1停止,-2:销毁中,-3:已销毁 示例值:0 |
| ChargeType | String | 实例计费模式。取值范围: PREPAID:表示预付费,即包年包月 POSTPAID_BY_HOUR:表示后付费,即按量计费 CDHPAID:CDH付费,即只对CDH计费,不对CDH上的实例计费。 示例值:PREPAID |
| ChargePeriod | Integer | 包年包月购买时长,单位:月 示例值:1 |
| RenewFlag | String | 自动续费标识。取值范围: NOTIFY_AND_AUTO_RENEW:通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费 默认取值:NOTIFY_AND_AUTO_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。 示例值:NOTIFY_AND_MANUAL_RENEW |
| NodeType | String | 节点规格 示例值:LOGSTASH.S1.SMALL2 |
| NodeNum | Integer | 节点个数 示例值:1 |
| DiskType | String | 节点磁盘类型 示例值:SSD |
| DiskSize | Integer | 节点磁盘大小,单位GB 示例值:100 |
| LogstashVersion | String | Logstash版本号 示例值:6.8.13 |
| LicenseType | String | License类型 示例值:oss |
| CreateTime | String | 实例创建时间 示例值:2022-10-12 11:25:37 |
| UpdateTime | String | 实例最后修改操作时间 示例值:2022-10-12 11:25:37 |
| Deadline | String | 实例到期时间 示例值:2017-12-04 00:00:00 |
| Nodes | Array of LogstashNodeInfo | 实例节点类型 |
| BindedESInstanceId | String | 实例绑定的ES集群ID 示例值:es-hi*8k |
| YMLConfig | String | 实例的YML配置 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"slowlog.threshold.warn":"3s"} |
| ExtendedFiles | Array of LogstashExtendedFile | 扩展文件列表 注意:此字段可能返回 null,表示取不到有效值。 |
| OperationDuration | OperationDuration | 可维护时间段 注意:此字段可能返回 null,表示取不到有效值。 |
| CpuNum | Integer | CPU数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| TagList | Array of TagInfo | 实例标签信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:[{"TagKey":"自动化","TagValue":"自动化"}] |
| MemSize | Integer | 内存大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| DeployMode | Integer | 部署模式,0:单可用区、1:多可用区 示例值:0 |
| MultiZoneInfo | Array of ZoneDetail | 多可用区部署时可用区的详细信息 |
LogstashNodeInfo
Logstash节点信息
被如下接口引用:DescribeLogstashInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| NodeId | String | 节点ID 示例值:10616***7299 |
| Ip | String | 节点IP 示例值:127...* |
| Port | Integer | 节点端口 示例值:8080 |
| Zone | String | 节点所在zone 示例值:ap-beijing-1 |
LogstashPipeline
Logstash管道信息
被如下接口引用:SaveAndDeployLogstashPipeline。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PipelineId | String | 否 | 管道ID 示例值:pipe_test |
| PipelineDesc | String | 否 | 管道描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:test_pipe |
| Config | String | 否 | 管道配置内容 示例值:input { elasticsearch { user => "elastic"} } output { elasticsearch { user => "elastic" } } |
| Workers | Integer | 否 | 管道的Worker数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| BatchSize | Integer | 否 | 管道批处理大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
| BatchDelay | Integer | 否 | 管道批处理延迟 注意:此字段可能返回 null,表示取不到有效值。 示例值:50 |
| QueueType | String | 否 | 管道缓冲队列类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:memory |
| QueueMaxBytes | String | 否 | 管道缓冲队列大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:1GB |
| QueueCheckPointWrites | Integer | 否 | 管道缓冲队列检查点写入数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
LogstashPipelineInfo
Logstash管道信息
被如下接口引用:DescribeLogstashPipelines。
| 名称 | 类型 | 描述 |
|---|---|---|
| PipelineId | String | 管道ID 示例值:6823pipeline |
| PipelineDesc | String | 管道描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:日志中有warn |
| Config | String | 管道配置内容 示例值:input { beats { port => "8080" } } output { stdout { codec => debug } } |
| Status | Integer | 管道状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
| Workers | Integer | 管道的Worker数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:4 |
| BatchSize | Integer | 管道批处理大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:125 |
| BatchDelay | Integer | 管道批处理延迟 注意:此字段可能返回 null,表示取不到有效值。 示例值:50 |
| QueueType | String | 管道缓冲队列类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:memory |
| QueueMaxBytes | String | 管道缓冲队列大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:2048 |
| QueueCheckPointWrites | Integer | 管道缓冲队列检查点写入数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-04-09 14:53:41 |
| UpdateTime | String | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-04-09 14:54:05 |
MasterNodeInfo
实例专用主节点相关信息
被如下接口引用:DescribeInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| EnableDedicatedMaster | Boolean | 是否启用了专用主节点 示例值:true |
| MasterNodeType | String | 专用主节点规格 示例值:dedicatedMaster |
| MasterNodeNum | Integer | 专用主节点个数 示例值:1 |
| MasterNodeCpuNum | Integer | 专用主节点CPU核数 示例值:8 |
| MasterNodeMemSize | Integer | 专用主节点内存大小,单位GB 示例值:16384 |
| MasterNodeDiskSize | Integer | 专用主节点磁盘大小,单位GB 示例值:51200 |
| MasterNodeDiskType | String | 专用主节点磁盘类型 示例值:CLOUD_SSD |
Metric
智能运维指标
被如下接口引用:DescribeDiagnose。
| 名称 | 类型 | 描述 |
|---|---|---|
| Dimensions | Array of Dimension | 指标维度族 |
| Value | Float | 指标值 示例值:0.1 |
MetricAllData
全部指标数据
被如下接口引用:DescribeServerlessMetrics。
| 名称 | 类型 | 描述 |
|---|---|---|
| IndexTraffic | Float | 索引流量 示例值:12.34454 |
| Storage | Float | 存储大小 示例值:12.3432 |
| ReadReqTimes | Integer | 读请求次数 示例值:21 |
| WriteReqTimes | Integer | 写请求次数 示例值:32 |
| DocCount | Integer | 文档数量 示例值:32 |
MetricDetail
智能运维指标详情
被如下接口引用:DescribeDiagnose。
| 名称 | 类型 | 描述 |
|---|---|---|
| Key | String | 指标详情名 示例值:当前熔断节点 |
| Metrics | Array of Metric | 指标详情值 |
MetricMapByIndexId
指标数据map
被如下接口引用:DescribeServerlessMetrics。
| 名称 | 类型 | 描述 |
|---|---|---|
| IndexId | String | 实例id 示例值:index-xxxxxxxx |
| MetricAllData | MetricAllData | 指标数据 示例值:{"IndexTraffic":12302.06,"Storage":43044.33,"ReadReqTimes":2,"WriteReqTimes":111,"DocCount":0} |
NodeInfo
集群中一种节点类型(如热数据节点,冷数据节点,专用主节点等)的规格描述信息,包括节点类型,节点个数,节点规格,磁盘类型,磁盘大小等, Type不指定时默认为热数据节点;如果节点为master节点,则DiskType和DiskSize参数会被忽略(主节点无数据盘)
被如下接口引用:CreateInstance, DescribeInstances, UpdateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NodeNum | Integer | 是 | 节点数量 示例值:3 |
| NodeType | String | 是 | 节点规格 示例值:ES.S1.4XLARGE64 |
| Type | String | 否 | 节点类型 默认值为hotData 示例值:dedicatedMaster |
| DiskType | String | 否 | 节点磁盘类型 示例值:CLOUD_SSD |
| DiskSize | Integer | 否 | 节点磁盘容量(单位GB) 示例值:50 |
| LocalDiskInfo | LocalDiskInfo | 否 | 节点本地盘信息 注意:此字段可能返回 null,表示取不到有效值。 |
| DiskCount | Integer | 否 | 节点磁盘块数 示例值:1 |
| DiskEncrypt | Integer | 否 | 节点磁盘是否加密 0: 不加密,1: 加密;默认不加密 示例值:0 |
| CpuNum | Integer | 否 | cpu数目 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| MemSize | Integer | 否 | 内存大小,单位GB 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| DiskEnhance | Integer | 否 | / 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| GpuInfo | GpuInfo | 否 | 节点Gpu信息 注意:此字段可能返回 null,表示取不到有效值。 |
NodeView
节点维度视图数据
被如下接口引用:DescribeViews。
| 名称 | 类型 | 描述 |
|---|---|---|
| NodeId | String | 节点ID 示例值:NodeId |
| NodeIp | String | 节点IP 示例值:NodeIp |
| Visible | Float | 节点是否可见 示例值:Visible |
| Break | Float | 是否熔断 示例值:Break |
| DiskSize | Integer | 节点总磁盘大小 示例值:DiskSize |
| DiskUsage | Float | 磁盘使用率 示例值:DiskUsage |
| MemSize | Integer | 节点内存大小,单位GB 示例值:MemSize |
| MemUsage | Float | 内存使用率 示例值:MemUsage |
| CpuNum | Integer | 节点cpu个数 示例值:CpuNum |
| CpuUsage | Float | cpu使用率 示例值:CpuUsage |
| Zone | String | 可用区 示例值:Zone |
| NodeRole | String | 节点角色 示例值:NodeRole |
| NodeHttpIp | String | 节点HTTP IP 示例值:NodeHttpIp |
| JvmMemUsage | Float | JVM内存使用率 示例值:JvmMemUsage |
| ShardNum | Integer | 节点分片数 示例值:ShardNum |
| DiskIds | Array of String | 节点上磁盘ID列表 示例值:DiskIds |
| Hidden | Boolean | 是否为隐藏可用区 示例值:Hidden |
| IsCoordinationNode | Boolean | 是否充当协调节点的角色 示例值:false |
| CVMStatus | String | CVM运行状态 示例值:RUNNING |
| CVMDisasterRecoverGroupId | String | cvm绑定的置放群组的id 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxxabd |
| CVMDisasterRecoverGroupStatus | Integer | cvm绑定置放群组的状态。2: 已绑定;1: 绑定中;0: 未开启 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
Operation
ES集群操作详细信息
被如下接口引用:DescribeInstanceOperations, DescribeLogstashInstanceOperations。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 操作唯一id 示例值:190587 |
| StartTime | String | 操作开始时间 示例值:2023-03-06 16:24:44 |
| Type | String | 操作类型 示例值:UpdateKibanaConfig |
| Detail | OperationDetail | 操作详情 示例值:{"OldInfo":[{"Key":"KibanaConfig","Value":"{}"}],"NewInfo":[{"Key":"KibanaConfig","Value":"{"xpack.reporting.csv.maxSizeBytes":"104857600"}"}]} |
| Result | String | 操作结果 示例值:completed |
| Tasks | Array of TaskDetail | 流程任务信息 示例值:[{"Name":"upgradeCheck","Progress":1,"FinishTime":"2020-04-26 14:45:55","SubTasks":[{"Name":"userAgentPipelinesCheck","Type":"cluster","Level":1,"Result":false,"Status":1,"FinishTime":"2020-04-26 14:45:51","ErrMsg":"","FailedIndices":[]}] |
| Progress | Float | 操作进度 示例值:1 |
| RollbackTag | Integer | 回滚标记, 0未回滚 ,1回滚中,2已回滚 示例值:0 |
| SubAccountUin | String | 操作者Uin 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000xxxx |
| AutoScaleTag | Integer | 自动扩容标识:0-非自动,1-自动 示例值:0 |
OperationDetail
操作详情
被如下接口引用:DescribeInstanceOperations, DescribeLogstashInstanceOperations。
| 名称 | 类型 | 描述 |
|---|---|---|
| OldInfo | Array of KeyValue | 实例原始配置信息 |
| NewInfo | Array of KeyValue | 实例更新后配置信息 |
OperationDuration
集群可运维时间
被如下接口引用:CreateInstance, CreateLogstashInstance, DescribeInstances, DescribeLogstashInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Periods | Array of Integer | 是 | 维护周期,表示周一到周日,可取值[0, 6] 注意:此字段可能返回 null,表示取不到有效值。 示例值:[0,1,2] |
| TimeStart | String | 是 | 维护开始时间 示例值:02:00 |
| TimeEnd | String | 是 | 维护结束时间 示例值:06:00 |
| TimeZone | String | 是 | 时区,以UTC形式表示 示例值:UTC+8 |
OperationDurationUpdated
集群可运维时间
被如下接口引用:UpdateInstance, UpdateLogstashInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Periods | Array of Integer | 是 | 维护周期,表示周一到周日,可取值[0, 6] 示例值:[0,1,2] |
| TimeStart | String | 是 | 维护开始时间 示例值:02:00 |
| TimeEnd | String | 是 | 维护结束时间 示例值:06:00 |
| TimeZone | String | 是 | 时区,以UTC形式表示 示例值:UTC+8 |
| MoreInstances | Array of String | 否 | ES集群ID数组 示例值:[es-c3tz27ww] |
OptionalWebServiceInfo
可选web组件信息
被如下接口引用:DescribeInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:cerebro |
| Status | Integer | 状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| PublicUrl | String | 公网url 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://es-xxxxxxxx.cerebro.tencentelasticsearch.com:9000 |
| PrivateUrl | String | 内网url 注意:此字段可能返回 null,表示取不到有效值。 示例值:http://es-xxxxxxxx.interna.cerebro.tencentelasticsearch.com:9000 |
| PublicAccess | String | 公网访问权限 注意:此字段可能返回 null,表示取不到有效值。 示例值:OPEN |
| PrivateAccess | String | 内网访问权限 注意:此字段可能返回 null,表示取不到有效值。 示例值:CLOSE |
| Version | String | 版本号 注意:此字段可能返回 null,表示取不到有效值。 示例值:0.9.4 |
| PrivateVip | String | web服务内网vip 注意:此字段可能返回 null,表示取不到有效值。 示例值:10.0.0.1 |
| CustomPrivateUrl | String | 自定义cerebro内网url 注意:此字段可能返回 null,表示取不到有效值。 示例值:http://xxxxx.com:9000 |
OutboundPublicAcl
节点出站访问信息
被如下接口引用:DescribeInstances, UpdateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NodeType | String | 是 | 允许节点出站访问的节点类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:ES.S1.8XLARGE128 |
| WhiteHostList | Array of String | 否 | 允许节点出站访问的白名单 注意:此字段可能返回 null,表示取不到有效值。 示例值:[""] |
ProcessDetail
任务进度详情
被如下接口引用:DescribeInstanceOperations, DescribeLogstashInstanceOperations。
| 名称 | 类型 | 描述 |
|---|---|---|
| Completed | Integer | 已完成数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
| Remain | Integer | 剩余数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
| Total | Integer | 总数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:4 |
| TaskType | Integer | 任务类型: 60:重启型任务 70:分片迁移型任务 80:节点变配任务 注意:此字段可能返回 null,表示取不到有效值。 示例值:60 |
ServerlessDi
创建serverless索引时创建数据接入
被如下接口引用:CreateServerlessInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DiSourceType | String | 否 | 数据链路采集源类型,如cvm_collector、tke_collector 示例值:cvm_collector |
| DiSourceCvm | DiSourceCvm | 否 | cvm数据源 |
| DiSourceTke | DiSourceTke | 否 | tke数据源 |
ServerlessIndexMetaField
索引元数据字段
被如下接口引用:DescribeServerlessInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| AppId | Integer | 索引所属集群APP ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:10004222 |
| IndexName | String | 索引名 注意:此字段可能返回 null,表示取不到有效值。 示例值:log-test |
| IndexMetaJson | String | 索引元数据JSON 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"mappings":{"properties":{"filed1":{"analyzer":"custom_analyzer","type":"text"}}}} |
| IndexDocs | Integer | 索引文档数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| IndexStorage | Integer | 索引存储大小,单位Byte 注意:此字段可能返回 null,表示取不到有效值。 示例值:30 |
| IndexCreateTime | String | 索引创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-03-01 10:00:00 |
| InstanceId | String | 索引实例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:index-abcdefgh |
| IndexOptionsField | ServerlessIndexOptionsField | 索引自治字段 注意:此字段可能返回 null,表示取不到有效值。 |
| IndexSettingsField | ServerlessIndexSettingsField | 索引配置字段 注意:此字段可能返回 null,表示取不到有效值。 |
| IndexNetworkField | ServerlessIndexNetworkField | 索引所属连接相关信息 注意:此字段可能返回 null,表示取不到有效值。 |
| KibanaUrl | String | Kibana公网域名 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://space-xxxxxx.ap-nanjing.kibana.qcloudes.com:5601 |
| KibanaPrivateUrl | String | Kibana内网域名 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://space-xxxxxx-internal.ap-nanjing.kibana.qcloudes.com:5601 |
| IndexAccessUrl | String | 索引内网访问地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:space-xxxxxx.ap-nanjing.qcloudes.com |
| Status | Integer | 状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| SpaceId | String | 索引空间ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:space-xxx |
| SpaceName | String | 索引空间名 注意:此字段可能返回 null,表示取不到有效值。 示例值:test1 |
| StorageType | Integer | 存储类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| TagList | Array of TagInfo | 标签信息 |
| IndexTraffic | Float | 索引流量,单位byte 注意:此字段可能返回 null,表示取不到有效值。 示例值:3782478.47 |
ServerlessIndexNetworkField
Serverless实例,网络、索引、kibana等连接信息
被如下接口引用:DescribeServerlessInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| Region | String | 地域 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-guangzhou |
| Zone | String | 区域 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-guangzhou-1 |
| VpcUid | String | vpc唯一ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:vpc-abcdef |
| SubnetUid | String | 子网唯一ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:sub-abcdef |
| Username | String | 用户名 注意:此字段可能返回 null,表示取不到有效值。 示例值:tom |
| Password | String | 密码 注意:此字段可能返回 null,表示取不到有效值。 示例值:abcd1234 |
ServerlessIndexOptionsField
索引自治字段
被如下接口引用:DescribeServerlessInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ExpireMaxAge | String | 否 | 过期时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:3d |
| TimestampField | String | 否 | 时间分区字段 注意:此字段可能返回 null,表示取不到有效值。 示例值:@timestamp |
| SinkCycleAge | String | 否 | 标准存储时长 注意:此字段可能返回 null,表示取不到有效值。 示例值:7d |
| StandardStorageAge | String | 否 | 标准存储时长 注意:此字段可能返回 null,表示取不到有效值。 示例值:3d |
ServerlessIndexSettingsField
索引配置字段
被如下接口引用:DescribeServerlessInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NumberOfShards | String | 否 | 索引主分片数 注意:此字段可能返回 null,表示取不到有效值。 示例值:5 |
| RefreshInterval | String | 否 | 索引刷新频率 注意:此字段可能返回 null,表示取不到有效值。 示例值:20s |
| CustomSetting | String | 否 | 自定义参数 示例值:5 |
ServerlessSpace
Serverless索引空间信息
被如下接口引用:DescribeServerlessSpaces。
| 名称 | 类型 | 描述 |
|---|---|---|
| SpaceId | String | Serverless索引空间ID 示例值:space-xxxx |
| SpaceName | String | Serverless索引空间名 示例值:spaceName |
| Status | Integer | Serverless索引空间状态,0正常,-1已删除 示例值:1 |
| CreateTime | String | 创建日期 示例值:2022-01-01 11:00:00 |
| IndexCount | Integer | 空间内索引数量 示例值:1 |
| KibanaUrl | String | kibana公网uri 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://space-xxxxxx.ap-nanjing.kibana.qcloudes.com:5601 |
| KibanaPrivateUrl | String | kibana内网url 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://space-xxxxxx-internal.ap-nanjing.kibana.qcloudes.com:5601 |
| IndexAccessUrl | String | 空间内网访问地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:space-xxxxxx.ap-nanjing.qcloudes.com |
| KibanaPublicAcl | EsAcl | 空间白名单 注意:此字段可能返回 null,表示取不到有效值。 |
| KibanaEmbedUrl | String | 空间检索分析域名 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://space-xxxxxx.kibana-embed.qcloudes.com:5601 |
| DiDataList | DiData | 数据联路 注意:此字段可能返回 null,表示取不到有效值。 |
| VpcInfo | Array of VpcInfo | 空间vpc信息 注意:此字段可能返回 null,表示取不到有效值。 |
| Region | String | 地域 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-shanghai |
| Zone | String | 可用区 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-shanghai-3 |
| EnableKibanaPublicAccess | Integer | kibana公网开关,0关闭,1开启 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| EnableKibanaPrivateAccess | Integer | kibana内网开关,0关闭,1开启 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| AppId | Integer | 空间所属appid 注意:此字段可能返回 null,表示取不到有效值。 示例值:10004222 |
| KibanaLanguage | String | //默认en, 可选zh-CN 注意:此字段可能返回 null,表示取不到有效值。 示例值:en |
| ClusterType | Integer | 0 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| TagList | Array of TagInfo | 空间标签信息 注意:此字段可能返回 null,表示取不到有效值。 |
| EnableMcpAccess | Integer | 是否开启mcp服务 示例值:0 |
| McpAccess | String | mcp的访问地址 示例值:http://ip:port/sse |
ServerlessSpaceUser
ServerlessSpaceUser
被如下接口引用:DescribeServerlessSpaceUser。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Username | String | 否 | 用户名 注意:此字段可能返回 null,表示取不到有效值。 示例值:admin |
| Password | String | 否 | 用户密码 注意:此字段可能返回 null,表示取不到有效值。 示例值:aefafaefax |
| CreateTime | String | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-04-25 15:55:31 |
| Status | Integer | 否 | 用户状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| IndicesScope | Array of String | 否 | 有权限的索引数组 注意:此字段可能返回 null,表示取不到有效值。 示例值:["index1"] |
| PrivilegeType | Integer | 否 | 权限类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
SettingDetail
智能运维集群配置详情
被如下接口引用:DescribeDiagnose。
| 名称 | 类型 | 描述 |
|---|---|---|
| Key | String | 配置key 示例值:settings.a |
| Value | String | 配置当前值 示例值:value.s |
| Advise | String | 配置处理建议 示例值:建议修改配置 |
Snapshots
集群快照数据结构
被如下接口引用:DescribeClusterSnapshot。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SnapshotName | String | 否 | 快照名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:snapshot-abc12 |
| Uuid | String | 否 | 快照Uuid 注意:此字段可能返回 null,表示取不到有效值。 示例值:4pf6R*a6DA |
| Repository | String | 否 | 仓库名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:testRepository |
| Version | String | 否 | 该快照所属集群的版本号 注意:此字段可能返回 null,表示取不到有效值。 示例值:7.14.2 |
| Indices | Array of String | 否 | 备份的索引列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:["jmeter_index"] |
| DataStreams | Array of String | 否 | 备份的datastream列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:["ilm-history-10"] |
| State | String | 否 | 备份的状态 FAILED 备份失败 IN_PROGRESS 备份执行中 PARTIAL 备份部分成功,部分失败,备份失败的索引和原因会在Failures字段中展示 SUCCESS 备份成功 注意:此字段可能返回 null,表示取不到有效值。 示例值:SUCCESS |
| StartTime | String | 否 | 快照备份的开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-19T18:02:27.977Z |
| EndTime | String | 否 | 快照备份的结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-19T18:02:32.378Z |
| DurationInMillis | Integer | 否 | 快照备份的耗时时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:4401 |
| TotalShards | Integer | 否 | 备份的总分片数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
| FailedShards | Integer | 否 | 备份失败的分片数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| SuccessfulShards | Integer | 否 | 备份成功的分片数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
| Failures | Array of Failures | 否 | 备份失败的索引分片和失败原因 注意:此字段可能返回 null,表示取不到有效值。 示例值:[{...}] |
| UserBackUp | String | 否 | 是否用户备份 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
SubTaskDetail
实例操作记录流程任务中的子任务信息(如升级检查任务中的各个检查项)
被如下接口引用:DescribeInstanceOperations, DescribeLogstashInstanceOperations。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 子任务名 示例值:shardLimitCheck |
| Result | Boolean | 子任务结果 示例值:true |
| ErrMsg | String | 子任务错误信息 示例值:shards exceeded limit |
| Type | String | 子任务类型 示例值:cluster |
| Status | Integer | 子任务状态,0处理中 1成功 -1失败 示例值:10 |
| FailedIndices | Array of String | 升级检查失败的索引名 示例值:jemter_index |
| FinishTime | String | 子任务结束时间 示例值:2025-03-20T07:57:37.798Z |
| Level | Integer | 子任务等级,1警告 2失败 示例值:10 |
TagInfo
实例标签信息
被如下接口引用:CreateInstance, CreateLogstashInstance, CreateServerlessInstance, CreateServerlessSpaceV2, DescribeInstances, DescribeLogstashInstances, DescribeServerlessInstances, DescribeServerlessSpaces。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 是 | 标签键 示例值:负责人 |
| TagValue | String | 是 | 标签值 示例值:jack |
TaskDetail
实例操作记录中的流程任务信息
被如下接口引用:DescribeInstanceOperations, DescribeLogstashInstanceOperations。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 任务名 示例值:prepareResource |
| Progress | Float | 任务进度 示例值:1.2 |
| FinishTime | String | 任务完成时间 示例值:2023-02-01 12:49:37 |
| SubTasks | Array of SubTaskDetail | 子任务 |
| ElapsedTime | Integer | 任务花费时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| ProcessInfo | ProcessDetail | 任务进度详情 注意:此字段可能返回 null,表示取不到有效值。 |
VpcInfo
vpc信息
被如下接口引用:CreateServerlessSpaceV2, DescribeServerlessSpaces。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VpcId | String | 否 | vpcId信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:vpc-xxxxxxx |
| SubnetId | String | 否 | SubnetId信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:subnet-fafafag |
| VpcUid | Integer | 否 | VpcUid信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:8808090 |
| SubnetUid | Integer | 否 | SubnetUid 信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:8808090 |
| AvailableIpAddressCount | Integer | 否 | 可用ip数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
WebNodeTypeInfo
可视化节点配置
被如下接口引用:CreateInstance, DescribeInstances, UpdateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NodeNum | Integer | 是 | 可视化节点个数,固定为1 示例值:1 |
| NodeType | String | 是 | 可视化节点规格 示例值:ES.S1.SMALL2 |
ZoneDetail
多可用区部署时可用区的详细信息
被如下接口引用:CreateInstance, CreateLogstashInstance, DescribeInstances, DescribeLogstashInstances, UpdateInstance, UpdateLogstashInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Zone | String | 是 | 可用区 示例值:ap-beijing-1 |
| SubnetId | String | 是 | 子网ID 示例值:subnet-123abc |
| Hidden | Boolean | 否 | 是否为隐藏可用区 示例值:false |