Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda> Document Database Service> Referencia de la API> APIs V3.0 (recomendado)> Copia de respaldo y restauración> Consulta de la lista de copia de respaldo

Actualización más reciente 2022-11-07 GMT+08:00

Consulta de la lista de copia de respaldo

Función

Esta API se utiliza para consultar copias de seguridad en función de las condiciones especificadas.

Depuración

Puede depurar esta API en API Explorer.

URI

Formato URI
GET https://{Endpoint}/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}&mode={mode}
Ejemplo
https://dds.ap-southeast-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c0c9f155c7b7423a9d30f0175998b63bin01&offset=0&limit=10&begin_time=2018-08-06 10:41:14&end_time=2018-08-16 10:41:14

Descripción del parámetro

**Tabla 1** Descripción del parámetro
Nombre	Obligatorio	Descripción
project_id	Sí	Especifica el ID de proyecto de un inquilino en una región.
instance_id	No	Especifica el ID de instancia, que se puede obtener llamando a la API para consultar instancias. Si no tiene una instancia, puede llamar a API utilizada para crear una instancia.
backup_id	No	Especifica el ID de copia de respaldo. Si el ID de copia de respaldo pertenece a una copia de respaldo incremental automatizada, se debe especificar el ID de instancia.
backup_type	No	Especifica el tipo de copia de respaldo. Auto: indica la copia de respaldo completa automatizada. Manual indica una copia de respaldo completa manual. Incremental: indica backup incremental automatizado. Si este parámetro no se transfiere, todas las copias de seguridad completas, incluidas las copias de seguridad completas automáticas y manuales, se consultan de forma predeterminada. Cuando el valor de este campo es Incremental, se debe transferir el ID de instancia.
offset	No	Especifica la posición del índice. La consulta comienza a partir del siguiente tiempo de creación de instancia indexado por este parámetro en un proyecto especificado. Si offset se establece en N, la consulta de recursos comienza desde el dato N+1. El valor debe ser mayor o igual a 0. Si este parámetro no se transfiere, offset se establece en 0 de forma predeterminada, lo que indica que la consulta comienza desde la última instancia de base de datos creada.
limit	No	Especifica el número máximo permitido de copias de seguridad que se van a consultar. El valor varía de 1 a 100. Si este parámetro no se transfiere, las primeras 100 instancias de base de datos se consultan de forma predeterminada.
begin_time	No	Specifies the start time of the query. El formato es aaaa-mm-dd hh:mm:ss. El valor está en formato UTC. NOTA: Cuando end_time no está vacío, begin_time es obligatorio.
end_time	No	Especifica la hora de finalización de la consulta. El formato es "aaaa-mm-dd hh:mm:ss". El valor está en formato UTC. NOTA: Cuando begin_time no está vacío, begin_time es obligatorio.
mode	No	Especifica el modo de instancia de base de datos. Valor válido: Sharding ReplicaSet Single

Solicitudes

Ninguno

Respuestas

Descripción del parámetro

**Tabla 2** Descripción del 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 consultados.

**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.
instance_id	String	Indica el ID de la instancia de base de datos desde la que se creó la copia de respaldo. Puede obtener el ID llamando a la API para consultar instancias de base de datos. Si no tiene una instancia, puede llamar a API utilizada para crear una instancia.
instance_name	String	Indica el nombre de la instancia de base de datos para la que se crea la copia de respaldo.
datastore	Object	Indica la versión de la base de datos. Para obtener más información, consulte Tabla 4.
type	String	Indica el tipo de copia de respaldo. Auto: indica la copia de respaldo completa automatizada. Manual indica una copia de respaldo completa manual. Incremental: indica backup incremental automatizado.
begin_time	String	Indica la hora de inicio de la copia de respaldo. El formato de la hora de inicio es aaaa-mm-dd hh:mm:ss. El valor está en formato UTC.
end_time	String	Indica la hora de finalización de la copia de respaldo. El formato de la hora final es aaaa-mm-dd hh:mm:ss. El valor está en formato UTC.
status	String	Indica el estado de la copia de respaldo. Valor válido: BUILDING: Backup in progress COMPLETED: Backup completed FAILED: Backup failed DISABLED: Backup being deleted
size	Long	Indica el tamaño de la copia de respaldo en KB.
description	String	Indica la descripción de la copia de respaldo.

**Tabla 4** descripción de la estructura de datos del campo del almacén de datos
Nombre	Tipo	Descripción
type	String	Indica el motor de base de datos. Valor válido: DDS-Community.
version	String	Indica la base de datos de la versión 3.2, 3.4 o 4.0. El valor es 3.2, 3.4, o 4.0.

Ejemplo de respuesta

{ 
 "backups": [ 
    { 
        "id": "43e4feaab48f11e89039fa163ebaa7e4br01", 
        "name": "backup-test", 
        "instance_id": "43e4feaab48f11e89039fa163ebaa7e4br01", 
        "instance_name": "cluster-test",
        "datastore" : {  
               "type" : "DDS-Community",  
               "version" : "3.4" 
        }, 
        "type": "auto", 
        "begin_time": "2018-08-06 12:41:14", 
        "end_time": "2018-08-06 12:43:14",
        "status": "COMPLETED", 
        "size": 2803,
        "description": "backup description"
     } 
   ], 
   "total_count":1 
}