Todos os produtos
Search

Este produto

    Elasticsearch:RestartInstance

    Central de documentação

    Elasticsearch:RestartInstance

    Última atualização: Jun 27, 2026

    Reinicia um cluster Elasticsearch especificado.

    Nota

    Após a reinicialização, a instância entra no estado ativo e seu status muda para active. O Alibaba Cloud Elasticsearch suporta reinicialização de nó único. A reinicialização de nó inclui reinicialização normal e reinicialização blue-green.

    Depuração

    O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame 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

    Esta operação utiliza apenas cabeçalhos de requisição comuns. Para mais informações, consulte Cabeçalhos de requisição comuns.

    Sintaxe da requisição

    POST /openapi/instances/{InstanceId}/actions/restart HTTP/1.1

    Parâmetros da requisição

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

    O ID da instância.

    force Boolean Query Não false

    Defina se deve ignorar o status da instância e forçar a reinicialização.

    • true
    • false: não ignora este parâmetro. Este é o valor padrão.
    clientToken String Query Não 5A2CFF0E-5718-45B5-9D4D-70B3FF****

    Token do cliente usado para garantir a idempotência da requisição. Use o cliente para gerar o token, mas certifique-se de que ele seja exclusivo entre diferentes requisições. O token pode conter apenas caracteres ASCII e não deve exceder 64 caracteres.

    String Body Não { "restartType":"nodeIp", "nodes":["172.16.xx.xx","172.16.xx.xx"], "blueGreenDep":true }

    Especifique as informações dos parâmetros de reinicialização.

    RequestBody

    Também é necessário especificar os seguintes parâmetros no parâmetro RequestBody para definir os detalhes da reinicialização.

    Parâmetro

    Tipo

    Obrigatório

    Exemplo

    Descrição

    restartType

    String

    Não

    instance

    Tipo de reinicialização. Valores válidos:

    instance: Reinicia a instância. Este é o valor padrão.

    nodeIp: Reinicia o nó. É necessário especificar o endereço IP do nó.

    nodeEcsId: Reinicia o nó. Deve-se especificar o ID de uma instância ECS no cluster.

    nodes

    List<String>

    Não

    ["127.0.."]

    Caso selecione Reinicialização de Nó, especifique o endereço IP ou o ID do nó a ser reiniciado.

    blueGreenDep

    Boolean

    Não

    false

    Defina se o deploy blue-green será ativado durante a reinicialização do nó. Valor padrão: false.

    batchCount

    Double

    Não

    25.0

    Concorrência definida quando a instância é reiniciada à força.

    batchUnit

    String

    Não

    percent

    Unidade do batchCount. Valor padrão: percent.

    Nota

    • Se restartType não for especificado ou se uma string vazia for fornecida, o valor padrão será instance. Ao definir o parâmetro como instance, o parâmetro blueGreenDep é ignorado por padrão. As seguintes condições devem ser atendidas:

      • Se force estiver definido como true, batchCount deve ser maior que 0 e menor ou igual a 100. Caso contrário, o erro RestartBatchValueError será retornado.

      • Se force estiver definido como false, batchCount assume 0 por padrão. Definir outro valor resultará no erro NormalRestartNotSupportBatch.

    • Quando restartType estiver definido como nodeIp, o parâmetro batchCount é ignorado por padrão e as seguintes condições devem ser atendidas:

      • O parâmetro nodes não pode estar vazio. Caso contrário, uma mensagem de erro será retornada.

      • Se blueGreenDep for true, o deploy blue-green é ativado na reinicialização do nó. Se for false, o deploy blue-green não é ativado, resultando em uma reinicialização normal.

    Exemplo de instrução:

    
{
    "restartType":"nodeIp",
    "nodes": ["172.16.xx.xx"],
    "blueGreenDep":true
}

    Parâmetros de resposta

    Parâmetro Tipo Exemplo Descrição
    RequestId String F99407AB-2FA9-489E-A259-40CF6DC****

    ID da requisição.

    Result Object

    Resultado retornado.

    nodeAmount Integer 2

    Quantidade de nós de dados.

    publicDomain String es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com

    Endpoint público do cluster.

    createdAt String 2020-07-06T10:18:48.662Z

    Horário de criação da instância.

    status String active

    Status do cluster. Os seguintes valores são suportados:

    • active: Normal
    • activating: Ativando
    • inactive: Congelado
    • invalid: Falha
    kibanaPort Integer 5601

    Número da porta usada para acessar o console Kibana do cluster pela Internet.

    publicPort Integer 9200

    Número da porta usada para acessar o cluster pela Internet.

    paymentType String postpaid

    Método de faturamento da instância.

    Suporta pré-pago (assinatura) e pós-pago (pagamento conforme o uso).

    domain String es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com

    Endpoint interno do cluster.

    description String es-cn-abc

    Nome da instância.

    esVersion String 6.7.0_with_X-Pack

    Versão do cluster.

    kibanaDomain String es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com

    Endpoint público do console Kibana do cluster.

    updatedAt String 2018-07-18T10:10:04.484Z

    Horário da última atualização da instância.

    instanceId String es-cn-n6w1o1x0w001c****

    ID da instância.

    dictList Array of dictList

    Configurações dos dicionários IK.

    fileSize Long 2782602

    Tamanho do arquivo de dicionário. Unidade: byte.

    type String MAIN

    Tipo do dicionário. Valores válidos:

    • STOP: lista de stopwords
    • MAIN: dicionário principal
    • SYNONYMS: dicionário de sinônimos
    • ALI_WS: dicionário Alibaba Cloud
    name String SYSTEM_MAIN.dic

    Nome do arquivo de dicionário.

    sourceType String ORIGIN

    Tipo de source do arquivo de dicionário. Valores válidos:

    • OSS: Object Storage Service (OSS). Certifique-se de que a ACL do bucket OSS relacionado esteja configurada como leitura pública.
    • ORIGIN: Elasticsearch open source
    • UPLOAD: arquivos enviados
    synonymsDicts Array of synonymsDicts

    Configurações dos dicionários de sinônimos.

    fileSize Long 2782602

    Tamanho do arquivo de dicionário. Unidade: byte.

    type String STOP

    Tipo do dicionário. Valores válidos:

    • STOP: lista de stopwords
    • MAIN: dicionário principal
    • SYNONYMS: dicionário de sinônimos
    • ALI_WS: dicionário Alibaba Cloud
    name String SYSTEM_MAIN.dic

    Nome do arquivo de dicionário.

    sourceType String ORIGIN

    Tipo de source do arquivo de dicionário. Valores válidos:

    • OSS: Object Storage Service (OSS). Certifique-se de que a ACL do bucket OSS relacionado esteja configurada como leitura pública.
    • ORIGIN: Elasticsearch open source
    • UPLOAD: arquivos enviados
    kibanaConfiguration Object

    Configurações dos nós Kibana.

    spec String elasticsearch.n4.small

    Especificações do nó.

    amount Integer 1

    Quantidade de nós.

    disk Integer 20

    Tamanho do espaço de armazenamento do nó. Unidade: GB.

    diskType String cloud_ssd

    Tipo de armazenamento.

    masterConfiguration Object

    Configurações dos nós mestres dedicados.

    spec String elasticsearch.sn2ne.large

    Especificações do nó.

    amount Integer 3

    Quantidade de nós.

    disk Integer 20

    Tamanho do espaço de armazenamento do nó. Unidade: GB.

    diskType String cloud_ssd

    Tipo de armazenamento. Apenas cloud_ssd é suportado.

    networkConfig Object

    Configurações de rede.

    vpcId String vpc-bp16k1dvzxtmagcva****

    ID da VPC do cluster.

    vsArea String cn-hangzhou-i

    Selecione uma zona para a instância NLB.

    type String vpc

    Tipo de rede. Apenas VPC é suportada.

    vswitchId String vsw-bp1k4ec6s7sjdbudw****

    ID do vSwitch do cluster.

    nodeSpec Object

    Configurações dos nós de dados.

    spec String elasticsearch.n4.small

    Especificações do nó.

    disk Integer 50

    Capacidade de armazenamento do nó. Unidade: GB.

    diskType String cloud_ssd

    Tipo de armazenamento.

    No exemplo de retorno a seguir, este tópico garante apenas a inclusão dos parâmetros listados nos dados retornados; os parâmetros não mencionados servem apenas como referência. O programa não deve depender obrigatoriamente da obtenção desses parâmetros.

    Exemplos

    Exemplos de requisição

    POST /openapi/instances/es-cn-nif1q8auz0003****/actions/restart HTTP/1.1
