Todos os produtos
Search
Central de documentação

Elasticsearch:ListLogstashPlugins

Última atualização: Jun 27, 2026

Consulta informações detalhadas de todos os plug-ins ou de um plug-in específico.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Cabeçalhos da requisição

Esta operação usa apenas cabeçalhos de requisição comuns. Para mais informações, consulte Cabeçalhos de requisição comuns.

Sintaxe da requisição

GET /openapi/logstashes/{InstanceId}/plugins HTTP/1.1

Parâmetros da requisição

Parâmetro Tipo Localização Obrigatório Observações Descrição
InstanceId String Path Sim ls-cn-oew1qbgl****

ID da instância.

name String Query Não logstash-filter-clone

Nome do plug-in.

page Integer Query Não 10

Número de páginas na lista de plug-ins. Valor padrão: 1. Mínimo: 1. Máximo: 200.

size Integer Query Não 3

Quantidade de entradas retornadas por página. Mínimo: 1. Máximo: 200.

source String Query Não USER

Origem do plug-in. Valores válidos:

  • USER: plug-ins personalizados
  • SYSTEM: plug-in predefinido pelo sistema

Parâmetros de resposta

Parâmetro Tipo Exemplo Descrição
RequestId String 99407AB-2FA9-489E-A259-40CF6DCC****

ID da requisição.

Result Array of Result

Resultados retornados.

description String The clone filter is for duplicating events.

Descrição do plug-in.

specificationUrl String https://xxx.html

Endereço da documentação do plug-in.

state String INSTALLED

Status do plug-in. Valores válidos:

  • INSTALLED: Instalado
  • UNINSTALLED: Não instalado
  • INSTALLING: Instalação em andamento
  • UNINSTALLING: Desinstalação em andamento
  • UPGRADING: Atualização do gateway de backup em andamento
  • FAILED: Falha na instalação
  • UNKNOWN: Cluster perdido e não recriável
source String SYSTEM

Origem do plug-in.

name String logstash-filter-clone

Nome do plug-in.

Os dados retornados também incluem os seguintes parâmetros.

Parâmetro

Tipo

Exemplo

Descrição

Headers

Struct

Cabeçalho da resposta.

└X-Total-Count

Integer

131

Quantidade de plug-ins retornados.

Nota

└ indica um parâmetro filho.

Exemplos

Exemplos de requisições

GET /openapi/logstashes/ls-cn-oew1qbgl****/plugins?name=logstash-filter-clone&page=10&size=3&source=USER HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

Exemplos de respostas de sucesso

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : [ {
    "name" : "logstash-filter-clone",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "The clone filter is for duplicating events. A clone will be created for each type in the clone list.",
    "specificationUrl" : "https://www.elastic.co/guide/en/logstash/6.7/plugins-filters-clone.html"
  }, {
    "name" : "logstash-filter-csv",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "The CSV filter takes an event field containing CSV data, parses it, and stores it as individual fields (can optionally specify the names). This filter can also parse data with any separator, not just commas.",
    "specificationUrl" : "https://www.elastic.co/guide/en/logstash/6.7/plugins-filters-csv.html"
  }, {
    "name" : "logstash-filter-date",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "The date filter is used for parsing dates from fields, and then using that date or timestamp as the logstash timestamp for the event.",
    "specificationUrl" : "https://www.elastic.co/guide/en/logstash/6.7/plugins-filters-date.html"
  } ],
  "RequestId" : "40C0570B-AB40-48BA-8CAE-66EA230A****",
  "Headers" : {
    "X-Total-Count" : 131
  }
}

Código de erro

Para obter uma lista de códigos de erro, visite a Central de Erros de API.