Consulta da lista de backups

Descrição

Essa API é usada para consultar backups com base em condições especificadas.

Depuração

Você pode depurar essa API no API Explorer.

URI

• Formato de URI

  GET https://{Endpoint}/v3/{project_id}/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}&mode={mode}

• Exemplo de URI

  https://dds.ap-southeast-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c0c9f155c7b7423a9d30f0175998b63bin01&offset=0&limit=10&begin_time=2018-08-06 10:41:14&end_time=2018-08-16 10:41:14

Solicitações

Nenhuma

Respostas

• Descrição do parâmetro

  Tabela 2 Descrição do parâmetro

  Nome	Tipo	Obrigatório	Descrição
  backups	Array of objects	Sim	A lista de backup. Para obter mais informações, consulte Tabela 3.
  total_count	Integer	Sim	O número total de registros consultados.

  Tabela 3 Descrição da estrutura de dados do campo backups

  Nome	Tipo	Obrigatório	Descrição
  id	String	Sim	Indica o ID de backup.
  name	String	Sim	O nome do backup.
  instance_id	String	Sim	O ID da instância de banco de dados a partir da qual o backup foi criado. Você pode obter o ID chamando a API para consultar instâncias de banco de dados. Se você não tiver uma instância, poderá chamar a API usada para criar uma instância.
  instance_name	String	Sim	O nome da instância de banco de dados para a qual o backup é criado.
  datastore	Object	Sim	A versão do banco de dados. Para obter mais informações, consulte Tabela 4.
  type	String	Sim	O tipo de backup. Auto: indica backup completo automatizado. Manual: indica backup completo manual. Incremental: indica backup incremental automatizado.
  begin_time	String	Sim	A hora de início do backup. O formato da hora de início é aaaa-mm-dd hh:mm:ss. O valor está no formato UTC.
  end_time	String	Sim	A hora de término do backup. O formato da hora final é aaaa-mm-dd hh:mm:ss. O valor está no formato UTC.
  status	String	Sim	O status do backup. Valor válido: BUILDING: Backup em andamento COMPLETED: Backup concluído FAILED: Falhou no backup. DISABLED: Backup sendo excluído
  size	Long	Sim	O tamanho do backup em KB.
  description	String	Sim	A descrição do backup.

  Tabela 4 Descrição da estrutura de dados do campo de armazenamento de dados

  Nome	Tipo	Obrigatório	Descrição
  type	String	Sim	O motor do banco de dados. Valor válido: DDS-Community.
  version	String	Sim	A versão do banco de dados. As versões 4.2, 4.0 e 3.4 são suportadas. O valor pode ser 4.2, 4.0 ou 3.4. NOTA: O DDS 4.2 é restrito para uso comercial. Para obter detalhes, consulte Avisos do DDS. Para garantir que você tenha uma boa experiência usando o DDS, crie uma instância do DDS 4.0.

• Exemplo de resposta

  { 
   "backups": [ 
      { 
          "id": "43e4feaab48f11e89039fa163ebaa7e4br01", 
          "name": "backup-test", 
          "instance_id": "43e4feaab48f11e89039fa163ebaa7e4br01", 
          "instance_name": "cluster-test",
          "datastore" : {  
                 "type" : "DDS-Community",  
                 "version" : "3.4" 
          }, 
          "type": "auto", 
          "begin_time": "2018-08-06 12:41:14", 
          "end_time": "2018-08-06 12:43:14",
          "status": "COMPLETED", 
          "size": 2803,
          "description": "backup description"
       } 
     ], 
     "total_count":1 
  }

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.