API overview
This topic describes the API operations for Alibaba Cloud Elasticsearch, Kibana, Logstash, and Beats. To use an API operation that is not listed, contact an Alibaba Cloud technical support engineer.
Elasticsearch
Category | API | Description |
Instance management | Creates an Elasticsearch instance. | |
Lists the details of all or specified instances. | ||
Queries the details of a specified instance. | ||
Obtains the estimated time required to restart an instance. | ||
Restarts a specified instance. | ||
Converts a pay-as-you-go instance to a subscription instance. | ||
Updates the name of a specified instance. | ||
Releases a specified pay-as-you-go instance. After the instance is released, its physical resources are reclaimed. All data is lost and cannot be recovered. The disks attached to the instance nodes and their snapshots are also released. | ||
Recovers a released instance that is in the frozen state. | ||
Renews a subscription instance. | ||
Recovers nodes in an offline zone. This operation is valid only for multi-zone instances. | ||
Takes some zones offline when multiple zones are available. The nodes in the offline zones are migrated to other zones. | ||
Obtains the region information of Alibaba Cloud Elasticsearch. | ||
Enables or disables the write high availability (HA) feature for a cluster. This feature is supported only for instances in the China (Beijing) region. | ||
Interrupts a configuration change on an instance. This operation is valid only for instances that are in the activating state. After the interruption, the instance enters the suspended state. | ||
Resumes an interrupted configuration change on an instance. | ||
Obtains the information of all nodes in a cluster. | ||
Obtains the health status of a specified instance. | ||
Obtains the auto scaling rules of a cluster. You can call this API operation only after you purchase elastic nodes when you create an instance. | ||
Updates the auto scaling rules of a cluster. | ||
Obtains the index list of a cluster. Note The | ||
Migrates nodes from the current zone to a destination zone. | ||
Migrates an instance to a specified resource group. | ||
Changes and enables the maintenance window for an instance. | ||
Obtains the configuration information of the current region. The return value provides full data for reference only. The actual configurations are subject to what is displayed on the console and the buy page. | ||
Obtains a list of ongoing and completed shard recoveries. By default, the information of ongoing shard recoveries is returned. | ||
Recommends the optimal cluster configuration for capacity planning based on the business scenario, queries per second (QPS), and log generation volume. | ||
Collects statistics on the storage capacity and usage of an OpenStore instance. | ||
Creates an Elasticsearch component template. | ||
Obtains a list of Elasticsearch component templates. | ||
Views the details of an Elasticsearch component template. | ||
Updates an Elasticsearch component template. | ||
Deletes an Elasticsearch component template. | ||
Views a list of legacy index templates. | ||
Views the details of a legacy index template. | ||
Deletes a legacy index template. | ||
Tag management | Queries all visible user tags. | |
Queries visible resource-tag relations. | ||
Creates resource-tag relations. | ||
Deletes user resource-tag relations. | ||
Data migration | Specifies a node type and the number of nodes to obtain the nodes that can be used for data migration. | |
Checks whether data on specific nodes of a specified instance can be migrated. | ||
Executes a data migration task. | ||
Obtains the information of a data migration task. | ||
Obtains the data information of a cluster. | ||
Deletes an index migration task. | ||
Cancels a data migration task. | ||
Instance upgrade or downgrade | Specifies a node type and the number of nodes to obtain the nodes that can be scaled in. | |
Checks whether specific nodes of a specified instance can be scaled in. | ||
Performs a scale-in operation on cluster nodes. | ||
Upgrades the version or kernel patch version of an Elasticsearch instance. You can upgrade an instance from version 5.5.3 to 5.6.16, from 5.6.16 to 6.3.2, or from 6.3.2 to 6.7.0. Upgrades between other versions are not supported. For more information, see Upgrade versions. | ||
Changes the configuration of a cluster (upgrade or downgrade). | ||
Cluster configuration | Updates the YML parameter settings of a specified instance. | |
Updates the IK hot-word dictionary of a specified instance. | ||
Updates the synonym dictionary of a specified instance. | ||
Updates the user dictionary of a specified instance. | ||
Updates the dictionary file of the AliNLP analysis plug-in (analysis-aliws) for a specified instance. You can configure a custom dictionary. | ||
Obtains and verifies the details of your dictionary file stored in OSS when you add the file. | ||
Changes the Garbage Collector configuration of a specified instance. | ||
Obtains the scenario-specific template configuration of a specified instance. | ||
Modifies the scenario-specific configuration template of a cluster. | ||
Modifies the content of a scenario-specific template for a cluster. | ||
Obtains recommended cluster configurations. | ||
Obtains the details of a specified type of dictionary and a signed public URL for download. | ||
Plugin management | Obtains the plug-in list of a specified instance. | |
Installs a preset system plug-in. | ||
Uninstalls an installed preset plug-in. | ||
Installs a custom plug-in that has been uploaded to the Elasticsearch console. | ||
Cluster monitoring | Queries the Grafana metric monitoring data of an instance. | |
Obtains a list of Grafana dashboards. | ||
Obtains a list of Grafana alerts. | ||
Sends a test alert message. | ||
Log query | Views instance logs. | |
Security settings | Enables or disables public or internal-facing access to Elasticsearch and Kibana. | |
Updates the VPC internal-facing access whitelist of a specified instance. | ||
Updates the public endpoint access whitelist of a specified instance. | ||
Enables or disables the public endpoint of a specified instance. | ||
Updates the VPC internal-facing access whitelist of a specified instance. | ||
Updates the access whitelist of a specified instance. | ||
Updates the password of the elastic account for a specified instance. | ||
Enables the HTTPS protocol. Before you enable this protocol, make sure that you have purchased client nodes. This requirement does not apply to instances of version 8.5, 7.16, or 7.10 in some regions. | ||
Disables the HTTPS protocol. | ||
Configures network interconnection for an instance. | ||
Removes an interconnected instance. | ||
Obtains a list of instances that can be interconnected with the current instance. Instances that are already interconnected are not included. | ||
Obtains a list of instances that are interconnected with the current instance. | ||
Creates an endpoint in the service account VPC to connect to the endpoint service in your VPC. This establishes a one-way network connection. | ||
Deletes an endpoint in a service VPC. | ||
Views the status of an endpoint in a service VPC. | ||
Data backup | Manually creates a snapshot backup for a cluster. | |
Obtains the data backup settings of a cluster. | ||
Updates the data backup settings of a specified instance. | ||
Obtains a list of cross-cluster OSS repository settings for the current instance. | ||
Obtains the OSS reference repositories that can be added to the current instance. | ||
Creates a reference repository when you configure a cross-cluster OSS repository. | ||
Deletes a cross-cluster OSS reference repository. | ||
Artificial intelligence for IT operations | Enables the AIOps feature for an instance. | |
Disables the AIOps feature for an instance. | ||
Immediately diagnoses an instance. | ||
Obtains historical AIOps reports. | ||
Obtains the IDs of historical AIOps reports. | ||
Obtains the diagnostic indexes for the health diagnosis feature in the AIOps module of a specified instance. | ||
Views a historical AIOps report. | ||
Obtains the scenario settings for AIOps. | ||
Updates the AIOps scenario settings for an instance. | ||
Index management | Creates a cluster index template. This can be used for component-based settings of index templates. | |
Deletes an index template. | ||
Updates the component-based settings of an index template. | ||
Views the details of a component index template, including the index lifecycle. | ||
Queries a list of index templates. | ||
Queries the details of a specified index lifecycle. | ||
Queries a list of existing index lifecycle management (ILM) policies. | ||
Creates an ILM policy. | ||
Deletes a specified lifecycle policy definition. | ||
Modifies an ILM policy. | ||
Creates a data stream. | ||
Deletes a data stream. | ||
Manually rolls over a matching index under a data stream. After this operation, a new index is created for the current data stream and becomes the new write index for the data stream. | ||
Views a list of data streams. | ||
Disables the cloud hosting feature for an index in an Indexing Service cluster. This operation is irreversible. You cannot re-enable the feature after you disable it. |
Kibana
API | Description |
Obtains the Kibana configuration. | |
Modifies the Kibana configuration. Currently, only the Kibana language configuration can be modified. | |
Obtains a list of Kibana plug-ins. | |
Installs a preset Kibana plug-in. The Kibana node must have at least 2 CPU cores and 4 GB of memory. | |
Uninstalls a Kibana plug-in. | |
Updates the Kibana access whitelist of a specified instance. |
Logstash
Category | API | Description |
Instance management | Creates a Logstash instance. | |
Lists the details of all or specified Logstash instances. | ||
Queries the details of a specified instance. | ||
Modifies the information of a specified instance, such as the number of nodes, quota, name, and disk size. | ||
Renews an instance. | ||
Restarts a specified instance. After the restart, the instance enters the activating state. | ||
Modifies the name of a specified instance. | ||
Converts a pay-as-you-go Alibaba Cloud Logstash instance to a subscription instance. | ||
Obtains the estimated time required to restart a Logstash instance. | ||
Releases a specified instance. | ||
Recovers a released Logstash instance that is in the frozen state. | ||
Cluster configuration | Updates the configuration of a specified Logstash instance. | |
Obtains the extension file configuration of a Logstash instance. | ||
Updates the extension file configuration of a Logstash instance. | ||
Cluster monitoring | When you configure X-Pack monitoring for a Logstash instance, obtains a list of available Elasticsearch instances that support X-Pack monitoring. | |
In the monitoring and alerting configuration of a Logstash instance, verifies the connectivity of the Elasticsearch instance that provides X-Pack monitoring. | ||
Updates the X-Pack monitoring and alerting configuration of a Logstash instance. | ||
Obtains the X-Pack monitoring configuration of a Logstash instance. | ||
Plugin management | Obtains the details of all or specified plug-ins. | |
Installs a plug-in. | ||
Uninstalls an installed plug-in. | ||
Log query | Views the logs of a Logstash instance. | |
Change task management | Interrupts an instance change task. After the interruption, the instance enters the suspended state. | |
Resumes an interrupted instance change task. After the resumption, the instance enters the activating state. | ||
Pipeline management | Creates a Logstash pipeline. | |
Obtains the pipeline list of a Logstash instance. | ||
Obtains the pipeline information of a Logstash instance. | ||
Updates Logstash pipeline information. | ||
Immediately deploys a Logstash pipeline. | ||
Stops running a Logstash pipeline. | ||
Updates the Logstash pipeline management method. | ||
Obtains the Logstash pipeline management configuration. | ||
Deletes a specified Logstash pipeline. | ||
When you configure Kibana pipeline management, tests the connectivity between Logstash and Kibana and obtains a list of pipeline IDs created on the destination Kibana. |
Beats
API | Description |
Creates a data collector. | |
Obtains the details of a data collector instance. | |
Retries the installation of a data collector that failed to be installed during creation. | |
Obtains a list of data collectors. | |
Obtains the default configuration file of a data collector. | |
Modifies the name of a data collector. | |
Updates the information of a data collector instance. | |
Starts a data collector. | |
Restarts a data collector. | |
Stops a running data collector. | |
Deletes a data collector. | |
Obtains a list of ECS machines. | |
Updates the ECS machines on which a data collector is installed. | |
Views the status of the ECS machines on which a data collector is installed. | |
Obtains a list of Container Service for Kubernetes (ACK) clusters. | |
Views all namespaces in a specified ACK cluster. | |
Views the information of the Elasticsearch Operator installed on a specified ACK cluster. | |
Installs Elasticsearch Operator on a specified ACK cluster. |
Advanced monitoring and alerts
API | Description |
Views the list of hardware O&M events triggered by an Elasticsearch cluster. | |
Restarts an ECS node in an Alibaba Cloud Elasticsearch instance. |
APM
API | Description |
Starts an APM Server instance. | |
Stops an APM Server instance. | |
Deletes an APM Server instance. | |
Modifies the configuration of an APM Server instance. | |
Queries the details of all APM Server instances. | |
Obtains the details of a specified APM Server instance. |
Resource Access Management
API | Description |
Creates a service-linked role. | |
Verifies whether a service-linked role is created. |