Elasticsearch Service

产品动态

新手指引

产品简介

购买指南

ES 内核增强

快速入门

数据应用指南

Elasticsearch 指南

Logstash 指南

Beats 指南

最佳实践

API 文档

视频专区

常见问题

服务等级协议

联系我们

词汇表
文档捉虫大赛火热进行中，好礼多多> HOT
文档中心 > Elasticsearch Service > API 文档 > 数据结构

数据结构

最近更新时间：2022-12-12 01:26:06

我的收藏

本页目录：

BackingIndexMetaField

后备索引元数据字段

被如下接口引用：DescribeIndexList, DescribeIndexMeta。

名称 类型 描述
IndexName String 后备索引名
注意：此字段可能返回 null，表示取不到有效值。
IndexStatus String 后备索引状态
注意：此字段可能返回 null，表示取不到有效值。
IndexStorage Integer 后备索引存储大小
注意：此字段可能返回 null，表示取不到有效值。
IndexPhrase String 后备索引当前生命周期
注意：此字段可能返回 null，表示取不到有效值。
IndexCreateTime String 后备索引创建时间
注意：此字段可能返回 null，表示取不到有效值。

ClusterView

集群维度视图数据

被如下接口引用：DescribeViews。

名称 类型 描述
Health Float 集群健康状态
Visible Float 集群是否可见
Break Float 集群是否熔断
AvgDiskUsage Float 平均磁盘使用率
AvgMemUsage Float 平均内存使用率
AvgCpuUsage Float 平均cpu使用率
TotalDiskSize Integer 集群总存储大小
TargetNodeTypes Array of String 客户端请求节点
NodeNum Integer 在线节点数
TotalNodeNum Integer 总节点数
DataNodeNum Integer 数据节点数
IndexNum Integer 索引数
DocNum Integer 文档数
DiskUsedInBytes Integer 磁盘已使用字节数
ShardNum Integer 分片个数
PrimaryShardNum Integer 主分片个数
RelocatingShardNum Integer 迁移中的分片个数
InitializingShardNum Integer 初始化中的分片个数
UnassignedShardNum Integer 未分配的分片个数
TotalCosStorage Integer 企业版COS存储容量大小，单位GB
SearchableSnapshotCosBucket String 企业版集群可搜索快照cos存放的bucket名称
注意：此字段可能返回 null，表示取不到有效值。
SearchableSnapshotCosAppId String 企业版集群可搜索快照cos所属appid
注意：此字段可能返回 null，表示取不到有效值。

CosBackup

ES cos自动备份信息

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

名称 类型 必选 描述
IsAutoBackup Boolean 是 是否开启cos自动备份
BackupTime String 是 自动备份执行时间（精确到小时）, e.g. "22:00"

DictInfo

ik插件词典信息

被如下接口引用：DescribeInstances。

名称 类型 描述
Key String 词典键值
Name String 词典名称
Size Integer 词典大小，单位B

EsAcl

ES集群配置项

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

名称 类型 必选 描述
BlackIpList Array of String 否 kibana访问黑名单
WhiteIpList Array of String 否 kibana访问白名单

EsConfigSetInfo

配置组信息

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

名称 类型 必选 描述
Type String 是 配置组类型，如ldap,ad等
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 启用词词典列表
Stopwords Array of DictInfo 停用词词典列表
QQDict Array of DictInfo QQ分词词典列表
Synonym Array of DictInfo 同义词词典列表
UpdateType String 更新词典类型

EsPublicAcl

ES公网访问访问控制信息

被如下接口引用：UpdateInstance。

名称 类型 必选 描述
BlackIpList Array of String 否 访问黑名单
WhiteIpList Array of String 否 访问白名单

IndexMetaField

索引元数据字段

被如下接口引用：DescribeIndexList, DescribeIndexMeta。

