Obtención de copias de respaldo
Función
Esta API se utiliza para obtener copias de respaldo de una instancia de base de datos.
- Antes de invocar a una API, debe entender la API de Autenticación.
Restricciones
Esta API se utiliza para consultar copias de respaldo completas e incrementales de instancias de base de datos.
URI
- Formato de URI
GET /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}
- Descripción de parámetro
Tabla 1 Descripción de parámetro Nombre
Obligatorio
Descripción
project_id
Sí
Especifica el ID de proyecto de un tenant en una región.
Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.
instance_id
Sí
Especifica el ID de instancia de base de datos.
backup_id
No
Especifica el ID de copia de respaldo.
backup_type
No
Especifica el tipo de copia de respaldo. Valor:
- auto: copia de respaldo completa automatizada
- manual: copia de respaldo completa manual
- fragment: copia de respaldo diferencial completa
- incremental: copia de respaldo incremental automatizada
offset
No
Especifica la posición del í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
No
Especifica el número de registros que se van a consultar. El valor predeterminado es 100. El valor no puede ser un número negativo. El valor mínimo es de 1 y el valor máximo de 100.
begin_time
No
Especifica la hora de inicio para obtener la lista de copia de respaldo. El formato de la hora de inicio es "aaaa-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.
NOTA:Cuando begin_time no está vacío, end_time es obligatorio.
end_time
No
Especifica la hora de finalización para obtener la lista de copia de respaldo. El formato de la hora de finalización es "aaaa-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 zona horaria se muestra como +0800.
NOTA:Cuando end_time no está vacío, begin_time es obligatorio.
Solicitud
Respuesta
- Respuesta normal
Tabla 2 Descripción de parámetro Nombre
Tipo
Descripción
backups
Array of objects
Indica la lista de copia de respaldo.
Para obtener más información, consulte Tabla 3.
total_count
Integer
Indica el 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
Indica el ID de copia de respaldo.
name
String
Indica el nombre de la copia de respaldo.
type
String
Indica el tipo de copia de respaldo. Valor:
- auto: copia de respaldo completa automatizada
- manual: copia de respaldo completa manual
- fragment: copia de respaldo diferencial completa
- incremental: copia de respaldo incremental automatizada
size
Long
Indica el tamaño de la copia de respaldo en KB.
status
String
Indica el estado de la copia de respaldo. Valor:
- BUILDING: Copia de respaldo en curso
- COMPLETED: Copia de respaldo completada
- FAILED: Error de copia de respaldo
- DELETING: Copia de respaldo eliminada
begin_time
String
Indica la hora de inicio de la copia de respaldo.
- Para una copia de respaldo completa, indica la hora de inicio de la copia de respaldo completa.
- Para una copia de respaldo incremental de RDS for MySQL, indica la hora en que se ha realizado la última transacción de la última tarea de copia de respaldo incremental.
El formato es aaaa-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
Indica la hora de finalización de la copia de respaldo.
- Para una copia de respaldo completa, indica la hora de finalización de la copia de respaldo completa.
- Para una copia de respaldo incremental de RDS for MySQL, indica la hora en que se ha confirmado la última transacción.
El formato es aaaa-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.
datastore
Object
Indica la versión de la base de datos.
Para obtener más información, consulte Tabla 4.
databases
Array of objects
Indica una lista de bases de datos de Microsoft SQL Server autoconstruidas que admiten copias de respaldo parciales.
Para obtener más información, consulte Tabla 5.
instance_id
String
Indica el ID de la instancia de base de datos para la que se crea la copia de respaldo.
associated_with_ddm
Boolean
Indica si esta instancia está asociada a una instancia DDM.
Tabla 4 descripción de la estructura de datos del campo de datastore Parámetro
Tipo
Descripción
type
String
Indica el motor de base de datos. Su valor puede ser cualquiera de los siguientes y no distingue entre mayúsculas y minúsculas:
- MySQL
- PostgreSQL
- SQLServer
version
String
Indica la versión de la base de datos.
- Ejemplo de respuesta normal
Obtención de todas las copias de respaldo de una instancia de RDS for MySQL:
{ "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx", "type": "auto", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "MySQL", "version": "5.7" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01", "associated_with_ddm": false }], "total_count": 1 }
Obtaining all backups of an RDS for PostgreSQL instance:
{ "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br03", "name": "xxxx.xxx", "type": "incremental", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "PostgreSQL", "version": "9.6" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin03 ", "associated_with_ddm": false }], "total_count": 1 }
Obtención de todas las copias de respaldo de una instancia de RDS for SQL Server:
{ "backups": [{ "id ": "43e4feaab48f11e89039fa163ebaa7e4br04", "name": "xxxx.xxx", "type": "manual", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "SQLServer", "version": "2014_WEB" }, "databases": [{ "name": "user01" }, { "name": "user02" }], "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin04", "associated_with_ddm": false }], "total_count": 1 }
- Respuesta anormal
Para obtener más información, consulte Resultados de solicitud anormales.
Código de estado
- Normal
- Anormal
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.