Data Types

Last updated: 2020-07-31 10:14:11

CosBackup

Auto-backup to COS for ES

Used by actions: DescribeInstances, UpdateInstance.

Name Type Required Description
IsAutoBackup Boolean Yes Whether to enable auto-backup to COS
BackupTime String Yes Auto-backup time (accurate down to the hour), such as "22:00"

DictInfo

Information of the IK plugin dictionary

Used by actions: DescribeInstances.

Name Type Description
Key String Dictionary key value
Name String Dictionary name
Size Integer Dictionary size in B

EsAcl

ES cluster configuration item

Used by actions: DescribeInstances, UpdateInstance.

Name Type Required Description
BlackIpList Array of String No Kibana access blocklist
WhiteIpList Array of String No Kibana access allowlist

EsDictionaryInfo

ES IK dictionary information

Used by actions: DescribeInstances.

Name Type Description
MainDict Array of DictInfo List of non-stop words
Stopwords Array of DictInfo List of stop words
QQDict Array of DictInfo
Synonym Array of DictInfo
UpdateType String

EsPublicAcl

Public network ACL information of ES

Used by actions: UpdateInstance.

Name Type Required Description
BlackIpList Array of String No Access blocklist
WhiteIpList Array of String No Access allowlist

InstanceInfo

Instance details

Used by actions: DescribeInstances.

