Consulta de detalles acerca de instantáneas de EVS
Función
Esta API se utiliza para consultar detalles sobre las instantáneas de EVS.
URI
- Formato URI
- Descripción del parámetro
Parámetro
Obligatorio
Descripción
project_id
Sí
Especifica el ID del proyecto.
Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.
- Parámetros de filtro de solicitud
Parámetro
Tipo
Obligatorio
Descripción
marker
String
No
offset
Integer
No
Especifica el desfase.
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 el offset en 11 y el limit en 10, la instantánea consultada comienza a partir de la duodécima instantánea y, como máximo, se pueden consultar 10 instantáneas a la vez.
limit
Integer
No
Especifica el número máximo de resultados de consulta que se pueden devolver.
Si el inquilino 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:
GET /v2/xxx/snapshots/detail?limit=50: Consulta las instantáneas 1–50. GET /v2/xxx/snapshots/detail?offset=50&limit=50: Consulta las 51–100 instantáneas.
name
String
No
Especifica el nombre de la instantánea. El valor puede contener un máximo de 255 bytes.
status
String
No
Especifica el estado de la instantánea. Para más detalles, consulte Estado de instantánea de EVS.
volume_id
String
No
Especifica el ID del disco de origen de la instantánea.
Solicitud
En el ejemplo siguiente se muestra cómo consultar los detalles de las instantáneas en el estado available.
- Solicitud de ejemplo
GET https://{endpoint}/v2/{project_id}/snapshots/detail?status=available
Respuesta
- Descripción del parámetro
Parámetro
Tipo
Descripción
snapshots
Object
Especifica la información de la instantánea. Para obtener más información, consulte Parámetros en el campo de instantáneas.
snapshots_links
list<map<String,String>>
Especifica el marcador de posición de la consulta en la lista de instantáneas. Este parámetro está en el mismo nivel que parámetro snapshots en el cuerpo de la respuesta. Este parámetro se devuelve solo cuando se especifica parámetro limit en la solicitud, y este parámetro indica que solo se devuelven algunas instantáneas en esta consulta.
error
Object
Especifica el mensaje de error devuelto cuando se produce un error. Para obtener más información, consulte Parámetros en el campo de error.
- Parámetros en el campo de snapshots
Parámetro
Tipo
Descripción
id
String
Especifica el ID de la instantánea.
status
String
Especifica el estado de la instantánea. Para más detalles, consulte Estado de instantánea de EVS.
name
String
Especifica el nombre de la instantánea.
description
String
Especifica la descripción de la instantánea.
created_at
String
Especifica la hora a la que se creó la instantánea.
updated_at
String
Especifica la hora a la que se actualizó la instantánea.
metadata
Object
Especifica los metadatos de la instantánea.
Si metadata contienen el campo __system__enableActive, la instantánea se crea automáticamente durante la copia de respaldo de un servidor.
volume_id
String
Especifica el ID del disco de origen de la instantánea.
size
Integer
Especifica el tamaño de la instantánea, en GB.
os-extended-snapshot-attributes:project_id
String
Especifica el ID del inquilino.
os-extended-snapshot-attributes:progress
String
- Parámetros en el campo de error
Parámetro
Tipo
Descripción
message
String
Especifica el mensaje de error devuelto cuando se produce un error.
code
String
Especifica el código de error devuelto cuando se produce un error.
Para obtener más información sobre el código de error, consulte Códigos de error.
- Ejemplo de respuesta
{ "snapshots": [ { "status": "available", "os-extended-snapshot-attributes:progress": "100%", "description": null, "created_at": "2013-06-19T07:15:29.000000", "metadata": { }, "volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d", "os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561", "size": 5, "id": "6cd26877-3ca3-4f4e-ae2a-38cc3d6183fa", "name": "name_xx2-snap", "updated_at": null }, { "status": "available", "os-extended-snapshot-attributes:progress": "100%", "description": null, "created_at": "2013-06-19T09:08:08.000000", "metadata": { }, "volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d", "os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561", "size": 5, "id": "b3253e26-5c37-48dd-8bf2-8795dd1e848f", "name": "name_xx2-snap", "updated_at": null } ] }
o
{ "error": { "message": "XXXX", "code": "XXX" } }
En el ejemplo anterior, error indica un error general, por ejemplo, badRequest o itemNotFound. Un ejemplo es el siguiente:
{ "itemNotFound": { "message": "XXXX", "code": "XXX" } }
Códigos de error
Para más detalles, consulte Códigos de error.