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:
- Aprender cómo autorizar y autenticarla.
- Obtener los región y punto de conexión requeridos.
URI
GET /v3/{project_id}/backups
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
instance_id |
No |
String |
ID de instancia. |
backup_id |
No |
String |
ID de copia de respaldo. |
backup_type |
No |
String |
Tipo de copia de respaldo. Valor: auto: copia de respaldo completa automatizada manual: copia de respaldo completa manual |
offset |
No |
String |
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 |
No |
String |
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 |
No |
String |
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 |
No |
String |
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. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
No |
String |
Token de usuario. |
X-Language |
No |
String |
Idioma. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
backups |
Array of backups objects |
Información de copia de respaldo. |
total_count |
Long |
Número total de archivos de copia de respaldo. |
Parámetro |
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 la 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 la zona horaria se muestra como +0800. |
status |
String |
Estado de la copia de respaldo. Valor:
Valores válidos:
|
take_up_time |
Integer |
Duración de la copia de respaldo en minutos. |
type |
String |
Tipo de copia de respaldo. Valor:
Valores válidos:
|
size |
Long |
Tamaño de copia de respaldo en MB. |
datastore |
MysqlDatastore object |
Información de la base de datos. |
instance_id |
String |
ID de instancia. |
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. Valores válidos:
Valores válidos:
|
description |
String |
Descripción del archivo de copia de respaldo. |
Parámetro |
Tipo |
Descripción |
---|---|---|
type |
String |
Motor de base de datos. Actualmente, solo se admite gaussdb-mysql. |
version |
String |
Versión de base de datos. Para obtener detalles sobre las versiones del motor de base de datos compatibles, invoque a la API para consultar las versiones del motor de base de datos. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Solicitud de ejemplo
GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800
Ejemplo de respuesta
Código de estado: 200
Success.
{ "backups" : [ { "id" : "1fe4feaab48f11e6654hfa163eba87e4b66u", "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" : "43e4feaab48f11e89039fa163ebaa7e4br01", "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.