Consulta de uma política de backup automatizado
Descrição
Essa API é usada para consultar uma política de backup automatizado.
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 |
project_id |
string |
path |
Sim |
ID do projeto de um locatário em uma região. Para obter o ID do projeto, consulte Obtenção de um ID de projeto. |
instance_id |
string |
path |
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. |
Solicitações
Nenhuma
Respostas
- Descrição do parâmetro
Tabela 2 Descrição do parâmetro Nome
Tipo
Obrigatório
Descrição
backup_policy
Object
Sim
O objeto de política de backup, incluindo o período de retenção de backup (dias) e a hora de início. Para obter mais informações, consulte Tabela 3.
Tabela 3 Descrição da estrutura de dados do campo backup_policy Nome
Tipo
Obrigatório
Descrição
keep_days
Integer
Sim
O número de dias para reter os arquivos de backup.
start_time
String
Não
A janela de tempo de backup. Os backups automatizados serão acionados durante a janela de tempo de backup.
period
String
Não
A configuração do ciclo de backup. Os dados serão automaticamente copiados nos dias selecionados a cada semana.
- Exemplo de resposta
Habilitar a política de backup automatizado.
{ "backup_policy": { "keep_days": 7, "start_time": "19:00-20:00", "period": "1,2,4,5,6" } }Desabilitar a política de backup automático.{ "backup_policy": { "keep_days": 0 } }
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.
