Consulta de backups

Função

Essa API é usada para consultar backups de acordo com critérios de pesquisa. Antes de chamar essa API:

Essa API estará indisponível em 31 de março de 2024. É aconselhável mudar as cargas de trabalho para a nova API (Consulta de backups completos) antes disso.

• Saiba como autorizá-la e autenticá-la.
• Obtenha a região e o ponto de extremidade necessários.

URI

• Formato de URI

  GET https://{endpoint}/mysql/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}

• Exemplo

  GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c3ec2c6148ad4d71b1a8411a62df0d3cin07&backup_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800

• Descrição do parâmetro

  Tabela 1 Descrição do parâmetro

  Nome	Tipo	Obrigatório	Descrição
  project_id	String	Sim	ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto.
  instance_id	String	Não	ID da instância de BD.
  backup_id	String	Não	ID de backup.
  backup_type	String	Não	Tipo de backup. Valor: auto: backup completo automatizado manual: backup completo manual
  offset	String	Não	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	String	Não	Número de registros a serem consultados. O valor padrão é 100. O valor deve ser um número inteiro positivo. O valor mínimo é 1 e o valor máximo é 100.
  begin_time	String	Não	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, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.
  end_time	String	Não	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, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.

Solicitação

Nenhuma

Resposta

• Resposta normal

  Tabela 2 Descrição do parâmetro

  Nome	Tipo	Descrição
  backups	Array of objects	Informações de backup. Para mais detalhes, consulte Tabela 3.
  total_count	Integer	Número total de registros.

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

  Nome	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, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.
  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, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.
  status	String	Status do backup. Valor: BUILDING: backup em andamento COMPLETED: backup concluído FAILED: falha no backup AVAILABLE: backup disponível
  take_up_time	Integer	Duração do backup em minutos.
  type	String	Tipo de backup. Valor: auto: backup completo automatizado manual: backup completo manual
  size	Double	Tamanho do backup em MB.
  datastore	Object	Informações do banco de dados. Para mais detalhes, consulte Tabela 4.
  instance_id	String	ID da instância de BD.
  backup_level	String	Nível de backup. Este parâmetro é retornado quando a função de backup de nível 1 está ativada. Valor: 1: backup de nível 1 2: backup de nível 2 0: backup sendo criado ou falha na criação

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

  Nome	Tipo	Descrição
  type	String	Mecanismo de BD.
  version	String	Versão de BD.

• Exemplo de resposta normal

  {
  "backups": [{
  "id": "43e4feaab48f11e89039fa163ebaa7e4br01",
  "name": "GaussDBforMySQL-gauss-e747-20200705185048266",
  "begin_time": "2018-08-06T12:41:14+0800",
  "end_time": "2018-08-06T12:45:14+0800",
  "take_up_time": 2,
  "status": "COMPLETED",
  "type": "auto",
  "size": 2803,
  "datastore": {
  "type": "gaussdb-mysql",
  "version": "8.0"
  },
  "instance_id": "c3ec2c6148ad4d71b1a8411a62df0d3cin07",
  "backup_level": "2"
  }],
  "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.