Name Type Description
InstanceId String Instance ID
InstanceName String Instance name
Region String Region
Zone String Availability Zone
AppId Integer User ID
Uin String User UIN
VpcUid String UID of the VPC where the instance resides
SubnetUid String UID of the subnet where the instance resides
Status Integer Instance status. 0: processing; 1: normal; -1: stopped; -2: terminating; -3: terminated
ChargeType String Instance billing method. Valid values: POSTPAID_BY_HOUR (pay-as-you-go hourly); CDHPAID (billed based on CDH, i.e., only CDH is billed but not the instances on CDH)
ChargePeriod Integer This parameter is not used on the global website
RenewFlag String This parameter is not used on the global website
NodeType String Node specification
  • ES.S1.SMALL2: 1-core 2 GB
  • ES.S1.MEDIUM4: 2-core 4 GB
  • ES.S1.MEDIUM8: 2-core 8 GB
  • ES.S1.LARGE16: 4-core 16 GB
  • ES.S1.2XLARGE32: 8-core 32 GB
  • ES.S1.4XLARGE32: 16-core 32 GB
  • ES.S1.4XLARGE64: 16-core 64 GB
  • NodeNum Integer Number of nodes
    CpuNum Integer Number of CPU cores of the node
    MemSize Integer Node memory size in GB
    DiskType String Node disk type
    DiskSize Integer Node disk size in GB
    EsDomain String ES domain name
    EsVip String ES VIP
    EsPort Integer ES port
    KibanaUrl String Kibana access URL
    EsVersion String ES version number
    EsConfig String ES configuration item
    EsAcl EsAcl Kibana access control configuration
    CreateTime String Instance creation time
    UpdateTime String Last modified time of the instance
    Deadline String This parameter is not used on the global website
    InstanceType Integer Instance type (instance type identifier, which can be only 1 or 2 currently)
    IkConfig EsDictionaryInfo IK analyzer configuration
    MasterNodeInfo MasterNodeInfo Dedicated primary node configuration
    CosBackup CosBackup Auto-backup to COS configuration
    AllowCosBackup Boolean Whether to allow auto-backup to COS
    TagList Array of TagInfo List of tags owned by the instance
    LicenseType String License type
  • oss: Open Source Edition
  • basic: Basic Edition
  • platinum: Platinum Edition
  • Default value: Platinum
    EnableHotWarmMode Boolean Whether it is a hot/warm cluster
  • true: yes
  • false: no

  • Note: this field may return null, indicating that no valid values can be obtained.
    WarmNodeType String Warm node specification
  • ES.S1.SMALL2: 1-core 2 GB
  • ES.S1.MEDIUM4: 2-core 4 GB
  • ES.S1.MEDIUM8: 2-core 8 GB
  • ES.S1.LARGE16: 4-core 16 GB
  • ES.S1.2XLARGE32: 8-core 32 GB
  • ES.S1.4XLARGE32: 16-core 32 GB
  • ES.S1.4XLARGE64: 16-core 64 GB

  • Note: This field may return null, indicating that no valid values can be obtained.
    WarmNodeNum Integer Number of warm nodes
    Note: This field may return null, indicating that no valid values can be obtained.
    WarmCpuNum Integer Number of warm node CPU cores
    Note: This field may return null, indicating that no valid values can be obtained.
    WarmMemSize Integer Warm node memory size in GB
    Note: This field may return null, indicating that no valid values can be obtained.
    WarmDiskType String Warm node disk type
    Note: This field may return null, indicating that no valid values can be obtained.
    WarmDiskSize Integer Warm node disk size in GB
    Note: This field may return null, indicating that no valid values can be obtained.
    NodeInfoList Array of NodeInfo Cluster node information list
    Note: This field may return null, indicating that no valid values can be obtained.
    EsPublicUrl String ES public IP address
    Note: This field may return null, indicating that no valid values can be obtained.
    MultiZoneInfo Array of ZoneDetail Multi-AZ network information
    Note: This field may return null, indicating that no valid values can be obtained.
    DeployMode Integer Deployment mode
  • 0: single-AZ
  • 1: multi-AZ

  • Note: This field may return null, indicating that no valid values can be obtained.
    PublicAccess String ES public access status
  • OPEN: enabled
  • CLOSE: disabled
    Note: This field may return null, indicating that no valid values can be obtained.
  • EsPublicAcl EsAcl ES public access control configuration
    KibanaPrivateUrl String Kibana private IP address
    Note: This field may return null, indicating that no valid values can be obtained.
    KibanaPublicAccess String Kibana public access status
  • OPEN: enabled
  • CLOSE: disabled
    Note: This field may return null, indicating that no valid values can be obtained.
  • KibanaPrivateAccess String Kibana private access status
  • OPEN: enabled
  • CLOSE: disabled
    Note: This field may return null, indicating that no valid values can be obtained.
  • SecurityType Integer Whether to enable X-Pack security authentication in Basic Edition 6.8 (and above)
  • 1: disabled
  • 2: enabled

  • Note: This field may return null, indicating that no valid values can be obtained.

    InstanceLog

    ES cluster log details

    Used by actions: DescribeInstanceLogs.

    Name Type Description
    Time String Log time
    Level String Log level
    Ip String Cluster node IP
    Message String Log content

    KeyValue

    OperationDetail uses an array of this structure to describe the old and new configuration information

    Used by actions: DescribeInstanceOperations.

    Name Type Description
    Key String Key
    Value String Value

    LocalDiskInfo

    Local disk information of node

    Used by actions: CreateInstance, DescribeInstances, UpdateInstance.

    Name Type Description
    LocalDiskType String Local disk type
  • LOCAL_SATA: big data
  • NVME_SSD: high IO
  • LocalDiskSize Integer Size of a single local disk
    LocalDiskCount Integer Number of local disks

    MasterNodeInfo

    Information of the dedicated primary node in an instance

    Used by actions: DescribeInstances.

    Name Type Description
    EnableDedicatedMaster Boolean Whether to enable the dedicated primary node
    MasterNodeType String Dedicated primary node specification
  • ES.S1.SMALL2: 1-core 2 GB
  • ES.S1.MEDIUM4: 2-core 4 GB
  • ES.S1.MEDIUM8: 2-core 8 GB
  • ES.S1.LARGE16: 4-core 16 GB
  • ES.S1.2XLARGE32: 8-core 32 GB
  • ES.S1.4XLARGE32: 16-core 32 GB
  • ES.S1.4XLARGE64: 16-core 64 GB
  • MasterNodeNum Integer Number of dedicated primary nodes
    MasterNodeCpuNum Integer Number of CPU cores of the dedicated primary node
    MasterNodeMemSize Integer Memory size of the dedicated primary node in GB
    MasterNodeDiskSize Integer Disk size of the dedicated primary node in GB
    MasterNodeDiskType String Disk type of the dedicated primary node

    NodeInfo

    Specification information of a node type in the cluster (such as hot data node, warm data node, or dedicated primary node), including node type, number of nodes, node specification, disk type, and disk size. If Type is not specified, it will be a hot data node by default; if the node is a primary node, then the DiskType and DiskSize parameters will be ignored (as a primary node has no data disks)

    Used by actions: CreateInstance, DescribeInstances, UpdateInstance.

    Name Type Required Description
    NodeNum Integer Yes Number of nodes
    NodeType String Yes Node specification
  • ES.S1.SMALL2: 1-core 2 GB
  • ES.S1.MEDIUM4: 2-core 4 GB
  • ES.S1.MEDIUM8: 2-core 8 GB
  • ES.S1.LARGE16: 4-core 16 GB
  • ES.S1.2XLARGE32: 8-core 32 GB
  • ES.S1.4XLARGE32: 16-core 32 GB
  • ES.S1.4XLARGE64: 16-core 64 GB
  • Type String No Node type
  • hotData: hot data node
  • warmData: warm data node
  • dedicatedMaster: dedicated primary node

  • Default value: hotData
    DiskType String No Node disk type
  • CLOUD_SSD: SSD cloud storage
  • CLOUD_PREMIUM: Premium cloud disk
  • Default value: CLOUD_SSD
    DiskSize Integer No Node disk size in GB
    LocalDiskInfo LocalDiskInfo No Local disk information
    Note: this field may return null, indicating that no valid values can be obtained.
    DiskCount Integer No Number of node disks
    DiskEncrypt Integer No

    Operation

    ES cluster operation details

    Used by actions: DescribeInstanceOperations.

    Name Type Description
    Id Integer Unique operation ID
    StartTime String Operation start time
    Type String Operation type
    Detail OperationDetail Operation details
    Result String Operation result
    Tasks Array of TaskDetail Workflow task information
    Progress Float Operation progress

    OperationDetail

    Operation details

    Used by actions: DescribeInstanceOperations.

    Name Type Description
    OldInfo Array of KeyValue Original instance configuration information
    NewInfo Array of KeyValue Updated instance configuration information

    SubTaskDetail

    Information of subtask in workflow task in the instance operation history (such as each check item in a upgrade check task)

    Used by actions: DescribeInstanceOperations.

    Name Type Description
    Name String Subtask name
    Result Boolean Subtask result
    ErrMsg String Subtask error message
    Type String Subtask type
    Status Integer Subtask status. 0: processing, 1: succeeded, -1: failed
    FailedIndices Array of String Name of the index for which the check for upgrade failed
    FinishTime String Subtask end time
    Level Integer Subtask level. 1: warning, 2: failed

    TagInfo

    Instance tag information

    Used by actions: CreateInstance, DescribeInstances.

    Name Type Description
    TagKey String Tag key
    TagValue String Tag value

    TaskDetail

    Information of workflow task in instance operation history

    Used by actions: DescribeInstanceOperations.

    Name Type Description
    Name String Task name
    Progress Float Task progress
    FinishTime String Task completion time
    SubTasks Array of SubTaskDetail Subtask

    ZoneDetail

    Details of AZs in multi-AZ deployment mode

    Used by actions: CreateInstance, DescribeInstances.

    Name Type Required Description
    Zone String Yes AZ
    SubnetId String Yes Subnet ID

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help