Consulta de detalles sobre instantáneas de EVS
Función
Esta API se utiliza para consultar detalles sobre instantáneas de EVS.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /v3/{project_id}/snapshots/detail
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. |
volume_id | No | String | El ID del disco de origen de la instantánea. |
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/detail?limit=50; Consulta de 51 a 100 instantáneas: GET /v2/xxx/snapshots/detail?offset=50&limit=50 |
name | No | String | El nombre de la instantánea. Puede introducir hasta 255 caracteres. |
offset | No | Integer | El desplazamiento. NOTA: Nota: Este parámetro se utiliza cuando se consultan instantáneas 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. |
status | No | String | El estado de la instantánea. Para obtener más detalles, consulte Estado de la instantánea de EVS. |
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 SnapshotDetail 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 |
|---|---|---|
id | String | El ID de la instantánea. |
name | String | El nombre de la instantánea. Las instantáneas cuyos nombres comienzan con el prefijo autobk_snapshot_ son creadas automáticamente por el sistema cuando se crean copias de respaldo. Estas instantáneas no se pueden eliminar ni utilizar para revertir datos. |
description | String | La descripción de la instantánea. |
created_at | String | La hora en que se creó la instantánea. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
updated_at | String | La hora en que se actualizó la instantánea. |
metadata | Map<String,String> | Los metadatos de la instantánea. |
volume_id | String | El ID del disco de origen de la instantánea. |
size | String | 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. |
os-extended-snapshot-attributes:progress | String | El campo reservado. |
os-extended-snapshot-attributes:project_id | String | El ID de tenant. El ID del tenant es el mismo que el ID del proyecto. |
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}/v3/{project_id}/snapshots/detail?status=available Ejemplo de respuestas
Código de estado: 200
Aceptar
{
"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,
}
]
} 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.
