Definição de uma política de backup automatizado
Descrição
Essa API é usada para definir 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
- 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
String
Sim
O número de dias para reter os arquivos de backup gerados.
A faixa de valores é de 0 a 732. O valor 0 indica que a política de backup automático está desabilitada.
start_time
String
Não
A janela de tempo de backup. Os backups automatizados serão acionados durante a janela de tempo de backup. Esse parâmetro é obrigatório se a política de backup automatizado estiver ativada. Esse parâmetro não é transferido se a política de backup automático estiver desabilitada.
O valor deve ser um valor válido no formato "hh:mm-HH:MM". A hora atual está no formato UTC.
- O valor de HH deve ser 1 maior que o valor de hh.
- Os valores de mm e MM devem ser os mesmos e devem ser definidos como 00.
Valor de exemplo
23:00-00:00
period
String
Não
A configuração do ciclo de backup. Os dados serão automaticamente copiados nos dias selecionados a cada semana.
Intervalo de valores: O valor é uma lista de dígitos separados por vírgulas (,). Cada dígito indica um dia da semana. As restrições ao período de retenção de backup são as seguintes:
- Este parâmetro não é transferido se o seu valor for definido como 0.
- Se você definir o período de retenção para 1 a 6 dias, o backup dos dados será feito automaticamente a cada dia da semana. Defina o valor do parâmetro para 1,2,3,4,5,6,7.
- Se você definir o período de retenção para 7 a 732 dias, selecione pelo menos um dia da semana para o ciclo de backup. Valor de exemplo 1,2,3,4
- Exemplo de solicitação
Habilitar ou modificar uma política de backup automatizado.
{ "backup_policy": { "keep_days": 9, "start_time": "23:00-00:00", "period": "1,4,5,6,7" } }
Desabilitar uma política de backup automatizado.{ "backup_policy": { "keep_days": 0 } }
Respostas
{}
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.