Listagem de registros de backup da instância do DCS
Função
Essa API é usada para consultar os registros de backup de uma instância específica do DCS.
URI
GET /v2/{project_id}/instances/{instance_id}/backups
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
instance_id |
Sim |
String |
ID da instância. |
project_id |
Sim |
String |
ID do projeto. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
begin_time |
Não |
String |
Hora de início da consulta (UTC). Formato: aaaaMMddHHmmss, por exemplo, 20170718235959. |
end_time |
Não |
String |
Hora final da consulta (UTC). Formato: aaaaMMddHHmmss, por exemplo, 20170718235959. |
limit |
Não |
Integer |
Número de itens exibidos em cada página. |
offset |
Não |
Integer |
Deslocamento, que é a posição onde a consulta começa. O valor deve ser superior ou igual a 0. |
Parâmetros de solicitação
Nenhum
Parâmetros de resposta
Código de estado: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
total_num |
Integer |
Número de registros retornados. |
backup_record_response |
Array of BackupRecordResponse objects |
Matriz dos detalhes do backup. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
backup_id |
String |
ID de backup. |
period |
String |
Tempo de execução do backup. |
backup_name |
String |
Nome do registro de backup. |
instance_id |
String |
ID da instância. |
size |
Long |
Tamanho do arquivo de backup (byte). |
backup_type |
String |
Tipo de backup.
Valores de enumeração:
|
created_at |
String |
Hora em que a tarefa de backup é criada. |
updated_at |
String |
Hora em que o backup da instância do DCS é concluído. |
progress |
String |
Progresso do backup. |
error_code |
String |
Código de erro exibido para uma falha de backup.
|
remark |
String |
Descrição do backup da instância DCS. |
status |
String |
Status do backup. As opções são as seguintes:
Valores de enumeração:
|
is_support_restore |
String |
Se a restauração é suportada. Opções: TRUE e FALSE. |
Código de estado: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
error_code |
String |
Código de erro. Máximo: 9 |
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
error_code |
String |
Código de erro. Máximo: 9 |
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Exemplos de solicitações
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/backups?offset={offset}&limit={limit}&beginTime={begin_Time}&end_time={end_Time}
Exemplo de respostas
Código de estado: 200
Registros de backup da instância DCS consultados com êxito.
{ "total_num" : 1, "backup_record_response" : [ { "period" : { }, "backup_type" : "manual", "created_at" : "2019-05-10T08:31:16.166Z", "remark" : "001", "is_support_restore" : "TRUE", "backup_id" : "4631832a-14c6-45b0-a0b3-3abd8f591ad1", "backup_name" : "backup_20190510163116", "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79", "size" : 880232, "updated_at" : "2019-05-10T08:32:30.546Z", "progress" : "100.00", "error_code" : { }, "status" : "succeed" } ] }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
Registros de backup da instância DCS consultados com êxito. |
400 |
Pedido inválido. |
500 |
Erro de serviço interno. |
Códigos de erro
Consulte Códigos de erro.