Todos os produtos
Search
Central de documentação

Elasticsearch:AtualizeXpackMonitorConfig

Última atualização: Jun 27, 2026

Atualiza a configuração do recurso de monitoramento X-Pack de um cluster Logstash.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Cabeçalhos da requisição

Esta operação utiliza apenas cabeçalhos de requisição comuns, sem cabeçalhos específicos. Para mais informações, consulte a seção "Parâmetros de requisição comuns" no tópico "Parâmetros comuns".

Sintaxe da requisição

POST /openapi/logstashes/{InstanceId}/xpack-monitor-config HTTP/1.1

Parâmetros da requisição

Parâmetro Tipo Posição Obrigatório Exemplo Descrição
InstanceId String Path Sim ls-cn-oew1qbgl****

ID da instância Logstash.

ClientToken String Query Não 5A2CFF0E-5718-45B5-9D4D-70B3FF****

Token de cliente que garante a idempotência da requisição. Gere o token no cliente e assegure sua exclusividade entre requisições distintas. O token aceita apenas caracteres ASCII, com limite de 64 caracteres.

Object Body Não

Configuração de monitoramento do X-Pack.

ative Boolean Body Não true

Define se o monitoramento X-Pack deve ser ativado. Valores válidos:

  • true: ativa o monitoramento X-Pack.
  • false: desativa o monitoramento X-Pack.
endpoints Array of String Body Não http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200

Endpoint da instância Elasticsearch.

userName String Body Não elastic

Nome de usuário para acesso ao cluster Elasticsearch.

password String Body Não ******

Senha para acesso ao cluster Elasticsearch.

Parâmetros de resposta

Parâmetro Tipo Exemplo Descrição
Result Boolean true

Resultado da operação. Valores válidos:

  • true: atualização bem-sucedida.
  • false: falha na atualização.
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

ID da requisição.

Exemplos

Exemplo de requisição

POST /openapi/logstashes/ls-cn-oew1qbgl****/xpack-monitor-config?ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
  "enable" : true,
  "endpoints" : [ "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ],
  "userName" : "elastic",
  "password" : "******"
}

Exemplo de resposta de sucesso

Formato JSON

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

{
  "Result" : true,
  "RequestId" : "30A59FC7-609B-4C12-B6EF-991A5CA7****"
}

Códigos de erro

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