Consulta de instantáneas de EVS
Función
Consulta de instantáneas de EVS
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /v2/{project_id}/snapshots
Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
project_id | Sí | String | El ID del proyecto. Para obtener más información sobre cómo obtener el ID de proyecto, consulte Obtención de un ID de proyecto. |
Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
marker | No | String | El ID del recurso desde el que se inicia la consulta de paginación. Es el ID del último recurso de la página anterior. |
offset | No | Integer | El desplazamiento. NOTA: Este parámetro se utiliza cuando las instantáneas se consultan por página y se utiliza junto con el parámetro limit. Por ejemplo, hay un total de 30 instantáneas. Si establece offset en 11 y limit en 10, la consulta comienza en la duodécima instantánea y se puede consultar un máximo de 10 instantáneas a la vez. |
limit | No | Integer | El número máximo de resultados de consulta que se pueden devolver. El valor oscila entre 1 y 1000 y el valor predeterminado es 1000. El valor devuelto no puede exceder este límite. Si el tenant tiene más de 50 instantáneas en total, se recomienda utilizar este parámetro y establecer su valor en 50 para mejorar la eficiencia de la consulta. Los ejemplos se proporcionan como sigue: Consulta de 1 a 50 instantáneas: GET /v2/xxx/snapshots?limit=50; consulta de 51 a 100 instantáneas: GET /v2/xxx/snapshots?offset=50&limit=50 |
name | No | String | El nombre de la instantánea. Este parámetro no admite coincidencias difusas. Puede introducir hasta 255 caracteres. |
status | No | String | El estado de la instantánea. Para obtener más detalles, consulte Estado de la instantánea de EVS. |
volume_id | No | String | El ID del disco de origen de la instantánea. |
Parámetros de solicitud
Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
X-Auth-Token | Sí | String | El token del usuario. Se puede obtener invocando 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 |
|---|---|---|
snapshots_links | Array of Link objects | El marcador de posición de la consulta en la lista de instantáneas. Este campo solo se devuelve cuando se especifica limit en la solicitud e indica que solo se devuelven algunas instantáneas en esta consulta. |
snapshots | Array of SnapshotSummary objects | La información de la instantánea. |
Parámetro | Tipo | Descripción |
|---|---|---|
href | String | El enlace de acceso directo correspondiente. |
rel | String | El nombre del marcador de enlace de acceso directo. Valor predeterminado: next |
Parámetro | Tipo | Descripción |
|---|---|---|
created_at | String | La hora en que se creó la instantánea. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
description | String | La descripción de la instantánea. |
id | String | El ID de la instantánea. |
metadata | Map<String,String> | Los metadatos de la instantánea. Si metadata contiene el campo __system__enableActive, la instantánea se genera automáticamente durante una copia de respaldo del servidor. |
name | String | El nombre de la instantánea. |
size | Integer | Tamaño de la instantánea, en GiB. |
status | String | El estado de la instantánea. Para obtener más detalles, consulte Estado de la instantánea de EVS. |
updated_at | String | La hora en que se actualizó la instantánea. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
volume_id | String | El ID del disco de origen de la instantánea. |
Código de estado: 400
Parámetro | Tipo | Descripción |
|---|---|---|
error | Error object | El mensaje de error devuelto si se produce un error. |
Parámetro | Tipo | Descripción |
|---|---|---|
code | String | El código de error devuelto si se produce un error. Para obtener más detalles sobre los códigos de error y sus significados, consulte Códigos de error. |
message | String | El mensaje de error devuelto si se produce un error. |
Ejemplo de solicitudes
GET https://{endpoint}/v2/{project_id}/snapshots Ejemplo de respuestas
Código de estado: 200
Aceptar
{
"snapshots" : [ {
"created_at" : "2016-02-16T16:54:14.981520",
"description" : null,
"id" : "b836dc3d-4e10-4ea4-a34c-8f6b0460a583",
"metadata" : { },
"name" : "test01",
"size" : 1,
"status" : "available",
"volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
"updated_at" : null
}, {
"created_at" : "2016-02-16T16:54:19.475397",
"description" : null,
"id" : "83be494d-329e-4a78-8ac5-9af900f48b95",
"metadata" : { },
"name" : "test02",
"size" : 1,
"status" : "available",
"volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
"updated_at" : null
}, {
"created_at" : "2016-02-16T16:54:24.367414",
"description" : null,
"id" : "dd360f46-7593-4d35-8f2c-5566fd0bd79e",
"metadata" : { },
"name" : "test03",
"size" : 1,
"status" : "available",
"volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
"updated_at" : null
}, {
"created_at" : "2016-02-16T16:54:29.766740",
"description" : null,
"id" : "4c29796a-8cf4-4482-9afc-e66da9a81240",
"metadata" : { },
"name" : "test04",
"size" : 1,
"status" : "available",
"volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
"updated_at" : null
} ],
"snapshots_links" : null
} Código de estado: 400
Error en la solicitud
{
"error" : {
"message" : "XXXX",
"code" : "XXX"
}
} Códigos de estado
Código de estado | Descripción |
|---|---|
200 | Aceptar |
400 | Error en la solicitud |
Códigos de error
Consulte Códigos de error.
