Todos os produtos
Search
Central de documentação

Elasticsearch:ListShardRecoveries

Última atualização: Jun 27, 2026

Consulta informações sobre shards em restauração ou já restaurados. Por padrão, a API retorna apenas dados de shards em processo de restauração.

Nota

A recuperação de shard consiste na sincronização de dados de um shard primário para uma réplica. Após a conclusão desse processo, as réplicas ficam disponíveis para pesquisa.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar 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 detalhes, consulte Cabeçalhos de requisição comuns.

Sintaxe da requisição

GET /openapi/instances/{InstanceId}/cat-recovery HTTP/1.1

Parâmetros da requisição

Elemento

Tipo

Posição

Obrigatório

Exemplo

Descrição

InstanceId String Path Yes es-cn-7mz293m9a003j****

ID da instância do Elasticsearch.

activeOnly Boolean Query No true

Define se a resposta deve conter apenas informações de recuperação de shards ativos. Valores válidos:

  • true: retorna informações de recuperação somente para shards em restauração.
  • false: retorna informações de recuperação para todos os shards.

Parâmetros de resposta

Elemento

Tipo

Exemplo

Descrição

RequestId String F99407AB-2FA9-489E-A259-40CF6DCC47D9

ID da requisição.

Result Array of Result

Detalhes da recuperação dos shards.

index String my-index-000001

Nome do índice.

sourceHost String 192.168.XX.XX

Endereço IP do nó de source.

sourceNode String 2Kni3dJ

Nome do nó de source.

filesTotal Long 79

Quantidade total de arquivos.

bytesPercent String 80%

Progresso da recuperação em bytes.

translogOps Long 12086

Número de operações de translog a restaurar.

translogOpsPercent String 80%

Progresso de restauração das operações de translog.

bytesTotal Long 12086

Volume total de dados restaurados.

targetHost String 192.168.XX.XX

Endereço IP do nó de destino.

targetNode String YVVKLmW

Nome do nó de destino.

filesPercent String 80.0%

Progresso da recuperação de arquivos.

stage String done

Estágio da recuperação. Valores válidos:

  • done: Recuperação concluída.
  • finalize: Limpeza em andamento.
  • index: Leitura de metadados do índice e cópia de bytes da origem para o destino.
  • init: Recuperação não iniciada.
  • start: Recuperação iniciada.
  • translog: Reaplicação de operações de translog.

Exemplos

Exemplos de requisições

GET /openapi/instances/es-cn-7mz293m9a003j****/cat-recovery HTTP/1.1

Exemplos de respostas de sucesso

Formato JSON

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

{
  "RequestId" : "F99407AB-2FA9-489E-A259-40CF6DCC47D9",
  "Result" : [ {
    "index" : "my-index-000001",
    "sourceHost" : "192.168.XX.XX",
    "sourceNode" : "2Kni3dJ",
    "targetHost" : "192.168.XX.XX",
    "targetNode" : "YVVKLmW",
    "stage" : "index",
    "filesTotal" : 79,
    "filesPercent" : "80.0%",
    "bytesTotal" : 12086,
    "bytesPercent" : "80%",
    "translogOps" : 12086,
    "translogOpsPercent" : "80%"
  }, {
    "index" : "my-index-000002",
    "sourceHost" : "192.168.XX.XX",
    "sourceNode" : "2Kni3dJ",
    "targetHost" : "192.168.XX.XX",
    "targetNode" : "YVVKLmW",
    "stage" : "index",
    "filesTotal" : 56,
    "filesPercent" : "100%",
    "bytesTotal" : 11086,
    "bytesPercent" : "100%",
    "translogOps" : 11086,
    "translogOpsPercent" : "100%"
  } ]
}

Código de erro

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