Consulta de todas las copias de seguridad
Función
Esta API se utiliza para consultar todas las copias de seguridad.
URI
GET /v3/{project_id}/backups
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de proyecto |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
checkpoint_id |
No |
String |
ID de punto de restauración |
dec |
No |
Boolean |
Dedicated cloud |
end_time |
No |
String |
Hora en que finaliza la copia de respaldo, en formato %YYYY-%mm-%ddT%HH:%MM:%SSZ. Por ejemplo, 2018-02-01T12:00:00Z. |
enterprise_project_id |
No |
String |
ID de proyecto de empresa o all_granted_eps. all_granted_eps indica consultar los IDs de todos los proyectos de empresa en los que el usuario tiene permisos. |
image_type |
No |
String |
Tipo de copia de respaldo, que es backup. |
limit |
No |
Integer |
Número de registros mostrados por página. El valor debe ser un número positivo entero. |
marker |
No |
String |
ID del último registro mostrado en la página anterior |
member_status |
No |
String |
Estado de uso compartido de copias de seguridad Valores de enumeración:
|
name |
No |
String |
Nombre de copia de respaldo |
offset |
No |
Integer |
Valor de desplazamiento. El valor debe ser un número positivo entero. |
own_type |
No |
String |
Poseer tipo de copia de respaldo. copias de seguridad private se consultan de forma predeterminada. Predeterminado: private Valores de enumeración:
|
parent_id |
No |
String |
ID de copia de respaldo principal |
resource_az |
No |
String |
Se admite el filtrado basado en AZ. |
resource_id |
No |
String |
ID de recurso |
resource_name |
No |
String |
Nombre de recurso |
resource_type |
No |
String |
Tipo de recurso, que puede ser OS::Nova::Server, OS::Cinder::Volume, o OS::Sfs::Turbo |
show_replication |
No |
Boolean |
Si se muestran los registros de replicación. Predeterminado: false |
sort |
No |
String |
Un grupo de propiedades separadas por comas (,) y orden de direcciones. El formato de valor es de [:],[:], donde el valor de la dirección es asc (en orden ascendente) o desc (en orden descendente). Si no se especifica la dirección del parámetro, la dirección de ordenación por defecto es desc. El valor de sort contiene un máximo de 255 caracteres. El rango de valores de la clave es el siguiente: [created_at, updated_at, name, status, protected_at, id] |
start_time |
No |
String |
Hora en que se inicia la copia de respaldo, en formato %YYYY-%mm-%ddT%HH:%MM:%SSZ. Por ejemplo, 2018-02-01T12:00:00Z. |
status |
No |
String |
Estado. Cuando se llama a la API, se pueden transferir varios estados para el filtrado, por ejemplo, status=available&status=error. Valores de enumeración:
|
used_percent |
No |
String |
Las copias de seguridad se filtran en función de la capacidad del almacén ocupado. El valor varía de 1 a 100. Por ejemplo, si used_percent se establece en 80, se muestran todas las copias de seguridad que ocuparon el 80% o más de la capacidad del almacén. |
vault_id |
No |
String |
ID de almacén |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. El token se puede obtener llamando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
backups |
Array of BackupResp objects |
Lista de copias de respaldo |
count |
Integer |
Cantidad de copias de respaldo |
offset |
Integer |
Desplazamiento donde comienza la consulta Mínimo: 0 Predeterminado: 0 |
limit |
Integer |
Número de registros mostrados en cada página Mínimo: 1 Máximo: 1000 Predeterminado: 1000 |
Parámetro |
Tipo |
Descripción |
---|---|---|
checkpoint_id |
String |
ID de punto de restauración |
created_at |
String |
Tiempo de creación, por ejemplo, 2020-02-05T10:38:34.209782 |
description |
String |
Descripción de la copia de respaldo |
expired_at |
String |
Tiempo de caducidad, por ejemplo, 2020-02-05T10:38:34.209782 |
extend_info |
BackupExtendInfo object |
Información extendida |
id |
String |
ID de copia de respaldo |
image_type |
String |
Tipo de copia de respaldo, que es backup. |
name |
String |
Nombre de copia de respaldo |
parent_id |
String |
ID de copia de respaldo principal |
project_id |
String |
ID de proyecto |
protected_at |
String |
Tiempo de copia de respaldo |
resource_az |
String |
Zona de disponibilidad de recursos |
resource_id |
String |
ID de recurso |
resource_name |
String |
Nombre de recurso |
resource_size |
Integer |
Tamaño del recurso, en GB |
resource_type |
String |
Tipo de recurso, que puede ser OS::Nova::Server, OS::Cinder::Volume, o OS::Sfs::Turbo |
status |
String |
Estado de la copia de respaldo Valores de enumeración:
|
updated_at |
String |
Tiempo de actualización, por ejemplo, 2020-02-05T10:38:34.209782 |
vault_id |
String |
ID de almacén |
replication_records |
Array of ReplicationRecordGet objects |
Registro de replicación |
enterprise_project_id |
String |
ID de proyecto de empresa. Su valor predeterminado es 0. |
provider_id |
String |
ID de proveedor de copia de respaldo, que se utiliza para distinguir objetos de copia de respaldo. El valor puede ser el siguiente: 0daac4c5-6707-4851-97ba-169e36266b66 indica que los objetos de copia de respaldo son servidores en la nube; d1603440-187d-4516-af25-121250c7cc97 indica que los objetos de copia de respaldo son discos en la nube; 3f3c3220-245c-4805-b811-758870015881 indica que los objetos de copia de respaldo son sistemas de archivos SFS Turbo. |
children |
Array of BackupResp objects |
Lista de copias de respaldo |
Parámetro |
Tipo |
Descripción |
---|---|---|
auto_trigger |
Boolean |
Si la copia de respaldo se genera automáticamente |
bootable |
Boolean |
Si la copia de respaldo es una copia de respaldo de disco del sistema |
incremental |
Boolean |
Si la copia de respaldo es una copia de respaldo incremental |
snapshot_id |
String |
ID de instantánea de la copia de respaldo en disco |
support_lld |
Boolean |
Ya sea para permitir lazyloading para una restauración rápida |
supported_restore_mode |
String |
Modo de restauración. Los valores posibles son na, snapshot, y backup. snapshot indica que la copia de respaldo se puede utilizar para crear una imagen de servidor completo. backup indica que los datos se restauran desde backups de los discos EVS del servidor. na indica que la copia de respaldo solo se puede usar para crear nuevos recursos, pero no se puede usar para la restauración. Predeterminado: na Valores de enumeración:
|
os_images_data |
Array of ImageData objects |
Lista de ID de imágenes creadas con copias de seguridad |
contain_system_disk |
Boolean |
Si los datos de copia de respaldo de VM contienen datos de disco del sistema |
encrypted |
Boolean |
Si la copia de respaldo está cifrada |
system_disk |
Boolean |
Si el disco es un disco del sistema |
Parámetro |
Tipo |
Descripción |
---|---|---|
created_at |
String |
Hora de inicio de la replicación |
destination_backup_id |
String |
ID de la copia de respaldo de destino utilizada para la replicación |
destination_checkpoint_id |
String |
ID de registro de la copia de respaldo de destino utilizada para la replicación |
destination_project_id |
String |
ID del proyecto de destino de replicación |
destination_region |
String |
Región de destino de replicación |
destination_vault_id |
String |
ID del almacén de destino |
extra_info |
ReplicationRecordsExtraInfo object |
Información adicional de la replicación |
id |
String |
ID de registro de replicación |
source_backup_id |
String |
ID de la copia de respaldo de origen utilizada para la replicación |
source_checkpoint_id |
String |
ID del registro de copia de respaldo de origen utilizado para la replicación |
source_project_id |
String |
ID del proyecto de origen de replicación |
source_region |
String |
Región de origen de replicación |
status |
String |
Estado de replicación Valores de enumeración:
|
vault_id |
String |
ID del almacén donde reside la copia de respaldo |
Parámetro |
Tipo |
Descripción |
---|---|---|
progress |
Integer |
Progreso de la replicación |
fail_code |
String |
Código de error. Este campo está vacío si la operación se realiza correctamente. |
fail_reason |
String |
Causa del error |
auto_trigger |
Boolean |
Si la replicación se programa automáticamente |
destinatio_vault_id |
String |
ID del almacén de destino |
Solicitudes de ejemplo
GET https://{endpoint}/v3/{project_id}/backups
Ejemplo de respuestas
Código de estado: 200
OK
{ "count" : 2, "backups" : [ { "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "checkpoint_id" : "1fced58b-2a31-4851-bcbb-96216f83ce99", "updated_at" : "2020-02-21T07:07:25.113761", "vault_id" : "cca85ea5-00a4-418d-9222-bd83985bc515", "id" : "b1c4afd9-e7a6-4888-9010-c2bac3aa7910", "resource_az" : "br-iaas-odin1a", "image_type" : "backup", "resource_id" : "1a503932-ee8f-4dd5-8248-8dfb57e584c5", "resource_size" : 40, "children" : [ ], "extend_info" : { "auto_trigger" : true, "supported_restore_mode" : "backup", "contain_system_disk" : true, "support_lld" : true, "system_disk" : false }, "project_id" : "0605767b5780d5762fc5c0118072a564", "status" : "available", "resource_name" : "test001-02", "description" : "", "expired_at" : "2020-05-21T07:00:54.060493", "name" : "autobk_b629", "created_at" : "2020-02-21T07:00:54.065135", "resource_type" : "OS::Nova::Server" }, { "provider_id" : "d1603440-187d-4516-af25-121250c7cc97", "checkpoint_id" : "f64c351f-769f-4c04-8806-fd90a59e9b12", "updated_at" : "2020-02-21T07:09:37.767084", "vault_id" : "79bd9daa-884f-4f84-b8fe-235d58cd927d", "id" : "5606aab5-2dc2-4498-8144-dc848d099af5", "resource_az" : "br-iaas-odin1a", "image_type" : "backup", "resource_id" : "54f7ccbc-072f-4ec5-a7b7-b24dabdb4539", "resource_size" : 40, "children" : [ ], "extend_info" : { "auto_trigger" : true, "snapshot_id" : "e3def9a8-e4b4-4c12-b132-f4ba8ce9a34f", "bootable" : true, "support_lld" : true, "encrypted" : false, "system_disk" : false }, "project_id" : "0605767b5780d5762fc5c0118072a564", "status" : "available", "resource_name" : "qsy_000", "description" : "", "expired_at" : "2020-03-22T07:00:34.877896", "name" : "autobk_6809", "created_at" : "2020-02-21T07:00:34.882174", "resource_type" : "OS::Cinder::Volume" } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
Códigos de error
Consulte Códigos de error.