Consulta de copias de respaldo

Función

Esta API se utiliza para consultar copias de respaldo de acuerdo con los criterios de búsqueda. Antes de invocar a esta API:

Esta API no estará disponible el 31 de marzo de 2024. Se recomienda cambiar las cargas de trabajo a la nueva API (Consulta de copias de respaldo) antes de esa fecha.

• Aprender cómo autorizar y autenticarla.
• Obtener los región y punto de conexión requeridos.

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}

• Ejemplo

  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

• Descripción de parámetro

  Tabla 1 Descripción de parámetro

  Nombre	Tipo	Obligatorio	Descripción
  project_id	String	Sí	ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto.
  instance_id	String	No	ID de instancia de base de datos.
  backup_id	String	No	ID de copia de respaldo.
  backup_type	String	No	Tipo de copia de respaldo. Valor: auto: copia de respaldo completa automatizada manual: copia de respaldo completa manual
  offset	String	No	Desplazamiento de índice. Si offset se establece en N, la consulta de recursos comienza desde el dato N+1. El valor es 0 de forma predeterminada, lo que indica que la consulta comienza desde el primer dato. El valor no puede ser un número negativo.
  limit	String	No	Número de registros a consultar. El valor predeterminado es 100. El valor debe ser un número positivo entero. El valor mínimo es de 1 y el valor máximo de 100.
  begin_time	String	No	Hora de inicio de la consulta. El formato es "yyyy-mm-ddThh:mm:ssZ". T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, en la zona horaria de Beijing, el desplazamiento de la zona horaria se muestra como +0800.
  end_time	String	No	Hora de finalización de la consulta. El formato es "yyyy-mm-ddThh:mm:ssZ" y la hora de finalización debe ser posterior a la hora de inicio. T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, en la zona horaria de Beijing, el desplazamiento de la zona horaria se muestra como +0800.

Solicitud

Ninguna

Respuesta

• Respuesta normal

  Tabla 2 Descripción de parámetro

  Nombre	Tipo	Descripción
  backups	Array of objects	Información de copia de respaldo. Para obtener más información, consulte Tabla 3.
  total_count	Integer	Número total de registros.

  Tabla 3 descripción de la estructura de datos del campo de copias de respaldo

  Nombre	Tipo	Descripción
  id	String	ID de copia de respaldo.
  name	String	Nombre de copia de respaldo.
  begin_time	String	Hora de inicio de copia de respaldo en el formato "yyyy-mm-ddThh:mm:ssZ". T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, en la zona horaria de Beijing, el desplazamiento de zona horaria se muestra como +0800.
  end_time	String	Hora de finalización de la copia de seguridad en el formato "yyyy-mm-ddThh:mm:ssZ". T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, en la zona horaria de Beijing, el desplazamiento de zona horaria se muestra como +0800.
  status	String	Estado de la copia de respaldo. Valor: BUILDING: Copia de respaldo en curso COMPLETED: Copia de respaldo completada FAILED: Error de copia de respaldo AVAILABLE: Copia de respaldo disponible
  take_up_time	Integer	Duración de la copia de respaldo en minutos.
  type	String	Tipo de copia de respaldo. Valor: auto: copia de respaldo completa automatizada manual: copia de respaldo completa manual
  size	Double	Tamaño de copia de respaldo en MB.
  datastore	Object	Información de la base de datos. Para obtener más información, consulte Tabla 4.
  instance_id	String	ID de instancia de base de datos.
  backup_level	String	Nivel de copia de respaldo. Este parámetro se devuelve cuando la función de copia de respaldo de nivel 1 está habilitada. Valor: 1: level-1 backup 2: level-2 backup 0: Backup being created or creation failed

  Tabla 4 descripción de la estructura de datos del campo del almacén de datos

  Nombre	Tipo	Descripción
  type	String	Motor de base de datos.
  version	String	Versión de base de datos.

• Ejemplo de respuesta 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 estado

Para obtener más información, consulte Códigos de estado.

Código de error.

Para obtener más información, consulte Códigos de error.