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

CategoryOperationDescription
Cluster managementcreateInstanceCreates an Elasticsearch cluster.
ListInstanceQueries the detailed information of all Elasticsearch clusters or a specified Elasticsearch cluster.
DescribeInstanceQueries the detailed information of a specified Elasticsearch cluster.
EstimatedRestartTimeObtains the estimated time that is required to restart an Elasticsearch cluster.
RestartInstanceRestarts a specified Elasticsearch cluster.
UpdateInstanceChargeTypeSwitches the billing method of an Elasticsearch cluster from pay-as-you-go to subscription.
UpdateDescriptionChanges the name of a specified Elasticsearch cluster.
DeleteInstanceReleases 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 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.
CancelDeletionRestores an Elasticsearch cluster that is frozen after it is released.
RenewInstanceRenews a subscription Elasticsearch cluster.
ActivateZonesRestores the nodes in a disabled zone. This operation is available only for multi-zone Elasticsearch clusters.
DeactivateZonesDisables one or more zones where a multi-zone Elasticsearch cluster resides and migrates the nodes in the disabled zones to other zones.
DescribeRegionsQueries the regions whether Elasticsearch is available.
InterruptElasticsearchTaskSuspends 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.
ResumeElasticsearchTaskResumes a change task of an Elasticsearch cluster.
ListAllNodeQueries the information of all the nodes in an Elasticsearch cluster.
DescribeElasticsearchHealthQueries the health status of a specified Elasticsearch cluster.
ListInstanceIndicesQueries the indexes stored in an Elasticsearch cluster.
MigrateToOtherZoneMigrates nodes across zones.
MoveResourceGroupMigrates an Elasticsearch cluster to a specified resource group.
ModifyInstanceMaintainTimeEnables and modifies the maintenance window of an Elasticsearch cluster.
GetRegionConfigurationQueries 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.
ListShardRecoveriesQueries 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.
CapacityPlanQueries 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 managementListTagsQueries all visible user tags.
ListTagResourcesQueries the tags that are added to one or more resources.
TagResourcesAdds tags to resources.
UntagResourcesRemoves tags from resources.
Data migrationGetTransferableNodesQueries the nodes on which data can be migrated based on the specified node type and number of nodes.
ValidateTransferableNodesChecks whether the data on specific nodes in a specified Elasticsearch cluster can be migrated.
TransferNodeRuns a data migration task.
ListDataTasksQueries the information of data migration tasks.
CreateDataTasksCreates a data migration task to migrate data from a specified Elasticsearch cluster to the current Elasticsearch cluster.
GetClusterDataInformationQueries the data information of an Elasticsearch cluster.
DeleteDataTaskDeletes a data migration task.
CancelTaskCancels a data migration task.
Cluster configuration upgrade and downgradeGetSuggestShrinkableNodesQueries the nodes that can be removed from an Elasticsearch cluster based on the specified node type and number of nodes.
ValidateShrinkNodesChecks whether specific nodes can be removed from a specified Elasticsearch cluster.
ShrinkNodeRemoves nodes from an Elasticsearch cluster.
UpgradeEngineVersionUpgrades 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.
UpdateInstanceUpgrades or downgrades the configuration of an Elasticsearch cluster.
Cluster configurationUpdateInstanceSettingsUpdates the configuration in the YML file of a specified Elasticsearch cluster.
UpdateHotIkDictsPerforms a rolling update for the IK dictionaries of a specified Elasticsearch cluster.
UpdateSynonymsDictsUpdates the synonym dictionary of a specified Elasticsearch cluster.
UpdateDictPerforms a standard update for the IK dictionaries of an Elasticsearch cluster, including the IK main dictionary and IK stopword list.
UpdateAliwsDictUpdates the dictionary file of the analysis-aliws plug-in. This plug-in allows you to upload a tailored dictionary file to it.
ListDictInformationQueries and verifies the details of the dictionary object stored in Object Storage Service (OSS) when you upload the object to an Elasticsearch cluster.
UpdateAdvancedSettingUpdates the garbage collector (GC) configuration of a specified Elasticsearch cluster.
ListDictsQueries the details of a specified type of dictionary and the link that is generated based on the related signature to download the dictionary.
Plug-in managementListPluginsQueries the plug-ins that are installed on a specified Elasticsearch cluster.
InstallSystemPluginInstalls a built-in plug-in.
UninstallPluginUninstalls a built-in plug-in.
InstallUserPluginsInstalls a custom plug-in that is uploaded to the Elasticsearch console.
Log queryListSearchLogQueries the logs of an Elasticsearch cluster.
Security configurationTriggerNetworkEnables or disables the Public Network Access or Private Network Access feature for Elasticsearch or Kibana.
UpdatePrivateNetworkWhiteIpsUpdates the private IP address whitelist of a specified Elasticsearch cluster.
UpdatePublicWhiteIpsUpdates the public IP address whitelist of a specified Elasticsearch cluster.
UpdatePublicNetworkEnables or disables the Public Network Access feature for a specified Elasticsearch cluster.
UpdateWhiteIpsUpdates the private IP address whitelist of a specified Elasticsearch cluster.
ModifyWhiteIpsUpdates the IP address whitelist of a specified Elasticsearch cluster.
UpdateAdminPasswordUpdates the password for the elastic account of a specified Elasticsearch cluster.
OpenHttpsEnables 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.
CloseHttpsDisables HTTPS.
AddConnectableClusterConnects Elasticsearch clusters.
DeleteConnectedClusterDisconnects Elasticsearch clusters.
DescribeConnectableClustersQueries 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.
ListConnectedClustersQueries the Elasticsearch clusters that are connected to a specified Elasticsearch cluster.
CreateVpcEndpointCreates 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.
DeleteVpcEndpointDeletes an endpoint in the VPC within the Elasticsearch service account.
ListVpcEndpointsQueries the status of an endpoint in the VPC within the Elasticsearch service account.
Data backupCreateSnapshotCreates a snapshot in an Elasticsearch cluster.
DescribeSnapshotSettingQueries the data backup configuration of an Elasticsearch cluster.
UpdateSnapshotSettingUpdates the data backup configuration of a specified Elasticsearch cluster.
ListSnapshotReposByInstanceIdQueries the shared OSS repositories configured for an Elasticsearch cluster.
ListAlternativeSnapshotReposQueries the shared OSS repositories that can be configured for an Elasticsearch cluster.
AddSnapshotRepoCreates a shared OSS repository for an Elasticsearch cluster.
DeleteSnapshotRepoDeletes a shared OSS repository for an Elasticsearch cluster.
Intelligent O&MOpenDiagnosisEnables the intelligent O&M feature for an Elasticsearch cluster.
CloseDiagnosisDisables the intelligent O&M feature for an Elasticsearch cluster.
DiagnoseInstanceDiagnoses an Elasticsearch cluster.
ListDiagnoseReportQueries the historical intelligent O&M reports of an Elasticsearch cluster.
ListDiagnoseReportIdsQueries the IDs of the historical intelligent O&M reports of an Elasticsearch cluster.
ListDiagnoseIndicesQueries the indexes for health diagnosis performed on a specified Elasticsearch cluster.
DescribeDiagnoseReportQueries a historical intelligent O&M report.
DescribeDiagnosisSettingsQueries the scenario settings for intelligent O&M of an Elasticsearch cluster.
UpdateDiagnosisSettingsUpdates the scenario settings for intelligent O&M of an Elasticsearch cluster.

