数据结构

最近更新时间:2020-09-17 08:03:53

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访问白名单

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 访问白名单

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:已销毁
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 节点规格
  • 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,表示取不到有效值。

    InstanceLog

    ES集群日志详细信息

    被如下接口引用:DescribeInstanceLogs。

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

    KeyValue

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

    被如下接口引用:DescribeInstanceOperations。

    名称 类型 描述
    Key String
    Value String

    LocalDiskInfo

    节点本地盘信息

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

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

    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: 加密;默认不加密

    Operation

    ES集群操作详细信息

    被如下接口引用:DescribeInstanceOperations。

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

    OperationDetail

    操作详情

    被如下接口引用:DescribeInstanceOperations。

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

    SubTaskDetail

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

    被如下接口引用:DescribeInstanceOperations。

    名称 类型 描述
    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, DescribeInstances。

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

    TaskDetail

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

    被如下接口引用:DescribeInstanceOperations。

    名称 类型 描述
    Name String 任务名
    Progress Float 任务进度
    FinishTime String 任务完成时间
    SubTasks Array of SubTaskDetail 子任务

    ZoneDetail

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

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

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