Restauração de dados para a instância de banco de dados original
Descrição
Esta API é usada para restaurar dados para a instância de banco de dados original.
Depuração
Você pode depurar essa API no API Explorer.
URI
Nome |
Tipo |
IN |
Obrigatório |
Descrição |
---|---|---|---|---|
x-auth-token |
string |
header |
Sim |
Token do usuário |
X-Language |
string |
header |
Não |
Língua |
project_id |
string |
path |
Sim |
ID do projeto. Para obter o ID do projeto, consulte Obtenção de um ID de projeto. |
Solicitações
- Descrição do parâmetro
Tabela 2 Descrição do parâmetro Nome
Tipo
Obrigatório
Descrição
source
Object
Sim
A instância a partir da qual o backup foi criado
Para mais detalhes, consulte Tabela 3.
target
Object
Sim
A instância para a qual o backup é restaurado.
Para mais detalhes, consulte Tabela 4.
Tabela 3 Descrição da estrutura de dados do campo source Nome
Tipo
Obrigatório
Descrição
instance_id
String
Sim
ID da instância, que pode ser obtido chamando a API descrita em Consulta de instâncias e detalhes. Se você não tiver uma instância, chame a API descrita em Criação de uma instância de banco de dados para criar uma.
type
String
Não
O modo de restauração. Valores enumerados:
- backup: indica o uso de arquivos de backup para restauração. Neste modo, type é opcional, backup_id é obrigatório.
- timestamp: indica o modo de restauração point-in-time. Nesse modo, type é obrigatório, restore_time é obrigatório.
backup_id
String
Não
O ID do backup a ser restaurado. Este parâmetro deve ser especificado quando o arquivo de backup é usado para restauração.
restore_time
String
Não
O momento em que os dados são restaurados no carimbo de data/hora UNIX. A unidade é milissegundo e o fuso horário é UTC.
NOTA:Esse parâmetro tem efeito somente para instâncias do conjunto de réplicas.
Tabela 4 Descrição da estrutura de dados do campo target Nome
Tipo
Obrigatório
Descrição
instance_id
String
Sim
Especifica a ID da instância de banco de dados a ser restaurada a partir de um backup. Você pode chamar a API para consultar Instâncias de banco de dados para obter o ID da instância de banco de dados. Se você não tiver uma instância, poderá chamar a API usada para criar uma instância.
- Exemplo de solicitação
- Restauração de um backup:
{ "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02", "type": "backup", "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe" }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02" } }
- Restauração para um ponto no tempo (aplicável a instâncias de conjunto de réplicas e instâncias de cluster 4.0)
{ "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02", "type": "timestamp", "restore_time": 1532001446987 }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02" } }
- Restauração de um backup:
Respostas
- Descrição do parâmetro
Tabela 5 Descrição do parâmetro Nome
Tipo
Obrigatório
Descrição
job_id
String
Sim
ID da tarefa assíncrona para a operação de restauração.
- Exemplo de resposta
{ "job_id": "a03b1b8a-b756-467c-8a49-38720c3d23ec" }
SDK
Clique em SDK do Document Database Service DDS para fazer download do SDK ou exibir o documento do SDK. Para saber como instalar e autenticar um SDK, leia a seção Uso.
Código de status
Para obter mais informações, consulte Código de status.
Código de erro
Para obter mais informações, consulte Código de erro.