Kibana

OperationDescription
DescribeKibanaSettingsQueries the configuration of Kibana.
UpdateKibanaSettingsModifies the configuration of Kibana. You can change only the language setting of Kibana.
ListKibanaPluginsQueries the plug-ins of Kibana.
InstallKibanaSystemPluginInstalls 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.
UninstallKibanaPluginUninstalls a plug-in for Kibana.
UpdateKibanaWhiteIpsUpdates the IP address whitelist that allows access to the Kibana console of a specified Elasticsearch cluster.

Logstash

CategoryOperationDescription
Cluster managementCreateLogstashCreates a Logstash cluster.
ListLogstashQueries the detailed information of all Logstash clusters or a specified Logstash cluster.
DescribeLogstashQueries the detailed information of a specified Logstash cluster.
UpdateLogstashModifies the configuration of a specified Logstash cluster, such as the name, quota, disk size, and number of nodes.
RenewLogstashRenews a Logstash cluster.
RestartLogstashRestarts a specified Logstash cluster. After the cluster is restarted, it is in the activating state.
UpdateLogstashDescriptionChanges the name of a specified Logstash cluster.
UpdateLogstashChargeTypeSwitches the billing method of a Logstash cluster from pay-as-you-go to subscription.
EstimatedLogstashRestartTimeQueries the estimated time that is required to restart a Logstash cluster.
DeleteLogstashReleases a specified Logstash cluster.
CancelLogstashDeletionRestores a Logstash cluster that is frozen after it is released.
Cluster configurationUpdateLogstashSettingsUpdates the configuration of a specified Logstash cluster.
ListExtendfilesQueries the third-party libraries of a Logstash cluster.
UpdateExtendfilesUpdates the third-party libraries of a Logstash cluster.
Cluster monitoringListAvailableEsInstanceIdsQueries the Elasticsearch clusters that can be associated with a Logstash cluster when you configure the X-Pack Monitoring feature for the Logstash cluster.
ValidateConnectionTests the connectivity between a Logstash cluster and its associated Elasticsearch cluster when you configure the X-Pack Monitoring feature for the Logstash cluster.
UpdateXpackMonitorConfigUpdates the configuration of the X-Pack Monitoring feature of a Logstash cluster.
DescribeXpackMonitorConfigQueries the configuration of the X-Pack Monitoring feature of a Logstash cluster.
Plug-in managementListLogstashPluginsQueries the detailed information of all plug-ins or a specified plug-in.
InstallLogstashSystemPluginInstalls a plug-in.
UninstallLogstashPluginUninstalls a plug-in.
Log queryListLogstashLogQueries the logs of a Logstash cluster.
Change task managementInterruptLogstashTaskSuspends a change task of a Logstash cluster. After the task is suspended, the Logstash cluster is in the suspended state.
ResumeLogstashTaskResumes a change task of a Logstash cluster. After the task is resumed, the Logstash cluster is in the activating state.
Pipeline managementCreatePipelinesCreates a pipeline in a Logstash cluster.
ListPipelineQueries the pipelines of a Logstash cluster.
DescribePipelineQueries the detailed information of a pipeline in a Logstash cluster.
UpdatePipelinesUpdates the information of pipelines in a Logstash cluster.
RunPipelinesRuns pipelines in a Logstash cluster.
StopPipelinesStops pipelines in a Logstash cluster.
UpdatePipelineManagementConfigUpdates the management method of pipelines in a Logstash cluster.
DescribePipelineManagementConfigQueries the management configuration of pipelines in a Logstash cluster.
DeletePipelinesDeletes a specified pipeline in a Logstash cluster.
ListPipelineIdsTests 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

OperationDescription
CreateCollectorCreates a shipper.
DescribeCollectorQueries the detailed information of a shipper.
ReinstallCollectorInstalls a shipper that failed to be installed when you create the shipper.
ListCollectorsQueries shippers.
ListDefaultCollectorConfigurationsQueries the default configuration files of shippers.
UpdateCollectorNameChanges the name of a shipper.
UpdateCollectorUpdates the information of a shipper.
StartCollectorStarts a shipper.
RestartCollectorRestarts a shipper.
StopCollectorStops a shipper.
DeleteCollectorDeletes a shipper.
ListEcsInstancesQueries Elastic Compute Service (ECS) instances.
ModifyDeployMachineChanges the ECS instances on which a shipper is installed.
ListNodesQueries the statuses of ECS instances on which a shipper is installed.
ListAckClustersQueries Container Service for Kubernetes (ACK) clusters.
ListAckNamespacesQueries all the namespaces of a specified ACK cluster.
DescribeAckOperatorQueries the information of ES-operator that is installed for a specified ACK cluster.
InstallAckOperatorInstalls ES-operator for a specified ACK cluster.

Access control

OperationDescription
InitializeOperationRoleCreates a service-linked role.
ValidateSlrPermissionChecks whether a service-linked role is created.