Todos os produtos
Search
Central de documentação

Elasticsearch:Lista de operações por função

Última atualização: Jul 03, 2026

As tabelas a seguir listam as operações de API disponíveis para Elasticsearch, Kibana, Logstash e Beats. Caso precise utilizar uma operação de API não listada nestas tabelas, entre em contato com o suporte técnico da Alibaba Cloud para obtê-la.

Elasticsearch

Categoria

Operação

Descrição

Gerenciamento de cluster

createInstance

Crie um cluster do Elasticsearch.

ListInstance

Consulta informações sobre um cluster do Elasticsearch ou todos os clusters.

DescribeInstance

Consulta informações sobre um cluster do Elasticsearch.

EstimatedRestartTime

Consulta o tempo estimado necessário para reiniciar um cluster do Elasticsearch.

RestartInstance

Reinicia um cluster do Elasticsearch.

UpdateInstanceChargeType

Altera o método de faturamento de um cluster do Elasticsearch de pagamento conforme o uso para assinatura.

UpdateDescription

Altera o nome de um cluster do Elasticsearch.

DeleteInstance

Libera um cluster do Elasticsearch com pagamento conforme o uso. Após a liberação, os recursos físicos utilizados pelo cluster são recuperados. Os dados armazenados no cluster são excluídos e não podem ser recuperados. Os discos anexados aos nós do cluster e os snapshots criados para o cluster são liberados.

CancelDeletion

Restaura um cluster do Elasticsearch congelado após a liberação.

RenewInstance

Renova um cluster do Elasticsearch de assinatura.

ActivateZones

Restaura os nós em uma zona desativada. Esta operação está disponível apenas para clusters do Elasticsearch multizona.

DeactivateZones

Desativa uma ou mais zonas onde reside um cluster do Elasticsearch multizona e migra os nós das zonas desativadas para outras zonas.

DescribeRegions

Consulta as regiões nas quais o Elasticsearch está disponível.

InterruptElasticsearchTask

Suspende uma tarefa de alteração de um cluster do Elasticsearch. Após a suspensão, o cluster fica no estado suspenso. Esta operação está disponível apenas para clusters do Elasticsearch em estado de ativação.

ResumeElasticsearchTask

Retoma uma tarefa de alteração de um cluster do Elasticsearch.

ListAllNode

Consulta informações sobre todos os nós em um cluster do Elasticsearch.

DescribeElasticsearchHealth

Consulta o status de integridade de um cluster do Elasticsearch.

ListInstanceIndices

Consulta uma lista de índices em um cluster do Elasticsearch.

Nota

A operação ListInstanceIndices aplica-se apenas a clusters do Elasticsearch com o Indexing Service ativado. Recomendamos usar uma Elasticsearch API para consultar informações de índice. Para mais informações, consulte cat indices API.

MigrateToOtherZone

Migra nós entre zonas.

MoveResourceGroup

Move um cluster do Elasticsearch para um grupo de recursos.

ModifyInstanceMaintainTime

Ative e modifique a janela de manutenção de um cluster do Elasticsearch.

GetRegionConfiguration

Consulta as informações de configuração na região atual. Esta operação retorna todas as informações de configuração na região atual apenas para referência. As informações reais no console e na página de compra prevalecem.

ListShardRecoveries

Consulta uma lista de shards que estão sendo restaurados ou já restaurados. Por padrão, esta operação retorna apenas informações sobre shards em processo de restauração.

CapacityPlan

Consulta as configurações recomendadas pelo sistema para planejamento de capacidade de um cluster do Elasticsearch com base em cenários de negócios, consultas por segundo e volume de logs.

Gerenciamento de tags

ListTags

Consulta todas as tags de usuário visíveis.

ListTagResources

Consulta as tags adicionadas aos recursos.

TagResources

Adiciona tags aos recursos.

UntagResources

Remove tags dos recursos.

Migração de dados

GetTransferableNodes

Consulta os nós nos quais os dados podem ser migrados com base no tipo e número de nós especificados.

ValidateTransferableNodes

Verifica se os dados em nós específicos de um cluster do Elasticsearch podem ser migrados.

TransferNode

