History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Backing index metadata fields
Used by actions: DescribeIndexList, DescribeIndexMeta.
| Name | Type | Description |
|---|---|---|
| IndexName | String | Backing index name Note: This field may return null, indicating that no valid value can be obtained. |
| IndexStatus | String | Backing index status Note: This field may return null, indicating that no valid value can be obtained. |
| IndexStorage | Integer | Backing index size Note: This field may return null, indicating that no valid value can be obtained. |
| IndexPhrase | String | Current lifecycle phase of backing index Note: This field may return null, indicating that no valid value can be obtained. |
| IndexCreateTime | String | Backing index creation time Note: This field may return null, indicating that no valid value can be obtained. |
Cluster view data
Used by actions: DescribeViews.
| Name | Type | Description |
|---|---|---|
| Health | Float | Cluster health status |
| Visible | Float | Whether the cluster is visible |
| Break | Float | Whether the cluster encounters circuit breaking |
| AvgDiskUsage | Float | Average disk usage |
| AvgMemUsage | Float | Average memory usage |
| AvgCpuUsage | Float | Average CPU usage |
| TotalDiskSize | Integer | Total disk size of the cluster |
| TargetNodeTypes | Array of String | Types of nodes to receive client requests |
| NodeNum | Integer | Number of online nodes |
| TotalNodeNum | Integer | Total number of nodes |
| DataNodeNum | Integer | Number of data nodes |
| IndexNum | Integer | Number of indices |
| DocNum | Integer | Number of documents |
| DiskUsedInBytes | Integer | Used disk size (in bytes) |
| ShardNum | Integer | Number of shards |
| PrimaryShardNum | Integer | Number of primary shards |
| RelocatingShardNum | Integer | Number of relocating shards |
| InitializingShardNum | Integer | Number of initializing shards |
| UnassignedShardNum | Integer | Number of unassigned shards |
| TotalCosStorage | Integer | Total COS storage of an enterprise cluster, in GB |
| SearchableSnapshotCosBucket | String | Name of the COS bucket that stores searchable snapshots of an enterprise cluster Note: This field may return null, indicating that no valid value was found. |
| SearchableSnapshotCosAppId | String | COS app ID of the searchable snapshots of an enterprise cluster Note: This field may return null, indicating that no valid value was found. |
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 |
Configuration set information
Used by actions: DescribeInstances, UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Configuration set type, such as LDAP and AD. |
| EsConfig | String | Yes | "{"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"}" |
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 |
Index metadata field
Used by actions: DescribeIndexList, DescribeIndexMeta.
| Name | Type | Description |
|---|---|---|
| IndexType | String | Index type Note: This field may return null, indicating that no valid value can be obtained. |
| IndexName | String | Index name Note: This field may return null, indicating that no valid value can be obtained. |
| IndexStatus | String | Index status Note: This field may return null, indicating that no valid value can be obtained. |
| IndexStorage | Integer | Index size (in byte) Note: This field may return null, indicating that no valid value can be obtained. |
| IndexCreateTime | String | Index creation time Note: This field may return null, indicating that no valid value can be obtained. |
| BackingIndices | Array of BackingIndexMetaField | Backing index Note: This field may return null, indicating that no valid value can be obtained. |
| ClusterId | String | Cluster ID Note: This field may return null, indicating that no valid value can be obtained. |
| ClusterName | String | Cluster name Note: This field may return null, indicating that no valid value can be obtained. |
| ClusterVersion | String | Cluster version Note: This field may return null, indicating that no valid value can be obtained. |
| IndexPolicyField | IndexPolicyField | Index lifecycle policy field Note: This field may return null, indicating that no valid value can be obtained. |
| IndexOptionsField | IndexOptionsField | Index automation field Note: This field may return null, indicating that no valid value can be obtained. |
| IndexSettingsField | IndexSettingsField | Index setting field Note: This field may return null, indicating that no valid value can be obtained. |
| AppId | Integer | Cluster APP ID Note: This field may return null, indicating that no valid value can be obtained. |
| IndexDocs | Integer | The number of index docs. Note: This field may return null, indicating that no valid values can be obtained. |
Index automation field
Used by actions: DescribeIndexList, DescribeIndexMeta.
| Name | Type | Required | Description |
|---|---|---|---|
| ExpireMaxAge | String | No | Max age for expiry purpose Note: This field may return null, indicating that no valid value can be obtained. |
| ExpireMaxSize | String | No | Max size for expiry purpose Note: This field may return null, indicating that no valid value can be obtained. |
| RolloverMaxAge | String | No | Rollover cycle Note: This field may return null, indicating that no valid value can be obtained. |
| RolloverDynamic | String | No | Whether to enable the dynamic rollover Note: This field may return null, indicating that no valid value can be obtained. |
| ShardNumDynamic | String | No | Whether to enable dynamic sharding Note: This field may return null, indicating that no valid value can be obtained. |
| TimestampField | String | No | Timestamp field Note: This field may return null, indicating that no valid value can be obtained. |
| WriteMode | String | No | Write mode Note: This field may return null, indicating that no valid value can be obtained. |
Index lifecycle policy field
Used by actions: DescribeIndexList, DescribeIndexMeta.
| Name | Type | Required | Description |
|---|---|---|---|
| WarmEnable | String | No | Whether to enable the warm phase Note: This field may return null, indicating that no valid value can be obtained. |
| WarmMinAge | String | No | Min age before data transitions to the warm phase Note: This field may return null, indicating that no valid value can be obtained. |
| ColdEnable | String | No | Whether to enable the cold phase Note: This field may return null, indicating that no valid value can be obtained. |
| ColdMinAge | String | No | Min age before data transitions to the cold phase Note: This field may return null, indicating that no valid value can be obtained. |
| FrozenEnable | String | No | Whether to enable the frozen phase Note: This field may return null, indicating that no valid value can be obtained. |
| FrozenMinAge | String | No | Min age before data transitions to the frozen phase Note: This field may return null, indicating that no valid value can be obtained. |
| ColdAction | String | No | / Note: This field may return null, indicating that no valid value can be obtained. |
Index configuration fields
Used by actions: DescribeIndexList, DescribeIndexMeta.
| Name | Type | Required | Description |
|---|---|---|---|
| NumberOfShards | String | No | Number of primary shards Note: This field may return null, indicating that no valid value can be obtained. |
| NumberOfReplicas | String | No | Number of replica shards Note: This field may return null, indicating that no valid value can be obtained. |
| RefreshInterval | String | No | Index refresh interval Note: This field may return null, indicating that no valid value can be obtained. |
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: Being terminated; -3: Terminated; 2: Initializing during the cluster creation. |
| RenewFlag | String | This parameter is not used on the global website |
| 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 |
| 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 value was found. |
| WarmNodeNum | Integer | Number of warm nodes Note: This field may return null, indicating that no valid value was found. |
| WarmCpuNum | Integer | Number of warm node CPU cores Note: This field may return null, indicating that no valid value was found. |
| WarmMemSize | Integer | Warm node memory size (in GB) Note: This field may return null, indicating that no valid value was found. |
| WarmDiskType | String | Warm node disk type Note: This field may return null, indicating that no valid value was found. |
| WarmDiskSize | Integer | Warm node disk size (in GB) Note: This field may return null, indicating that no valid value was found. |
| 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. |
| KibanaConfig | String | Kibana configuration item. Note: this field may return null, indicating that no valid values can be obtained. |
| KibanaNodeInfo | KibanaNodeInfo | Kibana node information Note: this field may return null, indicating that no valid value can be obtained. |
| WebNodeTypeInfo | WebNodeTypeInfo | Visual node configuration Note: this field may return null, indicating that no valid values can be obtained. |
| Jdk | String | JDK type. Valid values: oracle, konaNote: this field may return null, indicating that no valid values can be obtained. |
| Protocol | String | Cluster network communication protocol Note: this field may return null, indicating that no valid values can be obtained. |
| SecurityGroups | Array of String | Security group ID Note: this field may return null, indicating that no valid values can be obtained. |
| ColdNodeType | String | Cold node specification Note: This field may return null, indicating that no valid value was found. |
| ColdNodeNum | Integer | Number of cold nodes Note: This field may return null, indicating that no valid value was found. |
| ColdCpuNum | Integer | Number of cold node CPU cores Note: This field may return null, indicating that no valid value was found. |
| ColdMemSize | Integer | Cold node memory size (in GB) Note: This field may return null, indicating that no valid value was found. |
| ColdDiskType | String | Cold node disk type Note: This field may return null, indicating that no valid value was found. |
| ColdDiskSize | Integer | Cold node disk size (in GB) Note: This field may return null, indicating that no valid value was found. |
| FrozenNodeType | String | Frozen node specification Note: This field may return null, indicating that no valid value was found. |
| FrozenNodeNum | Integer | Number of frozen nodes Note: This field may return null, indicating that no valid value was found. |
| FrozenCpuNum | Integer | Number of frozen node CPU cores Note: This field may return null, indicating that no valid value was found. |
| FrozenMemSize | Integer | Frozen node memory size (GB) Note: This field may return null, indicating that no valid value was found. |
| FrozenDiskType | String | Frozen node disk type Note: This field may return null, indicating that no valid value was found. |
| FrozenDiskSize | Integer | Frozen node disk size (in GB) Note: This field may return null, indicating that no valid value was found. |
| HealthStatus | Integer | Cluster health status. -1: Unknown; 0: Green; 1: Yellow; 2: RedNote: This field may return null, indicating that no valid value was found. |
| EsPrivateUrl | String | Private URL of the HTTPS cluster Note: This field may return null, indicating that no valid value was found. |
| EsPrivateDomain | String | Private domain of the HTTPS cluster Note: This field may return null, indicating that no valid value was found. |
| EsConfigSets | Array of EsConfigSetInfo | Configuration set info of the cluster. Note: This field may return null, indicating that no valid values can be obtained. |
| OperationDuration | OperationDuration | The maintenance time slot of the cluster Note: This field may return null, indicating that no valid values can be obtained. |
| OptionalWebServiceInfos | Array of OptionalWebServiceInfo | Web node list Note: This field may return null, indicating that no valid values can be obtained. |
| AutoIndexEnabled | Boolean | Autonomous index option Note: This field may return null, indicating that no valid values can be obtained. |
| EnableHybridStorage | Boolean | Whether the storage-computing separation feature is enabled. Note: This field may return null, indicating that no valid values can be obtained. |
| ProcessPercent | Float | The process progress Note: This field may return null, indicating that no valid values can be obtained. |
| KibanaAlteringPublicAccess | String | The alerting policy of Kibana over the public network. OPEN: Enable the policy;CLOSE: Disable the policy.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 |
Kibana node information
Used by actions: DescribeInstances.
| Name | Type | Description |
|---|---|---|
| KibanaNodeType | String | Kibana node specification |
| KibanaNodeNum | Integer | Number of Kibana nodes |
| KibanaNodeCpuNum | Integer | Number of Kibana node's CPUs |
| KibanaNodeMemSize | Integer | Kibana node's memory in GB |
| KibanaNodeDiskType | String | Kibana node's disk type |
| KibanaNodeDiskSize | Integer | Kibana node's disk size |
Kibana view data
Used by actions: DescribeViews.
| Name | Type | Description |
|---|---|---|
| Ip | String | Kibana node IP |
| DiskSize | Integer | Node disk size |
| DiskUsage | Float | Disk usage |
| MemSize | Integer | Node memory size |
| MemUsage | Float | Memory usage |
| CpuNum | Integer | Number of node CPUs |
| CpuUsage | Float | CPU usage |
| Zone | String | Availability zone |
Local disk information of node
Used by actions: CreateInstance, 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 typehotData: hot data nodewarmData: warm data nodededicatedMaster: dedicated master nodeDefault 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. |
| CpuNum | Integer | No | CPU number Note: This field may return null, indicating that no valid values can be obtained. |
| MemSize | Integer | No | Memory size in GB Note: This field may return null, indicating that no valid values can be obtained. |
| DiskEnhance | Integer | No | / Note: This field may return null, indicating that no valid values can be obtained. |
Node view data
Used by actions: DescribeViews.
| Name | Type | Description |
|---|---|---|
| NodeId | String | Node ID |
| NodeIp | String | Node IP |
| Visible | Float | Whether the node is visible |
| Break | Float | Whether the node encounters circuit breaking |
| DiskSize | Integer | Node disk size |
| DiskUsage | Float | Disk usage |
| MemSize | Integer | Node memory size (in GB) |
| MemUsage | Float | Memory usage |
| CpuNum | Integer | Number of node CPUs |
| CpuUsage | Float | CPU usage |
| Zone | String | Availability zone |
| NodeRole | String | Node role |
| NodeHttpIp | String | Node HTTP IP |
| JvmMemUsage | Float | JVM memory usage |
| ShardNum | Integer | Number of node shards |
| DiskIds | Array of String | ID list of node disks |
| Hidden | Boolean | Whether a hidden availability zone |
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 |
The maintenance time slot of the cluster
Used by actions: CreateInstance, DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Periods | Array of Integer | Yes | Maintenance period, which can be one or more days from Monday to Sunday. Valid values: [0, 6]. Note: This field may return null, indicating that no valid values can be obtained. |
| TimeStart | String | Yes | The maintenance start time |
| TimeEnd | String | Yes | The maintenance end time |
| TimeZone | String | Yes | The time zone expressed in UTC. |
The maintenance time slot of the cluster
Used by actions: UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| Periods | Array of Integer | Yes | Maintenance period, which can be one or more days from Monday to Sunday. Valid values: [0, 6]. |
| TimeStart | String | Yes | The maintenance start time |
| TimeEnd | String | Yes | The maintenance end time |
| TimeZone | String | Yes | The time zone expressed in UTC. |
| MoreInstances | Array of String | No | The array of ES cluster IDs |
The information of optional web components
Used by actions: DescribeInstances.
| Name | Type | Description |
|---|---|---|
| Type | String | Type Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | Status Note: This field may return null, indicating that no valid values can be obtained. |
| PublicUrl | String | Public URL Note: This field may return null, indicating that no valid values can be obtained. |
| PrivateUrl | String | Private URL Note: This field may return null, indicating that no valid values can be obtained. |
| PublicAccess | String | Public network access Note: This field may return null, indicating that no valid values can be obtained. |
| PrivateAccess | String | Private network access Note: This field may return null, indicating that no valid values can be obtained. |
| Version | String | Version Note: This field may return null, indicating that no valid values can be obtained. |
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 |
| ElapsedTime | Integer | The task time. Note: This field may return null, indicating that no valid values can be obtained. |
Visual node configuration
Used by actions: CreateInstance, DescribeInstances, UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| NodeNum | Integer | Yes | Number of visual nodes. The value is always 1. |
| NodeType | String | Yes | Visual node specification |
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 |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários