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 createInstance Creates an Elasticsearch cluster.
ListInstance Queries the detailed information of all Elasticsearch clusters or a specified Elasticsearch cluster.
DescribeInstance Queries the detailed information of a specified Elasticsearch cluster.
EstimatedRestartTime Obtains the estimated time that is required to restart an Elasticsearch cluster.
RestartInstance Restarts a specified Elasticsearch cluster.
UpdateInstanceChargeType Switches the billing method of an Elasticsearch cluster from pay-as-you-go to subscription.
UpdateDescription Changes the name of a specified Elasticsearch cluster.
DeleteInstance Releases a specified pay-as-you-go Elasticsearch cluster. After the cluster is released, the physical resources used by the cluster are reclaimed. The data stored on 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.
CancelDeletion Restores an Elasticsearch cluster that is frozen after it is released.
RenewInstance Renews a subscription Elasticsearch cluster.
ActivateZones Restores the nodes in a disabled zone. This operation is available only for multi-zone Elasticsearch clusters.
DeactivateZones Disables one or more zones where a multi-zone Elasticsearch cluster resides and migrates the nodes in the disabled zones to other zones.
DescribeRegions Queries the regions whether Elasticsearch is available.
InterruptElasticsearchTask 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.
ResumeElasticsearchTask Resumes a change task of an Elasticsearch cluster.
ListAllNode Queries the information of all the nodes in an Elasticsearch cluster.
DescribeElasticsearchHealth Queries the health status of a specified Elasticsearch cluster.
ListInstanceIndices Queries the indexes stored on an Elasticsearch cluster.
MigrateToOtherZone Migrates nodes across zones.
MoveResourceGroup Migrates an Elasticsearch cluster to a specified resource group.
ModifyInstanceMaintainTime Enables and modifies the maintenance window of an Elasticsearch cluster.
GetRegionConfiguration Queries the configuration information in the current region. This operation returns all the configuration information in the current region. The information is for reference only. The actual information in the console and on the buy page prevails.
ListShardRecoveries 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.
CapacityPlan Queries the configurations that are recommended by the system for capacity planning of a cluster based on the business scenarios, queries per second, and number of logs for the cluster.
Tag management ListTags Queries all the visible user tags.
ListTagResources Queries the tags that are added to one or more resources.
TagResources Adds tags to resources.
UntagResources Removes tags from resources.
Data migration GetTransferableNodes Queries the nodes on which data can be migrated based on the specified node type and number of nodes.
ValidateTransferableNodes Checks whether the data on specific nodes in a specified Elasticsearch cluster can be migrated.
TransferNode Runs a data migration task.
ListDataTasks Queries the information of a data migration task.
CreateDataTasks Creates a data migration task to migrate data from a specified Elasticsearch cluster to the current Elasticsearch cluster.
GetClusterDataInformation Queries the data information of an Elasticsearch cluster.
DeleteDataTask Deletes a data migration task.
CancelTask Cancels a data migration task.
Cluster configuration upgrade and downgrade GetSuggestShrinkableNodes Queries the nodes that can be removed from an Elasticsearch cluster based on the specified node type and number of nodes.
ValidateShrinkNodes Checks whether specific nodes can be removed from a specified Elasticsearch cluster.
ShrinkNode Removes nodes from an Elasticsearch cluster.
UpgradeEngineVersion 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.
UpdateInstance Upgrades or downgrades the configuration of an Elasticsearch cluster.
Cluster configuration UpdateInstanceSettings Updates the configuration in the YML file of a specified Elasticsearch cluster.
UpdateHotIkDicts Performs a rolling update for the IK dictionaries of an Elasticsearch cluster.
UpdateSynonymsDicts Updates the synonym dictionary of an Elasticsearch cluster.
UpdateDict Performs a standard update for the IK dictionaries of an Elasticsearch cluster.
UpdateAliwsDict Updates the dictionary file of the analysis-aliws plug-in. This plug-in allows you to upload a tailored dictionary file to it.
ListDictInformation Queries and verifies the details of the dictionary object stored in Object Storage Service (OSS) when you upload the object to an Elasticsearch cluster.
UpdateAdvancedSetting Updates the garbage collector (GC) configuration of a specified Elasticsearch cluster.
Plug-in management ListPlugins Queries the plug-ins that are installed on a specified Elasticsearch cluster.
InstallSystemPlugin Installs a built-in plug-in.
UninstallPlugin Uninstalls a built-in plug-in.
InstallUserPlugins Installs a custom plug-in that is uploaded to the Elasticsearch console.
Log query ListSearchLog Queries the logs of an Elasticsearch cluster.
Security configuration TriggerNetwork Enables or disables the Public Network Access or Private Network Access feature for Elasticsearch or Kibana.
UpdatePrivateNetworkWhiteIps Updates the private IP address whitelist of a specified Elasticsearch cluster.
UpdatePublicWhiteIps Updates the public IP address whitelist of a specified Elasticsearch cluster.
UpdatePublicNetwork Enables or disables the Public Network Access feature for a specified Elasticsearch cluster.
UpdateWhiteIps Updates the private IP address whitelist of a specified Elasticsearch cluster.
ModifyWhiteIps Updates the IP address whitelist of a specified Elasticsearch cluster.
UpdateAdminPassword Updates the password for the elastic account of a specified Elasticsearch cluster.
OpenHttps Enables HTTPS. Before you call this operation, make sure that your Elasticsearch cluster contains client nodes.
CloseHttps Disables HTTPS.
AddConnectableCluster Connects Elasticsearch clusters.
DeleteConnectedCluster Disconnects Elasticsearch clusters.
DescribeConnectableClusters Queries the Elasticsearch clusters that can be connected to a specified Elasticsearch cluster. The Elasticsearch clusters that are connected to the specified Elasticsearch cluster are excluded.
ListConnectedClusters Queries the Elasticsearch clusters that are connected to a specified Elasticsearch cluster.
Data backup CreateSnapshot Creates a snapshot in an Elasticsearch cluster.
DescribeSnapshotSetting Queries the data backup configuration of an Elasticsearch cluster.
UpdateSnapshotSetting Updates the data backup configuration of a specified Elasticsearch cluster.
ListSnapshotReposByInstanceId Queries the shared OSS repositories configured for an Elasticsearch cluster.
ListAlternativeSnapshotRepos Queries the shared OSS repositories that can be configured for an Elasticsearch cluster.
AddSnapshotRepo Creates a shared OSS repository for an Elasticsearch cluster.
DeleteSnapshotRepo Deletes a shared OSS repository for an Elasticsearch cluster.
Intelligent O&M OpenDiagnosis Enables the intelligent O&M feature for an Elasticsearch cluster.
CloseDiagnosis Disables the intelligent O&M feature for an Elasticsearch cluster.
DiagnoseInstance Diagnoses an Elasticsearch cluster.
ListDiagnoseReport Queries the historical intelligent O&M reports of an Elasticsearch cluster.
ListDiagnoseReportIds Queries the IDs of the historical intelligent O&M reports of an Elasticsearch cluster.
ListDiagnoseIndices Queries the indexes for health diagnosis performed on a specified Elasticsearch cluster.
DescribeDiagnoseReport Queries a historical intelligent O&M report.
DescribeDiagnosisSettings Queries the scenario settings for intelligent O&M of an Elasticsearch cluster.
UpdateDiagnosisSettings Updates the scenario settings for intelligent O&M of an Elasticsearch cluster.

Kibana

Operation Description
DescribeKibanaSettings Queries the configuration of Kibana.
UpdateKibanaSettings Modifies the configuration of Kibana. You can change only the language setting of Kibana.
ListKibanaPlugins Queries the plug-ins of Kibana.
InstallKibanaSystemPlugin 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.
UninstallKibanaPlugin Uninstalls a plug-in for Kibana.
UpdateKibanaWhiteIps Updates the IP address whitelist that allows access to the Kibana console of a specified Elasticsearch cluster.

Logstash

Category Operation Description
Cluster management CreateLogstash Creates a Logstash cluster.
ListLogstash Queries the detailed information of all Logstash clusters or a specified Logstash cluster.
DescribeLogstash Queries the detailed information of a specified Logstash cluster.
UpdateLogstash Modifies the configuration of a specified Logstash cluster, such as the name, quota, disk size, and number of nodes.
RenewLogstash Renews a Logstash cluster.
RestartLogstash Restarts a specified Logstash cluster. After the cluster is restarted, it is in the activating state.
UpdateLogstashDescription Changes the name of a specified Logstash cluster.
UpdateLogstashChargeType Switches the billing method of a Logstash cluster from pay-as-you-go to subscription.
EstimatedLogstashRestartTime Queries the estimated time that is required to restart a Logstash cluster.
DeleteLogstash Releases a Logstash cluster.
CancelLogstashDeletion Restores a Logstash cluster that is frozen after it is released.
Cluster configuration UpdateLogstashSettings Updates the configuration of a specified Logstash cluster.
ListExtendfiles Queries the third-party libraries of a Logstash cluster.
UpdateExtendfiles Updates the third-party libraries of a Logstash cluster.
Cluster monitoring ListAvailableEsInstanceIds Queries the Elasticsearch clusters that can be associated with a Logstash cluster when you configure the X-Pack Monitoring feature for the Logstash cluster.
ValidateConnection Tests the connectivity between a Logstash cluster and its associated Elasticsearch cluster when you configure the X-Pack Monitoring feature for the Logstash cluster.
UpdateXpackMonitorConfig Updates the configuration of the X-Pack Monitoring feature of a Logstash cluster.
DescribeXpackMonitorConfig Queries the configuration of the X-Pack Monitoring feature of a Logstash cluster.
Plug-in management ListLogstashPlugins Queries the detailed information of all plug-ins or a specified plug-in.
InstallLogstashSystemPlugin Installs a plug-in.
UninstallLogstashPlugin Uninstalls a plug-in.
Log query ListLogstashLog Queries the logs of a Logstash cluster.
Change task management InterruptLogstashTask Suspends a change task of a Logstash cluster. After the task is suspended, the Logstash cluster is in the suspended state.
ResumeLogstashTask Resumes a change task of a Logstash cluster. After the task is resumed, the Logstash cluster is in the activating state.
Pipeline management CreatePipelines Creates a pipeline in a Logstash cluster.
ListPipeline Queries the pipelines of a Logstash cluster.
DescribePipeline Queries the detailed information of a pipeline in a Logstash cluster.
UpdatePipelines Updates the information of pipelines in a Logstash cluster.
RunPipelines Runs pipelines in a Logstash cluster.
StopPipelines Stops pipelines in a Logstash cluster.
UpdatePipelineManagementConfig Updates the management method of pipelines in a Logstash cluster.
DescribePipelineManagementConfig Queries the management configuration of pipelines in a Logstash cluster.
DeletePipelines Deletes a specified pipeline in a Logstash cluster.

Beats

Operation Description
CreateCollector Creates a shipper.
DescribeCollector Queries the detailed information of a shipper.
ReinstallCollector Installs a shipper that failed to be installed when you create the shipper.
ListCollectors Queries shippers.
ListDefaultCollectorConfigurations Queries the default configuration files of shippers.
UpdateCollectorName Changes the name of a shipper.
UpdateCollector Updates the information of a shipper.
StartCollector Starts a shipper.
RestartCollector Restarts a shipper.
StopCollector Stops a shipper.
DeleteCollector Deletes a shipper.
ListEcsInstances Queries Elastic Compute Service (ECS) instances.
ModifyDeployMachine Changes the ECS instance on which a shipper is installed.
ListNodes Queries the statuses of ECS instances on which a shipper is installed.
ListAckClusters Queries Container Service for Kubernetes (ACK) clusters.
ListAckNamespaces Queries all the namespaces of a specified ACK cluster.
DescribeAckOperator Queries the information of ES-operator that is installed for a specified ACK cluster.
InstallAckOperator Installs ES-operator for a specified ACK cluster.

Access control

Operation Description
InitializeOperationRole Creates a service-linked role.
ValidateSlrPermission Checks whether a service-linked role is created.