Consulta de backups entre regiões
Função
Esta API é usada para obter backups entre regiões de uma instância na região de backup de destino.
- Antes de chamar uma API, você precisa entender a API em Autenticação.
Restrições
Para o RDS for SQL Server, apenas os detalhes sobre backups completos automáticos entre regiões e backups manuais podem ser consultados.
URI
- Formato de URI
GET /v3/{project_id}/offsite-backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin _time}&end_time={end_time}
- Descrição do parâmetro
Tabela 1 Descrição do parâmetro Nome
Obrigatório
Descrição
project_id
Sim
Especifica o ID do projeto de um locatário em uma região.
Para obter detalhes sobre como obter o ID do projeto, consulte Obtenção de um ID de projeto.
instance_id
Sim
Especifica o ID da instância de banco de dados.
backup_id
Não
Especifica o ID do backup.
backup_type
Sim
Especifica o tipo do backup. O valor pode ser qualquer um dos seguintes:
- auto: backup completo automático e backup manual. O Microsoft SQL Server suporta apenas a consulta deste tipo de cópia de segurança.
- incremental: backup incremental automático
offset
Não
Especifica a posição do índice. Se offset estiver definido como N, a consulta de recursos começará a partir do dado N+1. O valor é 0 por padrão, indicando que a consulta começa a partir da primeira parte dos dados. O valor não pode ser um número negativo.
limit
Não
Especifica o número de registros a serem consultados. O valor padrão é 100. O valor não pode ser um número negativo. O valor mínimo é 1 e o valor máximo é 100.
begin_time
Não
Especifica a hora de início para obter a lista de backups entre regiões. O formato da hora de início é "yyyy-mm-ddThh:mm:ssZ".
T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.
NOTA:Quando begin_time não está vazio, end_time é obrigatório.
end_time
Não
Especifica a hora de término para obter a lista de backups entre regiões. O formato da hora de término é "yyyy-mm-ddThh:mm:ssZ" e a hora de término deve ser posterior à hora de início.
T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.
NOTA:Quando end_time não está vazio, begin_time é obrigatório.
Solicitação
Resposta
- Resposta normal
Tabela 2 Descrição do parâmetro Nome
Tipo
Descrição
backups
Array of objects
Indica a lista de backups.
Para mais detalhes, consulte Tabela 3.
total_count
Integer
Indica o número total de registros.
Tabela 3 Descrição da estrutura de dados do campo backups Nome
Tipo
Descrição
id
String
Indica o ID do backup.
name
String
Indica o nome do backup.
type
String
Indica o tipo do backup. Este parâmetro é retornado somente para instâncias de banco de dados do RDS for MySQL e RDS for PostgreSQL.
O valor pode ser qualquer um dos seguintes:
- auto: backup completo automático
- incremental: backup incremental automático
size
Long
Indica o tamanho do backup em KB.
status
String
Indica o status do backup. O valor pode ser qualquer um dos seguintes:
- BUILDING: backup em andamento
- COMPLETED: backup concluído
- FAILED: falhou no backup
- DELETING: backup sendo excluído
databases
Array of objects
Indica o banco de dados autocriado. Este parâmetro é retornado somente para instâncias de banco de dados do RDS for SQL Server.
Para mais detalhes, consulte Tabela 4.
begin_time
String
Indica a hora de início do backup no formato "yyyy-mm-ddThh:mm:ssZ".
T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.
end_time
String
Indica a hora de término do backup.
- Para um backup completo, indica a hora de término do backup completo.
- Para um backup incremental, ele indica a hora em que a última transação no arquivo de backup foi enviada.
O formato é yyyy-mm-ddThh:mm:ssZ. T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.
datastore
Object
Indica a versão de banco de dados.
para mais detalhes, consulte Tabela 5.
instance_id
String
Indica o ID da instância de banco de dados para a qual o backup é criado.
associated_with_ddm
Boolean
Indica se deve ser associado ao DDM. Este parâmetro é retornado somente para instâncias de banco de dados do RDS for MySQL.
- Exemplo de resposta normal
{ "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx", "type": "auto", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "MySQL", "version": "5.6" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01", "associated_with_ddm": false }], "total_count": 1 }PostgreSQL:
{ "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx", "type": "auto", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "PostgreSQL", "version": "9.6" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01" }], "total_count": 1 }Microsoft SQL Server:{ "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx", "size": 2803, "status": "COMPLETED", "databases": [ { "name": "test" } ], "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "SQLServer", "version": "2016_WEB" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01" }], "total_count": 1 } - Resposta anormal
Para mais detalhes, consulte Resultados anormais da solicitação.
Código de status
- Normal
- Anormal
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.