名称 类型 描述
IndexType String 索引类型
注意：此字段可能返回 null，表示取不到有效值。
IndexName String 索引名
注意：此字段可能返回 null，表示取不到有效值。
IndexStatus String 索引状态
注意：此字段可能返回 null，表示取不到有效值。
IndexStorage Integer 索引存储大小，单位Byte
注意：此字段可能返回 null，表示取不到有效值。
IndexCreateTime String 索引创建时间
注意：此字段可能返回 null，表示取不到有效值。
BackingIndices Array of BackingIndexMetaField 后备索引
注意：此字段可能返回 null，表示取不到有效值。
ClusterId String 索引所属集群ID
注意：此字段可能返回 null，表示取不到有效值。
ClusterName String 索引所属集群名
注意：此字段可能返回 null，表示取不到有效值。
ClusterVersion String 索引所属集群版本
注意：此字段可能返回 null，表示取不到有效值。
IndexPolicyField IndexPolicyField 索引生命周期字段
注意：此字段可能返回 null，表示取不到有效值。
IndexOptionsField IndexOptionsField 索引自治字段
注意：此字段可能返回 null，表示取不到有效值。
IndexSettingsField IndexSettingsField 索引配置字段
注意：此字段可能返回 null，表示取不到有效值。
AppId Integer 索引所属集群APP ID
注意：此字段可能返回 null，表示取不到有效值。
IndexDocs Integer 索引文档数
注意：此字段可能返回 null，表示取不到有效值。

IndexOptionsField

索引自治字段

被如下接口引用：DescribeIndexList, DescribeIndexMeta。

名称 类型 必选 描述
ExpireMaxAge String 否 过期时间
注意：此字段可能返回 null，表示取不到有效值。
ExpireMaxSize String 否 过期大小
注意：此字段可能返回 null，表示取不到有效值。
RolloverMaxAge String 否 滚动周期
注意：此字段可能返回 null，表示取不到有效值。
RolloverDynamic String 否 是否开启动态滚动
注意：此字段可能返回 null，表示取不到有效值。
ShardNumDynamic String 否 是否开启动态分片
注意：此字段可能返回 null，表示取不到有效值。
TimestampField String 否 时间分区字段
注意：此字段可能返回 null，表示取不到有效值。
WriteMode String 否 写入模式
注意：此字段可能返回 null，表示取不到有效值。

IndexPolicyField

索引生命周期字段

被如下接口引用：DescribeIndexList, DescribeIndexMeta。

名称 类型 必选 描述
WarmEnable String 否 是否开启warm阶段
注意：此字段可能返回 null，表示取不到有效值。
WarmMinAge String 否 warm阶段转入时间
注意：此字段可能返回 null，表示取不到有效值。
ColdEnable String 否 是否开启cold阶段
注意：此字段可能返回 null，表示取不到有效值。
ColdMinAge String 否 cold阶段转入时间
注意：此字段可能返回 null，表示取不到有效值。
FrozenEnable String 否 是否开启frozen阶段
注意：此字段可能返回 null，表示取不到有效值。
FrozenMinAge String 否 frozen阶段转入时间
注意：此字段可能返回 null，表示取不到有效值。
ColdAction String 否 /
注意：此字段可能返回 null，表示取不到有效值。

IndexSettingsField

索引配置字段

被如下接口引用：DescribeIndexList, DescribeIndexMeta。

名称 类型 必选 描述
NumberOfShards String 否 索引主分片数
注意：此字段可能返回 null，表示取不到有效值。
NumberOfReplicas String 否 索引副本分片数
注意：此字段可能返回 null，表示取不到有效值。
RefreshInterval String 否 索引刷新频率
注意：此字段可能返回 null，表示取不到有效值。

InstanceInfo

实例详细信息

被如下接口引用：DescribeInstances。

