Backup e restauração manual de dados do PolarSearch - PolarDB: Central de Documentação do Alibaba Cloud

PolarSearch oferece o recurso de snapshot para fazer backup dos dados de índice de um cluster em seu próprio bucket do Object Storage Service (OSS) ou restaurar dados de um bucket do OSS. Esse recurso permite migrar dados entre clusters e executar backups e recuperações personalizadas para clusters PolarSearch. Trata-se de uma solução flexível e de baixo custo para proteção e transferência de dados.

Nota

Este recurso está atualmente em visualização. Para utilizá-lo, envie um ticket para solicitar a ativação.

Pré-requisitos

A versão do seu PolarSearch deve ser 3.0.0.0.0 ou posterior.

Nota
Para verificar a versão do PolarSearch, acesse o PolarSearch pelo endpoint de busca e consulte o campo version.number.
Ative o Alibaba Cloud Object Storage Service (OSS) e crie um bucket para armazenar os snapshots.
É necessário um usuário RAM com a política AliyunOSSFullAccess anexada. Para mais informações, consulte Adicionar permissões a um usuário RAM.

Faturamento

O recurso de snapshot é gratuito. No entanto, armazenar arquivos de snapshot no bucket do OSS gera taxas de armazenamento e requisição. Para mais detalhes, consulte Visão geral do faturamento do OSS.

Registrar um repositório de snapshots

Antes de utilizar o recurso de snapshot, registre um repositório de snapshots e associe-o ao seu bucket do OSS. Use a seguinte API para criar o repositório:

PUT /_snapshot/{repo-name}
{
    "type": "oss",
    "settings": {
      "endpoint": "{endpoint}",
      "bucket": "{bucket-name}",
      "base_path": "{path-name}",
      "region": "{region}",
      "access_key": "{your-AccessKey-ID}", 
      "secret_key": "{your-AccessKey-Secret}",
      "session_token": "{your-STS-Token}",
      "compress": true,
      "chunk_size": "512mb"
    }
}

Descrição dos parâmetros

Parâmetro	Descrição
`{repo-name}`	Nome personalizado para o repositório.
`type`	Tipo do repositório. Defina como `oss`.
`endpoint`	Endpoint do seu bucket do OSS. Para mais informações, consulte Regiões e Endpoints.
`bucket`	Nome do seu bucket do OSS.
`base_path`	(Opcional) Caminho do diretório raiz no bucket do OSS onde os arquivos de snapshot serão armazenados.
`region`	Região onde o bucket está localizado.
`access_key`	Seu AccessKey ID.
`secret_key`	Sua AccessKey Secret.
`session_token`	(Opcional) O STS Token da sua função RAM. Importante Ao usar um STS Token, defina os parâmetros `access_key` e `secret_key` com os valores correspondentes do token. Caso não use STS Token, utilize seu AccessKey ID e AccessKey Secret de longo prazo.
`compress`	(Opcional) Define se os arquivos de metadados do snapshot, como mapeamentos e configurações de índice, devem ser compactados. Este parâmetro não afeta os arquivos de dados. O valor padrão é false.
`chunk_size`	(Opcional) Limite de tamanho para uploads fragmentados durante o processo de snapshot. Dados que excederem esse tamanho serão enviados ao OSS em partes. O valor padrão é 1 GB.

Exemplo

Substitua os parâmetros no comando abaixo pelas suas informações.

curl -X PUT "https://{pc-endpoint}:3001/_snapshot/{repo-name}" \
  -u "{username}:{passwd}" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "oss",
    "settings": {
      "endpoint": "{endpoint}",
      "bucket": "{bucket-name}",
      "base_path": "{path-name}",
      "region": "{region}",
      "access_key": "{your-AccessKey-ID}", 
      "secret_key": "{your-AccessKey-Secret}"
    }
  }'

Criar um snapshot: fazer backup de dados no OSS

Após registrar o repositório de snapshots, crie um snapshot para um índice específico usando a seguinte API:

PUT /_snapshot/{repo-name}/{snapshot-name}?wait_for_completion=true
{
    "indices": "{index-name}",
    "ignore_unavailable":false
}

Descrição dos parâmetros