Execute uma tarefa de migração de dados.

ListDataTasks

Consulta uma lista de tarefas de migração de dados.

GetClusterDataInformation

Consulta as informações de dados de um cluster do Elasticsearch.

DeleteDataTask

Exclui uma tarefa de migração de dados.

CancelTask

Cancela uma tarefa de migração de dados.

Upgrade e downgrade de configuração de cluster

GetSuggestShrinkableNodes

Consulta os nós que podem ser removidos de um cluster do Elasticsearch com base no tipo e número de nós especificados.

ValidateShrinkNodes

Verifica se nós específicos podem ser removidos de um cluster do Elasticsearch.

ShrinkNode

Remove nós de um cluster do Elasticsearch.

UpgradeEngineVersion

Atualize a versão ou a versão do kernel de um cluster do Elasticsearch. Você pode atualizar a versão de um cluster do Elasticsearch apenas da V6.3 para a V6.7.

UpdateInstance

Faz upgrade ou downgrade da configuração de um cluster do Elasticsearch.

Configuração do cluster

UpdateInstanceSettings

Atualize a configuração no arquivo YML de um cluster do Elasticsearch.

UpdateHotIkDicts

Realiza uma atualização contínua (rolling update) para os dicionários IK de um cluster do Elasticsearch.

UpdateSynonymsDicts

Atualize o dicionário de sinônimos de um cluster do Elasticsearch.

UpdateDict

Realiza uma atualização padrão para os dicionários IK de um cluster do Elasticsearch, incluindo o dicionário principal IK e a lista de stopwords IK.

UpdateAliwsDict

Atualize o arquivo de dicionário do plugin analysis-aliws. Este plugin permite enviar um arquivo de dicionário personalizado.

ListDictInformation

Consulta e verifica os detalhes do objeto de dicionário armazenado no Object Storage Service (OSS) ao enviá-lo para um cluster do Elasticsearch.

UpdateAdvancedSetting

Atualize a configuração do coletor de lixo (GC) de um cluster do Elasticsearch.

ListDicts

Consulta os detalhes de um tipo de dicionário e o link gerado com base na assinatura relacionada para baixar o dicionário.

Gerenciamento de plugins

ListPlugins

Consulta uma lista de plugins instalados em um cluster do Elasticsearch.

InstallSystemPlugin

Instale um plugin integrado.

UninstallPlugin

Desinstala um plugin integrado.

InstallUserPlugins

Instale um plugin personalizado enviado ao console do Elasticsearch.

Consulta de log

ListSearchLog

Consulta os logs de um cluster do Elasticsearch.

Configuração de segurança

TriggerNetwork

Ative ou desative o recurso de Acesso à Rede Pública ou Acesso à Rede Privada para Elasticsearch ou Kibana.

UpdatePrivateNetworkWhiteIps

Atualize uma lista de permissões de endereços IP privados de um cluster do Elasticsearch.

UpdatePublicWhiteIps

Atualize uma lista de permissões de endereços IP públicos de um cluster do Elasticsearch.

UpdatePublicNetwork

Ative ou desative o recurso de Acesso à Rede Pública para um cluster do Elasticsearch.

UpdateWhiteIps

Atualize uma lista de permissões de endereços IP privados de um cluster do Elasticsearch.

ModifyWhiteIps

Atualize uma lista de permissões de endereços IP de um cluster do Elasticsearch.

UpdateAdminPassword

Atualize a senha da conta elastic de um cluster do Elasticsearch.

OpenHttps

Ative o HTTPS. Se a versão do seu cluster do Elasticsearch não for V8.5 ou V7.16, certifique-se de que o cluster contenha nós de coordenação antes de chamar esta operação.

CloseHttps

Desativa o HTTPS.

AddConnectableCluster

Conecta clusters do Elasticsearch.

DeleteConnectedCluster

Desconecta clusters do Elasticsearch.

DescribeConnectableClusters

Consulta uma lista de clusters do Elasticsearch que podem ser conectados a um cluster do Elasticsearch. Os clusters já conectados são excluídos da lista.

ListConnectedClusters

Consulta uma lista de clusters do Elasticsearch conectados a um cluster do Elasticsearch.