Common request header
{
    "restartType":"nodeIp",
    "nodes":["172.16.xx.xx","172.16.xx.xx"],
    "blueGreenDep":true
}

    Exemplos de resposta de sucesso

    Formato JSON

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

{
  "Result" : {
    "instanceId" : "es-cn-nif1q8auz0003****",
    "version" : "7.4.0_with_X-Pack",
    "description" : "es-cn-nif1q8auz0003****",
    "nodeAmount" : 3,
    "paymentType" : "prepaid",
    "status" : "active",
    "privateNetworkIpWhiteList" : [ "0.0.0.0/0" ],
    "enablePublic" : false,
    "nodeSpec" : {
      "spec" : "elasticsearch.n4.small",
      "disk" : 20,
      "diskType" : "cloud_ssd",
      "diskEncryption" : false
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp16k1dvzxtmagcva****",
      "vswitchId" : "vsw-bp1k4ec6s7sjdbudw****",
      "vsArea" : "cn-hangzhou-i",
      "type" : "vpc"
    },
    "createdAt" : "2020-07-06T10:18:48.662Z",
    "updatedAt" : "2020-07-06T10:18:48.662Z",
    "commodityCode" : "elasticsearchpre",
    "extendConfigs" : [ {
      "configType" : "usageScenario",
      "value" : "general"
    }, {
      "configType" : "maintainTime",
      "maintainStartTime" : "02:00Z",
      "maintainEndTime" : "06:00Z"
    } ],
    "endTime" : 1596729600000,
    "clusterTasks" : [ ],
    "vpcInstanceId" : "es-cn-nif1q8auz0003****-worker",
    "resourceGroupId" : "rg-acfm2h5vbzd****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-i",
      "status" : "NORMAL"
    } ],
    "instanceType" : "elasticsearch",
    "inited" : true,
    "tags" : [ ],
    "domain" : "es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com",
    "port" : 9200,
    "esVersion" : "7.4.0_with_X-Pack",
    "esConfig" : {
      "action.destructive_requires_name" : "true",
      "xpack.watcher.enabled" : "false",
      "action.auto_create_index" : "+.*,-*"
    },
    "esIPWhitelist" : [ "0.0.0.0/0" ],
    "esIPBlacklist" : [ ],
    "kibanaIPWhitelist" : [ "0.0.0.0/0", "::/0" ],
    "kibanaPrivateIPWhitelist" : [ ],
    "publicIpWhitelist" : [ ],
    "kibanaDomain" : "es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com",
    "kibanaPort" : 5601,
    "haveKibana" : true,
    "instanceCategory" : "x-pack",
    "dedicateMaster" : false,
    "advancedDedicateMaster" : false,
    "masterConfiguration" : { },
    "haveClientNode" : false,
    "warmNode" : false,
    "warmNodeConfiguration" : { },
    "clientNodeConfiguration" : { },
    "kibanaConfiguration" : {
      "spec" : "elasticsearch.n4.small",
      "amount" : 1,
      "disk" : 0
    },
    "dictList" : [ {
      "name" : "SYSTEM_MAIN.dic",
      "fileSize" : 2782602,
      "sourceType" : "ORIGIN",
      "type" : "MAIN"
    }, {
      "name" : "SYSTEM_STOPWORD.dic",
      "fileSize" : 132,
      "sourceType" : "ORIGIN",
      "type" : "STOP"
    } ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ ],
    "aliwsDicts" : [ ],
    "haveGrafana" : false,
    "haveCerebro" : false,
    "enableKibanaPublicNetwork" : true,
    "enableKibanaPrivateNetwork" : false,
    "advancedSetting" : {
      "gcName" : "CMS"
    }
  },
  "RequestId" : "BB58A51D-CE72-49F9-AF08-F57F3C8A****"
}

    Código de status HTTP

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