Categoria do parâmetro	Nome do parâmetro	Descrição
Parâmetro de requisição	`wait_for_completion`	Define se o sistema deve aguardar a conclusão da operação de snapshot. O valor padrão é `false`. Execução síncrona: Ao definir `wait_for_completion=true`, o comando aguarda a criação do snapshot antes de retornar um resultado. Execução assíncrona: Ao definir `wait_for_completion=false`, o comando retorna imediatamente e o snapshot é criado em segundo plano. Verifique o status do snapshot executando o comando abaixo. A operação estará concluída quando o campo `state` na resposta for `SUCCESS`. `GET /_snapshot/{repo-name}/{snapshot-name}/_status`
Parâmetros do corpo da requisição	`indices`	Índices a serem incluídos no backup. É possível usar o caractere curinga (``) e separar vários nomes de índices por vírgulas (`,`). Por padrão, todos os índices são incluídos. Nota* O uso do caractere curinga (`*`) inclui tabelas de sistema no backup. Para evitar o backup ou restauração dessas tabelas, especifique apenas os índices necessários ou use um hífen (`-`) para excluí-las.
	`ignore_unavailable`	Define se um índice inexistente deve ser ignorado para prosseguir com o snapshot. O valor padrão é `false`, o que causa falha na operação.
	`partial`	Permite a criação de snapshots parciais. Se definido como `true`, os dados dos shards bem-sucedidos são salvos mesmo que alguns shards falhem. O valor padrão é `false`.

Exemplo

Substitua os parâmetros no comando abaixo pelas suas informações.

curl -X PUT "https://{pc-endpoint}:3001/_snapshot/{repo-name}/{snapshot-name}?wait_for_completion=true" \
  -u "{username}:{passwd}" \
  -H "Content-Type: application/json" \
  -d '{
    "indices": "{index-name}",
    "ignore_unavailable": false
  }'

Visualizar snapshots

Use a seguinte API para visualizar informações sobre todos os snapshots no seu repositório de snapshots do OSS:

GET /_snapshot/{repo-name}/_all?pretty

Exemplo

Substitua os parâmetros no comando abaixo pelas suas informações.

curl -X GET "https://{pc-endpoint}:3001/_snapshot/{repo-name}/_all?pretty" -u "{username}:{passwd}"

Restaurar dados

Execute o comando abaixo para restaurar dados de índice de um snapshot específico:

Nota

Para restaurar um snapshot de um cluster PolarSearch para outro cluster PolarSearch, o cluster PolarSearch de destino deve registrar o mesmo repositório de snapshots usado pelo cluster PolarSearch de source. Se a restauração ocorrer dentro do mesmo cluster PolarSearch, não é necessário registrar novamente; execute a restauração de dados diretamente.

POST /_snapshot/{repo-name}/{snapshot-name}/_restore?wait_for_completion=true
{
  "indices": "{index-name}",
  "ignore_unavailable": true
}

Parâmetros

Categoria do parâmetro	Nome do parâmetro	Descrição
Parâmetro de requisição	`wait_for_completion`	Define se o sistema deve aguardar a conclusão da restauração do snapshot. O valor padrão é `false`. Execução síncrona: Ao definir `wait_for_completion=true`, o comando aguarda a conclusão da restauração antes de retornar. Execução assíncrona: Ao definir `wait_for_completion=false`, o comando retorna imediatamente e a tarefa de restauração é executada em segundo plano. Acompanhe o progresso da restauração do índice executando o comando abaixo. A restauração estará concluída quando o campo `stage` for `DONE`. `GET /{index-name}/_recovery`
Parâmetros do corpo da requisição	`indices`	Especifica os índices a serem restaurados. O caractere curinga `*` é suportado. Separe múltiplos índices por vírgula `,`. Por padrão, todos os índices são restaurados.
	`ignore_unavailable`	Define se um índice inexistente deve ser ignorado para continuar a criação do snapshot. O valor padrão é `false`, o que causa falha na operação.
	`partial`	Permite a criação de snapshots parciais. Se definido como `true`, os dados dos shards bem-sucedidos são salvos mesmo que alguns shards falhem. O valor padrão é `false`.
	`index_settings`	Substitui as configurações de índice do snapshot durante a restauração. Por exemplo, altere o número de réplicas para corresponder à configuração do cluster de destino.
	`ignore_index_settings`	Lista de configurações de índice a serem ignoradas durante a restauração. Geralmente usado para ignorar configurações específicas do cluster de source.

Exemplo

Substitua os parâmetros no comando abaixo pelas suas informações.

curl -X POST "https://{pc-endpoint}:3001/_snapshot/{repo-name}/{snapshot-name}/_restore?wait_for_completion=true" \
  -u "{username}:{passwd}" \
  -H "Content-Type: application/json" \
  -d '{
    "indices": "{index-name}",
    "ignore_unavailable": true
  }'