CreateVpcEndpoint

Crie um endpoint na virtual private cloud (VPC) dentro da conta de serviço do Elasticsearch. Use este endpoint para conectar ao serviço de endpoint em sua VPC, estabelecendo uma conexão privada entre as duas VPCs.

DeleteVpcEndpoint

Exclui um endpoint na VPC dentro da conta de serviço do Elasticsearch.

ListVpcEndpoints

Consulta o status de um endpoint na VPC dentro da conta de serviço do Elasticsearch.

Backup de dados

CreateSnapshot

Crie um snapshot em um cluster do Elasticsearch.

DescribeSnapshotSetting

Consulta a configuração de backup de dados de um cluster do Elasticsearch.

UpdateSnapshotSetting

Atualize a configuração de backup de dados de um cluster do Elasticsearch.

ListSnapshotReposByInstanceId

Consulta uma lista de repositórios OSS compartilhados configurados para um cluster do Elasticsearch.

ListAlternativeSnapshotRepos

Consulta uma lista de repositórios OSS compartilhados que podem ser configurados para um cluster do Elasticsearch.

AddSnapshotRepo

Crie um repositório OSS compartilhado para um cluster do Elasticsearch.

DeleteSnapshotRepo

Exclui um repositório OSS compartilhado para um cluster do Elasticsearch.

O&M Inteligente

OpenDiagnosis

Ative o recurso de O&M inteligente para um cluster do Elasticsearch.

CloseDiagnosis

Desativa o recurso de O&M inteligente para um cluster do Elasticsearch.

DiagnoseInstance

Diagnostica um cluster do Elasticsearch.

ListDiagnoseReport

Consulta os relatórios históricos de O&M inteligente de um cluster do Elasticsearch.

ListDiagnoseReportIds

Consulta os IDs dos relatórios históricos de O&M inteligente de um cluster do Elasticsearch.

ListDiagnoseIndices

Consulta os índices para diagnóstico de integridade realizado em um cluster do Elasticsearch.

DescribeDiagnoseReport

Consulta um relatório histórico de O&M inteligente.

DescribeDiagnosisSettings

Consulta as configurações de cenário para O&M inteligente de um cluster do Elasticsearch.

UpdateDiagnosisSettings

Atualize as configurações de cenário para O&M inteligente de um cluster do Elasticsearch.

Kibana

Operação

Descrição

DescribeKibanaSettings

Consulta a configuração do Kibana.

UpdateKibanaSettings

Modifique a configuração do Kibana. Apenas a configuração de idioma do Kibana pode ser alterada.

ListKibanaPlugins

Consulta os plugins do Kibana.

InstallKibanaSystemPlugin

Instale um plugin integrado para o Kibana. Antes de chamar esta operação, certifique-se de que as especificações do seu nó Kibana sejam de pelo menos 2 vCPUs e 4 GiB de memória.

UninstallKibanaPlugin

Desinstala um plugin do Kibana.

UpdateKibanaWhiteIps

Atualize a lista de permissões de endereços IP que permitem acesso ao console do Kibana de um cluster do Elasticsearch.

Logstash

Categoria

Operação

Descrição

Gerenciamento de cluster

CreateLogstash

Crie um cluster do Logstash.

ListLogstash

Consulta informações sobre um cluster do Logstash ou todos os clusters do Logstash.

DescribeLogstash

Consulta informações sobre um cluster do Logstash.

UpdateLogstash

Modifique a configuração de um cluster do Logstash, como nome, cota, tamanho do disco e número de nós.

RenewLogstash

Renova um cluster do Logstash.

RestartLogstash

Reinicia um cluster do Logstash. Após a reinicialização, o cluster fica no estado de ativação.

UpdateLogstashDescription

Altera o nome de um cluster do Logstash.

UpdateLogstashChargeType

Altera o método de faturamento de um cluster do Logstash de pagamento conforme o uso para assinatura.

EstimatedLogstashRestartTime

Consulta o tempo estimado necessário para reiniciar um cluster do Logstash.

DeleteLogstash

Libera um cluster do Logstash.

CancelLogstashDeletion

