Todos os produtos
Search
Central de documentação

Elasticsearch:InstallSystemPlugin

Última atualização: Jun 27, 2026

Chame a operação InstallSystemPlugin para instalar um plug-in predefinido do sistema.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer, que também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Cabeçalho da requisição

Esta operação utiliza apenas parâmetros de requisição comuns. Para mais informações, consulte Parâmetros comuns.

Sintaxe da requisição

POST /openapi/instances/[InstanceId]/plugins/system/actions/install HTTPS|HTTP

Parâmetros da requisição

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

InstanceId

String

Sim

es-cn-n6w1o1x0w001c****

O ID da instância.

clientToken

String

Não

5A2CFF0E-5718-45B5-9D4D-70B3FF****

Token exclusivo gerado pelo cliente para garantir a idempotência da requisição. Gere o valor no cliente e certifique-se de que seja único entre diferentes requisições. O token aceita apenas caracteres ASCII e não pode exceder 64 caracteres.

RequestBody

Insira o nome do plug-in a instale no RequestBody, no formato ["plugin_name1","plugin_name2",...,"plugin_namen"], como ["aliyun-sql","codec-compression"].

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

RequestId

String

F99407AB-2FA9-489E-A259-40CF6DCC****

O ID da requisição.

Result

List

["aliyun-sql"]

A lista de plug-ins a instale.

Exemplos

Exemplos de requisições

POST /openapi/instances/es-cn-n6w1o1x0w001c****/plugins/system/actions/install HTTP/1.1
Common request parameters
["aliyun-sql","codec-compression"]

Exemplos de respostas de sucesso

Formato JSON

{
    "Result": ["aliyun-sql"],
    "RequestId": "5A5D8E74-565C-43DC-B031-29289FA*****"
}

Códigos de erro

HttpCode

Código de erro

Mensagem de erro

Descrição

400

InstanceNotFound

The instanceId provided does not exist.

Mensagem retornada porque a instância especificada não foi encontrada. Verifique o status da instância.

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