名称 类型 描述
InstanceId String 实例ID
InstanceName String 实例名称
Region String 地域
Zone String 可用区
AppId Integer 用户ID
Uin String 用户UIN
VpcUid String 实例所属VPC的UID
SubnetUid String 实例所属子网的UID
Status Integer 实例状态，0:处理中,1:正常,-1停止,-2:销毁中,-3:已销毁, 2:创建集群时初始化中
RenewFlag String 自动续费标识。取值范围：
RENEW_FLAG_AUTO：自动续费
RENEW_FLAG_MANUAL：不自动续费
默认取值：
RENEW_FLAG_DEFAULT：不自动续费
若该参数指定为 RENEW_FLAG_AUTO，在账户余额充足的情况下，实例到期后将按月自动续费。
ChargeType String 实例计费模式。取值范围： PREPAID：表示预付费，即包年包月 POSTPAID_BY_HOUR：表示后付费，即按量计费 CDHPAID：CDH付费，即只对CDH计费，不对CDH上的实例计费。
ChargePeriod Integer 包年包月购买时长,单位:月
NodeType String 节点规格
  • ES.S1.SMALL2：1核2G
  • ES.S1.MEDIUM4：2核4G
  • ES.S1.MEDIUM8：2核8G
  • ES.S1.LARGE16：4核16G
  • ES.S1.2XLARGE32：8核32G
  • ES.S1.4XLARGE32：16核32G
  • ES.S1.4XLARGE64：16核64G
    		•
    NodeNum Integer 节点个数
    CpuNum Integer 节点CPU核数
    MemSize Integer 节点内存大小，单位GB
    DiskType String 节点磁盘类型
    DiskSize Integer 节点磁盘大小，单位GB
    EsDomain String ES域名
    EsVip String ES VIP
    EsPort Integer ES端口
    KibanaUrl String Kibana访问url
    EsVersion String ES版本号
    EsConfig String ES配置项
    EsAcl EsAcl Kibana访问控制配置
    CreateTime String 实例创建时间
    UpdateTime String 实例最后修改操作时间
    Deadline String 实例到期时间
    InstanceType Integer 实例类型（实例类型标识，当前只有1,2两种）
    IkConfig EsDictionaryInfo Ik分词器配置
    MasterNodeInfo MasterNodeInfo 专用主节点配置
    CosBackup CosBackup cos自动备份配置
    AllowCosBackup Boolean 是否允许cos自动备份
    TagList Array of TagInfo 实例拥有的标签列表
    LicenseType String License类型
  • oss：开源版
  • basic：基础版
  • platinum：白金版
    • 默认值platinum
    EnableHotWarmMode Boolean 是否为冷热集群
  • true: 冷热集群
  • false: 非冷热集群

    • 注意：此字段可能返回 null，表示取不到有效值。
    WarmNodeType String 温节点规格
  • ES.S1.SMALL2：1核2G
  • ES.S1.MEDIUM4：2核4G
  • ES.S1.MEDIUM8：2核8G
  • ES.S1.LARGE16：4核16G
  • ES.S1.2XLARGE32：8核32G
  • ES.S1.4XLARGE32：16核32G
  • ES.S1.4XLARGE64：16核64G

    • 注意：此字段可能返回 null，表示取不到有效值。
    WarmNodeNum Integer 温节点个数
    注意：此字段可能返回 null，表示取不到有效值。
    WarmCpuNum Integer 温节点CPU核数
    注意：此字段可能返回 null，表示取不到有效值。
    WarmMemSize Integer 温节点内存内存大小，单位GB
    注意：此字段可能返回 null，表示取不到有效值。
    WarmDiskType String 温节点磁盘类型
    注意：此字段可能返回 null，表示取不到有效值。
    WarmDiskSize Integer 温节点磁盘大小，单位GB
    注意：此字段可能返回 null，表示取不到有效值。
    NodeInfoList Array of NodeInfo 集群节点信息列表
    注意：此字段可能返回 null，表示取不到有效值。
    EsPublicUrl String Es公网地址
    注意：此字段可能返回 null，表示取不到有效值。
    MultiZoneInfo Array of ZoneDetail 多可用区网络信息
    注意：此字段可能返回 null，表示取不到有效值。
    DeployMode Integer 部署模式
  • 0：单可用区
  • 1：多可用区

    • 注意：此字段可能返回 null，表示取不到有效值。
    PublicAccess String ES公网访问状态
  • OPEN：开启
  • CLOSE：关闭
    注意：此字段可能返回 null，表示取不到有效值。
    		•
    EsPublicAcl EsAcl ES公网访问控制配置
    KibanaPrivateUrl String Kibana内网地址
    注意：此字段可能返回 null，表示取不到有效值。
    KibanaPublicAccess String Kibana公网访问状态
  • OPEN：开启
  • CLOSE：关闭
    注意：此字段可能返回 null，表示取不到有效值。
    		•
    KibanaPrivateAccess String Kibana内网访问状态
  • OPEN：开启
  • CLOSE：关闭
    注意：此字段可能返回 null，表示取不到有效值。
    		•
    SecurityType Integer 6.8（及以上版本）基础版是否开启xpack security认证
  • 1：不开启
  • 2：开启

    • 注意：此字段可能返回 null，表示取不到有效值。
    SceneType Integer 场景化模板类型：0、不开启；1、通用场景；2、日志场景；3、搜索场景
    注意：此字段可能返回 null，表示取不到有效值。
    KibanaConfig String Kibana配置项
    注意：此字段可能返回 null，表示取不到有效值。
    KibanaNodeInfo KibanaNodeInfo Kibana节点信息
    注意：此字段可能返回 null，表示取不到有效值。
    WebNodeTypeInfo WebNodeTypeInfo 可视化节点配置
    注意：此字段可能返回 null，表示取不到有效值。
    Jdk String JDK类型，oracle或kona
    注意：此字段可能返回 null，表示取不到有效值。
    Protocol String 集群网络通讯协议
    注意：此字段可能返回 null，表示取不到有效值。
    SecurityGroups Array of String 安全组id
    注意：此字段可能返回 null，表示取不到有效值。
    ColdNodeType String 冷节点规格
  • ES.S1.SMALL2：1核2G
  • ES.S1.MEDIUM4：2核4G
  • ES.S1.MEDIUM8：2核8G
  • ES.S1.LARGE16：4核16G
  • ES.S1.2XLARGE32：8核32G
  • ES.S1.4XLARGE32：16核32G
  • ES.S1.4XLARGE64：16核64G

    • 注意：此字段可能返回 null，表示取不到有效值。
    ColdNodeNum Integer 冷节点个数
    注意：此字段可能返回 null，表示取不到有效值。
    ColdCpuNum Integer 冷节点CPU核数
    注意：此字段可能返回 null，表示取不到有效值。
    ColdMemSize Integer 冷节点内存大小，单位GB
    注意：此字段可能返回 null，表示取不到有效值。
    ColdDiskType String 冷节点磁盘类型
    注意：此字段可能返回 null，表示取不到有效值。
    ColdDiskSize Integer 冷节点磁盘大小，单位GB
    注意：此字段可能返回 null，表示取不到有效值。
    FrozenNodeType String 冻节点规格
  • ES.S1.SMALL2：1核2G
  • ES.S1.MEDIUM4：2核4G
  • ES.S1.MEDIUM8：2核8G
  • ES.S1.LARGE16：4核16G
  • ES.S1.2XLARGE32：8核32G
  • ES.S1.4XLARGE32：16核32G
  • ES.S1.4XLARGE64：16核64G

    • 注意：此字段可能返回 null，表示取不到有效值。
    FrozenNodeNum Integer 冻节点个数
    注意：此字段可能返回 null，表示取不到有效值。
    FrozenCpuNum Integer 冻节点CPU核数
    注意：此字段可能返回 null，表示取不到有效值。
    FrozenMemSize Integer 冻节点内存大小，单位GB
    注意：此字段可能返回 null，表示取不到有效值。
    FrozenDiskType String 冻节点磁盘类型
    注意：此字段可能返回 null，表示取不到有效值。
    FrozenDiskSize Integer 冻节点磁盘大小，单位GB
    注意：此字段可能返回 null，表示取不到有效值。
    HealthStatus Integer 集群健康状态 -1 未知；0 Green; 1 Yellow; 2 Red
    注意：此字段可能返回 null，表示取不到有效值。
    EsPrivateUrl String https集群内网url
    注意：此字段可能返回 null，表示取不到有效值。
    EsPrivateDomain String https集群内网域名
    注意：此字段可能返回 null，表示取不到有效值。
    EsConfigSets Array of EsConfigSetInfo 集群的配置组信息
    注意：此字段可能返回 null，表示取不到有效值。
    OperationDuration OperationDuration 集群可维护时间段
    注意：此字段可能返回 null，表示取不到有效值。
    OptionalWebServiceInfos Array of OptionalWebServiceInfo web节点列表
    注意：此字段可能返回 null，表示取不到有效值。
    AutoIndexEnabled Boolean 自治索引开关
    注意：此字段可能返回 null，表示取不到有效值。
    EnableHybridStorage Boolean 是否支持存储计算分离
    注意：此字段可能返回 null，表示取不到有效值。
    ProcessPercent Float 流程进度
    注意：此字段可能返回 null，表示取不到有效值。
    KibanaAlteringPublicAccess String Kibana的altering外网告警策略
  • OPEN：开启
  • CLOSE：关闭
    注意：此字段可能返回 null，表示取不到有效值。
    		•

    InstanceLog

    ES集群日志详细信息

    被如下接口引用：DescribeInstanceLogs, DescribeLogstashInstanceLogs。

    名称 类型 描述
    Time String 日志时间
    Level String 日志级别
    Ip String 集群节点ip
    Message String 日志内容

    KeyValue

    OperationDetail使用此结构的数组描述新旧配置

    被如下接口引用：DescribeInstanceOperations, DescribeLogstashInstanceOperations。

    名称 类型 描述
    Key String 键
    Value String 值

    KibanaNodeInfo

    实例Kibana节点相关信息

    被如下接口引用：DescribeInstances。

    名称 类型 描述
    KibanaNodeType String Kibana节点规格
    KibanaNodeNum Integer Kibana节点个数
    KibanaNodeCpuNum Integer Kibana节点CPU数
    KibanaNodeMemSize Integer Kibana节点内存GB
    KibanaNodeDiskType String Kibana节点磁盘类型
    KibanaNodeDiskSize Integer Kibana节点磁盘大小

    KibanaView

    Kibana视图数据

    被如下接口引用：DescribeViews。

    名称 类型 描述
    Ip String Kibana节点IP
    DiskSize Integer 节点总磁盘大小
    DiskUsage Float 磁盘使用率
    MemSize Integer 节点内存大小
    MemUsage Float 内存使用率
    CpuNum Integer 节点cpu个数
    CpuUsage Float cpu使用率
    Zone String 可用区

    LocalDiskInfo

    节点本地盘信息

    被如下接口引用：CreateInstance, DescribeInstances, UpdateInstance。

    名称 类型 描述
    LocalDiskType String 本地盘类型
  • LOCAL_SATA：大数据型
  • NVME_SSD：高IO型
    		•
    LocalDiskSize Integer 本地盘单盘大小
    LocalDiskCount Integer 本地盘块数

    LogstashBindedES

    Logstash绑定的ES集群信息

    被如下接口引用：UpdateLogstashInstance。

    名称 类型 必选 描述
    ESInstanceId String 是 ES集群ID
    ESUserName String 是 ES集群用户名
    ESPassword String 是 ES集群密码

    LogstashExtendedFile

    Logstash扩展文件信息

    被如下接口引用：DescribeLogstashInstances, UpdateLogstashInstance。

    名称 类型 必选 描述
    Name String 是 扩展文件名称
    Size Integer 是 扩展文件大小，单位B

    LogstashInstanceInfo

    Logstash实例详细信息

    被如下接口引用：DescribeLogstashInstances。

    名称 类型 描述
    InstanceId String 实例ID
    InstanceName String 实例名称
    Region String 地域
    Zone String 可用区
    AppId Integer 用户ID
    Uin String 用户UIN
    VpcId String 实例所属VPC的ID
    SubnetId String 实例所属子网的ID
    Status Integer 实例状态，0:处理中,1:正常,-1停止,-2:销毁中,-3:已销毁
    ChargeType String 实例计费模式。取值范围： PREPAID：表示预付费，即包年包月 POSTPAID_BY_HOUR：表示后付费，即按量计费 CDHPAID：CDH付费，即只对CDH计费，不对CDH上的实例计费。
    ChargePeriod Integer 包年包月购买时长,单位:月
    RenewFlag String 自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 默认取值：NOTIFY_AND_AUTO_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。
    NodeType String 节点规格
  • LOGSTASH.S1.SMALL2：1核2G
  • LOGSTASH.S1.MEDIUM4：2核4G
  • LOGSTASH.S1.MEDIUM8：2核8G
  • LOGSTASH.S1.LARGE16：4核16G
  • LOGSTASH.S1.2XLARGE32：8核32G
  • LOGSTASH.S1.4XLARGE32：16核32G
  • LOGSTASH.S1.4XLARGE64：16核64G
    		•
    NodeNum Integer 节点个数
    DiskType String 节点磁盘类型
    DiskSize Integer 节点磁盘大小，单位GB
    LogstashVersion String Logstash版本号
    LicenseType String License类型
  • oss：开源版
  • xpack：基础版
    • 默认值xpack
    CreateTime String 实例创建时间
    UpdateTime String 实例最后修改操作时间
    Deadline String 实例到期时间
    Nodes Array of LogstashNodeInfo 实例节点类型
    BindedESInstanceId String 实例绑定的ES集群ID
    YMLConfig String 实例的YML配置
    注意：此字段可能返回 null，表示取不到有效值。
    ExtendedFiles Array of LogstashExtendedFile 扩展文件列表
    注意：此字段可能返回 null，表示取不到有效值。
    OperationDuration OperationDuration 可维护时间段
    注意：此字段可能返回 null，表示取不到有效值。
    CpuNum Integer CPU数量
    注意：此字段可能返回 null，表示取不到有效值。
    TagList Array of TagInfo 实例标签信息
    注意：此字段可能返回 null，表示取不到有效值。
    MemSize Integer 内存大小
    注意：此字段可能返回 null，表示取不到有效值。

    LogstashNodeInfo

    Logstash节点信息

    被如下接口引用：DescribeLogstashInstances。

    名称 类型 描述
    NodeId String 节点ID
    Ip String 节点IP
    Port Integer 节点端口

    LogstashPipeline

    Logstash管道信息

    被如下接口引用：SaveAndDeployLogstashPipeline。

    名称 类型 描述
    PipelineId String 管道ID
    PipelineDesc String 管道描述信息
    注意：此字段可能返回 null，表示取不到有效值。
    Config String 管道配置内容
    Workers Integer 管道的Worker数量
    注意：此字段可能返回 null，表示取不到有效值。
    BatchSize Integer 管道批处理大小
    注意：此字段可能返回 null，表示取不到有效值。
    BatchDelay Integer 管道批处理延迟
    注意：此字段可能返回 null，表示取不到有效值。
    QueueType String 管道缓冲队列类型
    注意：此字段可能返回 null，表示取不到有效值。
    QueueMaxBytes String 管道缓冲队列大小
    注意：此字段可能返回 null，表示取不到有效值。
    QueueCheckPointWrites Integer 管道缓冲队列检查点写入数
    注意：此字段可能返回 null，表示取不到有效值。

    LogstashPipelineInfo

    Logstash管道信息

    被如下接口引用：DescribeLogstashPipelines。

    名称 类型 描述
    PipelineId String 管道ID
    PipelineDesc String 管道描述信息
    注意：此字段可能返回 null，表示取不到有效值。
    Config String 管道配置内容
    Status Integer 管道状态
    注意：此字段可能返回 null，表示取不到有效值。
    Workers Integer 管道的Worker数量
    注意：此字段可能返回 null，表示取不到有效值。
    BatchSize Integer 管道批处理大小
    注意：此字段可能返回 null，表示取不到有效值。
    BatchDelay Integer 管道批处理延迟
    注意：此字段可能返回 null，表示取不到有效值。
    QueueType String 管道缓冲队列类型
    注意：此字段可能返回 null，表示取不到有效值。
    QueueMaxBytes String 管道缓冲队列大小
    注意：此字段可能返回 null，表示取不到有效值。
    QueueCheckPointWrites Integer 管道缓冲队列检查点写入数
    注意：此字段可能返回 null，表示取不到有效值。

    MasterNodeInfo

    实例专用主节点相关信息

    被如下接口引用：DescribeInstances。

    名称 类型 描述
    EnableDedicatedMaster Boolean 是否启用了专用主节点
    MasterNodeType String 专用主节点规格
  • ES.S1.SMALL2：1核2G
  • ES.S1.MEDIUM4：2核4G
  • ES.S1.MEDIUM8：2核8G
  • ES.S1.LARGE16：4核16G
  • ES.S1.2XLARGE32：8核32G
  • ES.S1.4XLARGE32：16核32G
  • ES.S1.4XLARGE64：16核64G
    		•
    MasterNodeNum Integer 专用主节点个数
    MasterNodeCpuNum Integer 专用主节点CPU核数
    MasterNodeMemSize Integer 专用主节点内存大小，单位GB
    MasterNodeDiskSize Integer 专用主节点磁盘大小，单位GB
    MasterNodeDiskType String 专用主节点磁盘类型

    NodeInfo

    集群中一种节点类型（如热数据节点，冷数据节点，专用主节点等）的规格描述信息，包括节点类型，节点个数，节点规格，磁盘类型，磁盘大小等, Type不指定时默认为热数据节点；如果节点为master节点，则DiskType和DiskSize参数会被忽略（主节点无数据盘）

    被如下接口引用：CreateInstance, DescribeInstances, UpdateInstance。

    名称 类型 必选 描述
    NodeNum Integer 是 节点数量
    NodeType String 是 节点规格
  • ES.S1.SMALL2：1核2G
  • ES.S1.MEDIUM4：2核4G
  • ES.S1.MEDIUM8：2核8G
  • ES.S1.LARGE16：4核16G
  • ES.S1.2XLARGE32：8核32G
  • ES.S1.4XLARGE32：16核32G
  • ES.S1.4XLARGE64：16核64G
    		•
    Type String 否 节点类型
  • hotData: 热数据节点
  • warmData: 冷数据节点
  • dedicatedMaster: 专用主节点

    • 默认值为hotData
    DiskType String 否 节点磁盘类型
  • CLOUD_SSD：SSD云硬盘
  • CLOUD_PREMIUM：高硬能云硬盘
    • 默认值CLOUD_SSD
    DiskSize Integer 否 节点磁盘容量（单位GB）
    LocalDiskInfo LocalDiskInfo 否 节点本地盘信息
    注意：此字段可能返回 null，表示取不到有效值。
    DiskCount Integer 否 节点磁盘块数
    DiskEncrypt Integer 否 节点磁盘是否加密 0: 不加密，1: 加密；默认不加密
    CpuNum Integer 否 cpu数目
    注意：此字段可能返回 null，表示取不到有效值。
    MemSize Integer 否 内存大小，单位GB
    注意：此字段可能返回 null，表示取不到有效值。
    DiskEnhance Integer 否 /
    注意：此字段可能返回 null，表示取不到有效值。

    NodeView

    节点维度视图数据

    被如下接口引用：DescribeViews。

    名称 类型 描述
    NodeId String 节点ID
    NodeIp String 节点IP
    Visible Float 节点是否可见
    Break Float 是否熔断
    DiskSize Integer 节点总磁盘大小
    DiskUsage Float 磁盘使用率
    MemSize Integer 节点内存大小，单位GB
    MemUsage Float 内存使用率
    CpuNum Integer 节点cpu个数
    CpuUsage Float cpu使用率
    Zone String 可用区
    NodeRole String 节点角色
    NodeHttpIp String 节点HTTP IP
    JvmMemUsage Float JVM内存使用率
    ShardNum Integer 节点分片数
    DiskIds Array of String 节点上磁盘ID列表
    Hidden Boolean 是否为隐藏可用区

    Operation

    ES集群操作详细信息

    被如下接口引用：DescribeInstanceOperations, DescribeLogstashInstanceOperations。

    名称 类型 描述
    Id Integer 操作唯一id
    StartTime String 操作开始时间
    Type String 操作类型
    Detail OperationDetail 操作详情
    Result String 操作结果
    Tasks Array of TaskDetail 流程任务信息
    Progress Float 操作进度

    OperationDetail

    操作详情

    被如下接口引用：DescribeInstanceOperations, DescribeLogstashInstanceOperations。

    名称 类型 描述
    OldInfo Array of KeyValue 实例原始配置信息
    NewInfo Array of KeyValue 实例更新后配置信息

    OperationDuration

    集群可运维时间

    被如下接口引用：CreateInstance, CreateLogstashInstance, DescribeInstances, DescribeLogstashInstances。

    名称 类型 必选 描述
    Periods Array of Integer 是 维护周期，表示周一到周日，可取值[0, 6]
    注意：此字段可能返回 null，表示取不到有效值。
    TimeStart String 是 维护开始时间
    TimeEnd String 是 维护结束时间
    TimeZone String 是 时区，以UTC形式表示

    OperationDurationUpdated

    集群可运维时间

    被如下接口引用：UpdateInstance, UpdateLogstashInstance。

    名称 类型 必选 描述
    Periods Array of Integer 是 维护周期，表示周一到周日，可取值[0, 6]
    TimeStart String 是 维护开始时间
    TimeEnd String 是 维护结束时间
    TimeZone String 是 时区，以UTC形式表示
    MoreInstances Array of String 否 ES集群ID数组

    OptionalWebServiceInfo

    可选web组件信息

    被如下接口引用：DescribeInstances。

    名称 类型 描述
    Type String 类型
    注意：此字段可能返回 null，表示取不到有效值。
    Status Integer 状态
    注意：此字段可能返回 null，表示取不到有效值。
    PublicUrl String 公网url
    注意：此字段可能返回 null，表示取不到有效值。
    PrivateUrl String 内网url
    注意：此字段可能返回 null，表示取不到有效值。
    PublicAccess String 公网访问权限
    注意：此字段可能返回 null，表示取不到有效值。
    PrivateAccess String 内网访问权限
    注意：此字段可能返回 null，表示取不到有效值。
    Version String 版本号
    注意：此字段可能返回 null，表示取不到有效值。

    SubTaskDetail

    实例操作记录流程任务中的子任务信息（如升级检查任务中的各个检查项）

    被如下接口引用：DescribeInstanceOperations, DescribeLogstashInstanceOperations。

    名称 类型 描述
    Name String 子任务名
    Result Boolean 子任务结果
    ErrMsg String 子任务错误信息
    Type String 子任务类型
    Status Integer 子任务状态，0处理中 1成功 -1失败
    FailedIndices Array of String 升级检查失败的索引名
    FinishTime String 子任务结束时间
    Level Integer 子任务等级，1警告 2失败

    TagInfo

    实例标签信息

    被如下接口引用：CreateInstance, CreateLogstashInstance, DescribeInstances, DescribeLogstashInstances。

    名称 类型 描述
    TagKey String 标签键
    TagValue String 标签值

    TaskDetail

    实例操作记录中的流程任务信息

    被如下接口引用：DescribeInstanceOperations, DescribeLogstashInstanceOperations。

    名称 类型 描述
    Name String 任务名
    Progress Float 任务进度
    FinishTime String 任务完成时间
    SubTasks Array of SubTaskDetail 子任务
    ElapsedTime Integer 任务花费时间
    注意：此字段可能返回 null，表示取不到有效值。

    WebNodeTypeInfo

    可视化节点配置

    被如下接口引用：CreateInstance, DescribeInstances, UpdateInstance。

    名称 类型 必选 描述
    NodeNum Integer 是 可视化节点个数，固定为1
    NodeType String 是 可视化节点规格

    ZoneDetail

    多可用区部署时可用区的详细信息

    被如下接口引用：CreateInstance, DescribeInstances, UpdateInstance。

    名称 类型 必选 描述
    Zone String 是 可用区
    SubnetId String 是 子网ID
    目录
    中国站