Consulta de copias de respaldo entre regiones
Función
Esta API se utiliza para obtener copias de respaldo entre regiones de una instancia en la región de copia de respaldo de destino.
- Antes de invocar a una API, debe entender la API de Autenticación.
Restricciones
Las copias de respaldo manuales entre regiones solo se pueden consultar para RDS for SQL Server.
URI
- Formato de URI
GET /v3/{project_id}/offsite-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 Parámetros Parámetro
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
Sí
Especifica el tipo de copia de respaldo. Su valor puede ser cualquiera de los siguientes:
- auto: indica copias de respaldo completas automatizadas y copias de respaldo manuales. Las copias de respaldo manuales entre regiones sólo se admiten para RDS for SQL Server.
- incremental: indica copias de respaldo incrementales automatizadas.
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 entre regiones. 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 entre regiones. 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 Parámetros Parámetro
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 Parámetro
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.
Su valor puede ser cualquiera de los siguientes:
- auto: indica copias de respaldo completas automatizadas y copias de respaldo manuales. Las copias de respaldo manuales entre regiones sólo se admiten para RDS for SQL Server.
- incremental: indica copias de respaldo incrementales automatizadas.
size
Long
Indica el tamaño de la copia de respaldo en KB.
status
String
Indica el estado de la copia de respaldo. Su valor puede ser cualquiera de los siguientes:
- BUILDING: Copia de respaldo en curso
- COMPLETED: Copia de respaldo completada
- FAILED: Error de copia de respaldo
- DELETING: se está eliminando la copia de respaldo
databases
Array of objects
Indica la base de datos autoconstruida. Este parámetro se devuelve sólo para instancias de base de datos de RDS for SQL Server.
Para obtener más información, consulte Tabla 4.
begin_time
String
Indica la hora de inicio de la copia de respaldo en el formato "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.
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, indica la hora en que se envió la última transacción en el archivo de copia de respaldo.
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 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 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 se debe asociar a DDM. Este parámetro se devuelve solo para instancias de base de datos de RDS for MySQL.
- Ejemplo de respuesta normal
{ "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.6" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01", "associated_with_ddm": false }], "total_count": 1 }
PostgreSQL:
{ "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": "PostgreSQL", "version": "9.6" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01" }], "total_count": 1 }
Microsoft SQL Server:{ "backups": [ { "id": "d0ea632a5c32451dbdb157ef5c2ad3ecbr04", "name": "sqlserver-rds-1784-20221202062025775", "type": "auto", "size": 5956, "status": "COMPLETED", "begin_time": "2022-12-02T06:20:25+0000", "end_time": "2022-12-02T06:24:45+0000", "datastore": { "type": "sqlserver", "version": "2019_SE" }, "instance_id": "ad4ee2b80adb430082d8336d7da2e14din04" }, { "id": "07d6a8ab12304f9aa3f368a6cff21ac9br04", "name": "backup-81f1", "type": "auto", "size": 773, "status": "COMPLETED", "begin_time": "2022-12-02T06:12:22+0000", "end_time": "2022-12-02T06:16:37+0000", "datastore": { "type": "sqlserver", "version": "2019_SE" }, "instance_id": "ad4ee2b80adb430082d8336d7da2e14din04" } ], "total_count": 2 }
- 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.