Todos os produtos
Search
Central de documentação

Elasticsearch:InstallUserPlugins

Última atualização: Jun 27, 2026

Instala plug-ins personalizados carregados no console do Elasticsearch.

Nota

O recurso de instalação de plug-ins personalizados passa por uma atualização interna e está suspenso. Se precisar usar esse recurso, envie um ticket.

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 o código de exemplo da operação para diferentes SDKs.

Cabeçalhos da requisição

A operação DeleteInstance não possui cabeçalhos de requisição específicos e utiliza apenas os cabeçalhos comuns. Para mais informações, consulte a documentação de parâmetros comuns de requisição.

Sintaxe

POST /openapi/instances/{InstanceId}/plugins/user/actions/install HTTP/1.1

Parâmetros da requisição

Parâmetro

Tipo

Posição

Obrigatório

Exemplo

Descrição

InstanceId

String

Path

Sim

es-cn-i7m27ausp001l****

ID da instância.

String

Body

Não

[ {"name": "pluginName1.zip"}, {"name": "pluginName2.zip"} ]

Especifique a lista de plug-ins personalizados.

RequestBody

Configure os seguintes parâmetros no corpo da requisição para especificar as informações dos plug-ins personalizados.

Item de configuração

Tipo

Obrigatório

Exemplo

Descrição

RequestBody

Array

└ name

String

Sim

pluginName1.zip

Nome de um plug-in personalizado carregado no console do Elasticsearch.

└ indica um parâmetro filho.

A figura a seguir mostra um exemplo.

[
    {"name": "pluginName1.zip"},
    {"name": "pluginName2.zip"}
]

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

RequestId

String

5FFD9ED4-C2EC-4E89-B22B-1ACB6F*

ID da requisição.

Result

Array of String

["pluginName1.zip", "pluginName2.zip"]

Lista de plug-ins a instalar. Se a instalação falhar, o sistema retornará um código de erro. Para mais informações, consulte Códigos de erro.

Exemplos

Exemplos de requisições

POST /openapi/instances/[es-cn-i7m27ausp001l****]/plugins/user/actions/install HTTP/1.1
Common request headers
[
    {"name": "pluginName1.zip"},
    {"name": "pluginName2.zip"}
]

Exemplos de respostas de sucesso

Formato JSON

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

{
  "RequestId" : "5FFD9ED4-C2EC-4E89-B22B-1ACB6F*****",
  "Result" : "[\"pluginName1.zip\", \"pluginName2.zip\"]"
}

Códigos de erro

HttpCode

Código de erro

Mensagem de erro

Mensagem de erro

400

InstanceActivating

Instance is activating.

A instância está em ativação.

400

InstanceNotFound

The instanceId provided does not exist.

Instância não encontrada. Verifique o status da instância.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.