Todos os produtos
Search
Central de documentação

Elasticsearch:RenewInstance

Última atualização: Jun 27, 2026

Use a API RenewInstance para renovar uma instância por assinatura.

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 /openapi/instances/[InstanceId]/actions/renew HTTPS|HTTP

Parâmetros da requisição

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

InstanceId

String

Sim

es-cn-n6w1o1x0w001c****

ID da instância.

clientToken

String

Não

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

Garante a idempotência da requisição. Gere o valor pelo cliente e assegure que seja único entre requisições distintas. O token aceita apenas caracteres ASCII e deve ter no máximo 64 caracteres.

RequestBody

Os campos a seguir também são obrigatórios no RequestBody para especifique as informações de renovação.

Campo

Tipo

Obrigatório

Exemplo

Descrição

duration

Integer

Sim

1

Duração da renovação do cluster por assinatura. Se pricingCycle for Year, a duração varia de 1 a 3. Se for Month, varia de 1 a 9.

pricingCycle

String

Sim

Year

Ciclo de faturamento da renovação. Valores válidos: Year e Month.

Exemplo:


{
    "duration":1,
    "pricingCycle":"Year"
}
            

Parâmetros de resposta

ParâmetroTipoExemploDescrição
RequestIdStringF99407AB-2FA9-489E-A259-40CF6DCC****

ID da requisição.

ResultBooleantrue

Resultados retornados:

  • true: renovação bem-sucedida
  • false: falha na renovação

Exemplos

Exemplos de requisição

POST /openapi/instances/es-cn-n6w1o1x0w001c****/actions/renew HTTP/1.1
Common request parameters
{
    "duration":1,
    "pricingCycle":"Year"
}

Exemplos de resposta de sucesso

Formato JSON

{
    "Result": true,
    "RequestId": "4FF74B95-7D01-44B4-8E0D-6E5AB515****"
}

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 a Central de Erros da API.