Todos os produtos
Search
Central de documentação

Elasticsearch:AtualizeAdvancedSetting

Última atualização: Jun 27, 2026

Use a API UpdateAdvancedSetting para alterar a configuração do coletor de lixo da instância especificada.

Depuração

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

Cabeçalho da requisição

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

Sintaxe da requisição

POST|PUT /openapi/instances/[InstanceId]/actions/update-advanced-setting HTTPS|HTTP

Parâmetros da requisição

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

InstanceId

String

Sim

es-cn-09k1ruw79000u****

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 assegure sua unicidade entre requisições distintas. O token deve conter apenas caracteres ASCII e ter no máximo 64 caracteres.

RequestBody

Especifique os seguintes parâmetros no RequestBody para definir a nova configuração do coletor de lixo.

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

gcName

String

Sim

CMS

Novo nome do coletor de lixo. Tipos suportados: CMS e G1.

Exemplo:


{
    "gcName":"CMS"
}
            

Parâmetros de resposta

ParâmetroTipoExemploDescrição
RequestIdString5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****

ID da requisição.

ResultBooleantrue

Resultados retornados:

  • true: configuração do coletor de lixo alterada com sucesso
  • false: falha ao alterar a configuração do coletor de lixo

Exemplos

Exemplos de requisição

POST /openapi/instances/es-cn-09k1ruw79000u****/actions/update-advanced-setting HTTP/1.1
Common request parameters
{
    "gcName":"CMS"
}

Exemplos de resposta de sucesso

Formato JSON

{
    "Result": true,
    "RequestId": "D7BA7E23-F6B7-4D57-BBE4-67EACAAB****"
}

Códigos de erro

HttpCode

Código de erro

Mensagem de erro

Descrição

400

InstanceNotFound

The instanceId provided does not exist.

A instância especificada não foi encontrada. Verifique o status da instância.

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.