The following tables list the API operations available for use in Elasticsearch, Kibana, Logstash, and Beats. If you want to use an API operation that is not listed in these tables, contact Alibaba Cloud technical support engineers to obtain it.
Elasticsearch
Category | Operation | Description |
Cluster management | Creates an Elasticsearch cluster. | |
Queries the detailed information of all Elasticsearch clusters or a single Elasticsearch cluster. | ||
Queries the detailed information of an Elasticsearch cluster. | ||
Obtains the estimated time that is required to restart an Elasticsearch cluster. | ||
Restarts an Elasticsearch cluster. | ||
Switches the billing method of an Elasticsearch cluster from pay-as-you-go to subscription. | ||
Changes the name of an Elasticsearch cluster. | ||
Releases a pay-as-you-go Elasticsearch cluster. After the cluster is released, the physical resources used by the cluster are reclaimed. The data stored in the cluster is deleted and cannot be recovered. The disks attached to the nodes in the cluster and the snapshots created for the cluster are released. | ||
Restores an Elasticsearch cluster that is frozen after it is released. | ||
Renews a subscription Elasticsearch cluster. | ||
Restores the nodes in a disabled zone. This operation is available only for multi-zone Elasticsearch clusters. | ||
Disables one or more zones where a multi-zone Elasticsearch cluster resides and migrates the nodes in the disabled zones to other zones. | ||
Queries the regions whether Elasticsearch is available. | ||
Suspends a change task of an Elasticsearch cluster. After the task is suspended, the cluster is in the suspended state. This operation is available only for Elasticsearch clusters in the activating state. | ||
Resumes a change task of an Elasticsearch cluster. | ||
Queries the information of all nodes in an Elasticsearch cluster. | ||
Queries the health status of an Elasticsearch cluster. | ||
Queries the indexes stored in an Elasticsearch cluster. | ||
Migrates nodes across zones. | ||
Migrates an Elasticsearch cluster to a resource group. | ||
Enables and modifies the maintenance window of an Elasticsearch cluster. | ||
Queries the configuration information in the current region. This operation returns all configuration information in the current region. The information is for reference only. The actual information in the console and on the buy page prevails. | ||
Queries the information of shards that are being restored or shards that are restored. By default, this operation returns only the information of shards that are being restored after you call this operation. | ||
Queries the configurations that are recommended by the system for capacity planning of an Elasticsearch cluster based on business scenarios, the number of queries per second, and the number of logs for the cluster. | ||
Tag management | Queries all visible user tags. | |
Queries the tags that are added to one or more resources. | ||
Adds tags to resources. | ||
Removes tags from resources. | ||
Data migration | Queries the nodes on which data can be migrated based on the specified node type and number of nodes. | |
Checks whether the data on specific nodes in an Elasticsearch cluster can be migrated. | ||
Runs a data migration task. | ||
Queries the information of data migration tasks. | ||
Queries the data information of an Elasticsearch cluster. | ||
Deletes a data migration task. | ||
Cancels a data migration task. | ||
Cluster configuration upgrade and downgrade | Queries the nodes that can be removed from an Elasticsearch cluster based on the specified node type and number of nodes. | |
Checks whether specific nodes can be removed from an Elasticsearch cluster. | ||
Removes nodes from an Elasticsearch cluster. | ||
Upgrades the version or kernel version of an Elasticsearch cluster. You can upgrade the version of an Elasticsearch cluster only from V6.3 to V6.7. | ||
Upgrades or downgrades the configuration of an Elasticsearch cluster. | ||
Cluster configuration | Updates the configuration in the YML file of an Elasticsearch cluster. | |
Performs a rolling update for the IK dictionaries of an Elasticsearch cluster. | ||
Updates the synonym dictionary of an Elasticsearch cluster. | ||
Performs a standard update for the IK dictionaries of an Elasticsearch cluster, including the IK main dictionary and IK stopword list. | ||
Updates the dictionary file of the analysis-aliws plug-in. This plug-in allows you to upload a tailored dictionary file to it. | ||
Queries and verifies the details of the dictionary object stored in Object Storage Service (OSS) when you upload the object to an Elasticsearch cluster. | ||
Updates the garbage collector (GC) configuration of an Elasticsearch cluster. | ||
Queries the details of a type of dictionary and the link that is generated based on the related signature to download the dictionary. | ||
Plug-in management | Queries the plug-ins that are installed on an Elasticsearch cluster. | |
Installs a built-in plug-in. | ||
Uninstalls a built-in plug-in. | ||
Installs a custom plug-in that is uploaded to the Elasticsearch console. | ||
Log query | Queries the logs of an Elasticsearch cluster. | |
Security configuration | Enables or disables the Public Network Access or Private Network Access feature for Elasticsearch or Kibana. | |
Updates the private IP address whitelist of an Elasticsearch cluster. | ||
Updates the public IP address whitelist of an Elasticsearch cluster. | ||
Enables or disables the Public Network Access feature for an Elasticsearch cluster. | ||
Updates the private IP address whitelist of an Elasticsearch cluster. | ||
Updates the IP address whitelist of an Elasticsearch cluster. | ||
Updates the password for the elastic account of an Elasticsearch cluster. | ||
Enables HTTPS. If the version of your Elasticsearch cluster is not V8.5 or V7.16, you must make sure that the cluster contains client nodes before you call this operation. | ||
Disables HTTPS. | ||
Connects Elasticsearch clusters. | ||
Disconnects Elasticsearch clusters. | ||
Queries the Elasticsearch clusters that can be connected to an Elasticsearch cluster. The Elasticsearch clusters that are connected to the Elasticsearch cluster are excluded. | ||
Queries the Elasticsearch clusters that are connected to an Elasticsearch cluster. | ||
Creates an endpoint in the virtual private cloud (VPC) within the Elasticsearch service account. You can use the endpoint to connect to the endpoint service in your VPC. This way, a private connection is established between the two VPCs. | ||
Deletes an endpoint in the VPC within the Elasticsearch service account. | ||
Queries the status of an endpoint in the VPC within the Elasticsearch service account. | ||
Data backup | Creates a snapshot in an Elasticsearch cluster. | |
Queries the data backup configuration of an Elasticsearch cluster. | ||
Updates the data backup configuration of an Elasticsearch cluster. | ||
Queries the shared OSS repositories configured for an Elasticsearch cluster. | ||
Queries the shared OSS repositories that can be configured for an Elasticsearch cluster. | ||
Creates a shared OSS repository for an Elasticsearch cluster. | ||
Deletes a shared OSS repository for an Elasticsearch cluster. | ||
Intelligent O&M | Enables the intelligent O&M feature for an Elasticsearch cluster. | |
Disables the intelligent O&M feature for an Elasticsearch cluster. | ||
Diagnoses an Elasticsearch cluster. | ||
Queries the historical intelligent O&M reports of an Elasticsearch cluster. | ||
Queries the IDs of the historical intelligent O&M reports of an Elasticsearch cluster. | ||
Queries the indexes for health diagnosis performed on an Elasticsearch cluster. | ||
Queries a historical intelligent O&M report. | ||
Queries the scenario settings for intelligent O&M of an Elasticsearch cluster. | ||
Updates the scenario settings for intelligent O&M of an Elasticsearch cluster. |
Kibana
Operation | Description |
Queries the configuration of Kibana. | |
Modifies the configuration of Kibana. You can change only the language setting of Kibana. | |
Queries the plug-ins of Kibana. | |
Installs a built-in plug-in for Kibana. Before you call this operation, make sure that the specifications of your Kibana node are 2 vCPUs and 4 GiB of memory or higher. | |
Uninstalls a plug-in for Kibana. | |
Updates the IP address whitelist that allows access to the Kibana console of an Elasticsearch cluster. |
Logstash
Category | Operation | Description |
Cluster management | Creates a Logstash cluster. | |
Queries the detailed information of all Logstash clusters or a single Logstash cluster. | ||
Queries the detailed information of a Logstash cluster. | ||
Modifies the configuration of a Logstash cluster, such as the name, quota, disk size, and number of nodes. | ||
Renews a Logstash cluster. | ||
Restarts a Logstash cluster. After the cluster is restarted, it is in the activating state. | ||
Changes the name of a Logstash cluster. | ||
Switches the billing method of a Logstash cluster from pay-as-you-go to subscription. | ||
Queries the estimated time that is required to restart a Logstash cluster. | ||
Releases a Logstash cluster. | ||
Restores a Logstash cluster that is frozen after it is released. | ||
Cluster configuration | Updates the configuration of a Logstash cluster. | |
Queries the driver files of a Logstash cluster. | ||
Updates the driver files of a Logstash cluster. | ||
Cluster monitoring | Queries the Elasticsearch clusters that can be associated with a Logstash cluster when you configure the X-Pack Monitoring feature for the Logstash cluster. | |
Tests the connectivity between a Logstash cluster and its associated Elasticsearch cluster when you configure the X-Pack Monitoring feature for the Logstash cluster. | ||
Updates the configurations of the X-Pack Monitoring feature of a Logstash cluster. | ||
Queries the configurations of the X-Pack Monitoring feature of a Logstash cluster. | ||
Plug-in management | Queries the detailed information of all plug-ins or a single plug-in. | |
Installs a plug-in. | ||
Uninstalls a plug-in. | ||
Log query | Queries the logs of a Logstash cluster. | |
Change task management | Suspends a change task of a Logstash cluster. After the task is suspended, the Logstash cluster is in the suspended state. | |
Resumes a change task of a Logstash cluster. After the task is resumed, the Logstash cluster is in the activating state. | ||
Pipeline management | Creates a pipeline in a Logstash cluster. | |
Queries the pipelines of a Logstash cluster. | ||
Queries the detailed information of a pipeline in a Logstash cluster. | ||
Updates the information of pipelines in a Logstash cluster. | ||
Runs pipelines in a Logstash cluster. | ||
Stops pipelines in a Logstash cluster. | ||
Updates the management method of pipelines in a Logstash cluster. | ||
Queries the management configuration of pipelines in a Logstash cluster. | ||
Deletes a pipeline in a Logstash cluster. | ||
Tests the connectivity between a Logstash cluster and the Kibana console of an Elasticsearch cluster, and queries the IDs of pipelines that are created in the Kibana console of the Elasticsearch cluster. |
Beats
Operation | Description |
Creates a shipper. | |
Queries the detailed information of a shipper. | |
Installs a shipper that failed to be installed when you create the shipper. | |
Queries shippers. | |
Queries the default configuration files of shippers. | |
Changes the name of a shipper. | |
Updates the information of a shipper. | |
Starts a shipper. | |
Restarts a shipper. | |
Stops a shipper. | |
Deletes a shipper. | |
Queries Elastic Compute Service (ECS) instances. | |
Changes the ECS instances on which a shipper is installed. | |
Queries the statuses of ECS instances on which a shipper is installed. | |
Queries Container Service for Kubernetes (ACK) clusters. | |
Queries all namespaces of an ACK cluster. | |
Queries the information of ES-operator that is installed for an ACK cluster. | |
Installs ES-operator for an ACK cluster. |
Access control
Operation | Description |
Creates a service-linked role. | |
Checks whether a service-linked role is created. |