Restaura um cluster do Logstash congelado após a liberação.

Configuração do cluster

UpdateLogstashSettings

Atualize a configuração de um cluster do Logstash.

ListExtendfiles

Consulta os arquivos de driver de um cluster do Logstash.

UpdateExtendfiles

Atualize os arquivos de driver de um cluster do Logstash.

Monitoramento do cluster

ListAvailableEsInstanceIds

Consulta os clusters do Elasticsearch que podem ser associados a um cluster do Logstash ao configurar o recurso X-Pack Monitoring para o cluster do Logstash.

ValidateConnection

Testa a conectividade entre um cluster do Logstash e seu cluster do Elasticsearch associado ao configurar o recurso X-Pack Monitoring para o cluster do Logstash.

UpdateXpackMonitorConfig

Atualize as configurações do recurso X-Pack Monitoring de um cluster do Logstash.

DescribeXpackMonitorConfig

Consulta as configurações do recurso X-Pack Monitoring de um cluster do Logstash.

Gerenciamento de plugins

ListLogstashPlugins

Consulta informações sobre um plugin ou todos os plugins.

InstallLogstashSystemPlugin

Instale um plugin.

UninstallLogstashPlugin

Desinstala um plugin.

Consulta de log

ListLogstashLog

Consulta os logs de um cluster do Logstash.

Gerenciamento de tarefas de alteração

InterruptLogstashTask

Suspende uma tarefa de alteração de um cluster do Logstash. Após a suspensão, o cluster do Logstash fica no estado suspenso.

ResumeLogstashTask

Retoma uma tarefa de alteração de um cluster do Logstash. Após a retomada, o cluster do Logstash fica no estado de ativação.

Gerenciamento de pipelines

CreatePipelines

Crie um pipeline em um cluster do Logstash.

ListPipeline

Consulta uma lista de pipelines em um cluster do Logstash.

DescribePipeline

Consulta informações sobre um pipeline em um cluster do Logstash.

UpdatePipelines

Atualize informações sobre pipelines em um cluster do Logstash.

RunPipelines

Execute pipelines em um cluster do Logstash.

StopPipelines

Para pipelines em um cluster do Logstash.

UpdatePipelineManagementConfig

Atualize o método de gerenciamento de pipelines em um cluster do Logstash.

DescribePipelineManagementConfig

Consulta a configuração de gerenciamento de pipelines em um cluster do Logstash.

DeletePipelines

Exclui um pipeline em um cluster do Logstash.

ListPipelineIds

Testa a conectividade entre um cluster do Logstash e o console do Kibana de um cluster do Elasticsearch, e consulta os IDs de pipelines criados no console do Kibana do cluster do Elasticsearch.

Beats

Operação

Descrição

CreateCollector

Crie um shipper.

DescribeCollector

Consulta informações sobre um shipper.

ReinstallCollector

Reinstala um shipper cuja instalação falhou durante a criação.

ListCollectors

Consulta uma lista de shippers.

ListDefaultCollectorConfigurations

Consulta os arquivos de configuração padrão dos shippers.

UpdateCollectorName

Altera o nome de um shipper.

UpdateCollector

Atualize informações sobre um shipper.

StartCollector

Inicia um shipper.

RestartCollector

Reinicia um shipper.

StopCollector

Para um shipper.

DeleteCollector

Exclui um shipper.

ListEcsInstances

Consulta uma lista de instâncias do Elastic Compute Service (ECS).

ModifyDeployMachine

Altera as instâncias ECS nas quais um shipper está instalado.

ListNodes

Consulta os status das instâncias ECS nas quais um shipper está instalado.

ListAckClusters

Consulta uma lista de clusters do Container Service for Kubernetes (ACK).

ListAckNamespaces

Consulta todos os namespaces de um cluster ACK.

DescribeAckOperator

Consulta informações sobre o ES-operator instalado para um cluster ACK.

InstallAckOperator

Instale o ES-operator para um cluster ACK.

Controle de acesso

Operação

Descrição

InitializeOperationRole

Crie uma função vinculada ao serviço.

ValidateSlrPermission

Verifica se uma função vinculada ao serviço foi criada.