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" |
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 |
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 |
ES 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 | QQ dictionary list |
| Synonym | Array of DictInfo | Synonym dictionary list |
| UpdateType | String | Update dictionary type |
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 |
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 |
| 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 |
| EnableHotWarmMode | Boolean | Whether it is a hot/warm cluster Note: this field may return null, indicating that no valid values can be obtained. |
| WarmNodeType | String | Warm node specification 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 Note: This field may return null, indicating that no valid values can be obtained. |
| PublicAccess | String | ES public access status 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 Note: This field may return null, indicating that no valid values can be obtained. |
| KibanaPrivateAccess | String | Kibana private access status 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) Note: This field may return null, indicating that no valid values can be obtained. |
| SceneType | Integer | Scenario template type. 0: not enabled; 1: general scenario; 2: log scenario; 3: search scenario Note: this field may return null, indicating that no valid values can be obtained. |
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 |
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 |
Local disk information of node
Used by actions: CreateInstance, DescribeInstances, UpdateInstance.
| Name | Type | Description |
|---|---|---|
| LocalDiskType | String | Local disk type |
| LocalDiskSize | Integer | Size of a single local disk |
| LocalDiskCount | Integer | Number of local disks |
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 |
| 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 |
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 |
| Type | String | No | Node type Default value: hotData |
| DiskType | String | No | Node disk type |
| 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 | Whether to encrypt node disk. 0: no (default); 1: yes. |
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 |
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 |
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 |
Instance tag information
Used by actions: CreateInstance, DescribeInstances.
| Name | Type | Description |
|---|---|---|
| TagKey | String | Tag key |
| TagValue | String | Tag value |
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 |
Details of AZs in multi-AZ deployment mode
Used by actions: CreateInstance, DescribeInstances, UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| Zone | String | Yes | AZ |
| SubnetId | String | Yes | Subnet ID |
Was this page helpful?