Consulta de backups incrementais
Função
Essa API é usada para consultar backups incrementais. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
GET /v3/{project_id}/instances/{instance_id}/incremental-backups
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
instance_id |
Sim |
String |
ID da instância, que é compatível com o formato UUID. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
offset |
Não |
String |
Deslocamento do índice. Se offset for definido como N, a consulta de recursos será iniciada a partir da parte N+1 dos dados. 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 |
String |
Número de registros a serem consultados. Valor: 10 (valor padrão), 20 ou 50. |
begin_time |
Não |
String |
Hora de início da consulta. O formato é "aaaa-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, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100. Quando begin_time não está vazio, end_time é obrigatório. |
end_time |
Não |
String |
Hora de término da consulta. O formato é "aaaa-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, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100. Quando end_time não está vazio, begin_time é obrigatório. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token do usuário. Se o corpo de resposta a seguir for retornado para chamar a API usada para obter um token de usuário, a solicitação será bem-sucedida. Depois que a solicitação é processada, o valor de X-Subject-Token no cabeçalho da mensagem é o valor do token. |
X-Language |
Não |
String |
Tipo de linguagem da solicitação. O valor padrão é en-us. Valor:
|
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
backups |
Array of IncrementalBackups objects |
Informações de backup. |
total_count |
Long |
Número total de arquivos de backup. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID de backup. |
name |
String |
Nome do backup. |
begin_time |
String |
Hora de início do backup no formato "aaaa-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, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100. |
end_time |
String |
Hora de término do backup no formato "aaaa-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, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100. |
size |
Number |
Tamanho do backup, em KB. |
instance_id |
String |
ID da instância. |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitação
Consulta de backups incrementais gerados de 6 de julho de 2022 a 16 de julho de 2022
GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/incremental-backups?offset=0&limit=10&begin_time=2022-07-06T10:41:14+0800&end_time=2022-07-16T10:41:14+0800
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{ "backups" : [ { "id" : "f0d2aea28d26t4848b8c84ed3fea1822fbr07", "name" : "GaussDBforMySQL--20230728181555006", "begin_time" : "2022-07-07T12:41:14+0800", "end_time" : "2022-07-08T12:45:14+0800", "size" : 0.109375, "instance_id" : "61a4ea66210545909d74a05c27a7179ein07" } ], "total_count" : 1 }
Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.