Consulta de detalles sobre todas las instantáneas
Función
Esta API se utiliza para consultar detalles sobre todas las instantáneas. Las instantáneas estándares solo se admiten en algunas regiones. Puede consultar las regiones admitidas en la consola.
Método de invocación
Para obtener más información, consulte Invocación de las API.
URI
GET /v5/{project_id}/snapshots/detail
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| project_id | Sí | String | Definición El ID del proyecto. Para obtener más información, consulte Obtención de un ID de proyecto. Restricciones N/D Rango N/D Valor predeterminado N/D |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| marker | No | String | Definición El ID del recurso desde el cual comienza la consulta de paginación. Es el ID del último recurso de la página anterior. Restricciones N/D Rango N/D Valor predeterminado N/D |
| volume_id | No | String | Definición El ID del disco de origen de la instantánea. Puede invocar la API Consulta de detalles sobre todos los discos de EVS para obtener el ID del disco. Restricciones N/D Rango N/D Valor predeterminado N/D |
| availability_zone | No | String | Definición La AZ del disco de origen de la instantánea. Restricciones N/D Rango N/D Valor predeterminado N/D |
| limit | No | String | Definición Cantidad máxima de resultados de consultas que se pueden devolver. 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. Ejemplos: 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 Restricciones N/D Rango El valor oscila entre 1 y 1000, y el valor predeterminado es 1000. El valor devuelto no puede exceder este límite. Valor predeterminado N/D |
| name | No | String | Definición El nombre de la instantánea. Restricciones N/D Rango Puede contener un máximo de 255 caracteres. Valor predeterminado N/D |
| offset | No | String | Definición El desplazamiento. Este parámetro se utiliza junto con el parámetro limit para consultar instantáneas por página. Supongamos que hay 30 instantáneas. Si establece offset en 11 y limit en 10, la consulta comienza desde la duodécima instantánea. Se pueden consultar hasta 10 instantáneas a la vez. Restricciones Debe usarse junto con limit. Rango N/D Valor predeterminado N/D |
| status | No | String | Definición El estado de la instantánea. Restricciones N/D Rango Para obtener más información, consulte Estado de la instantánea de EVS. Valor predeterminado N/D |
| sort_key | No | String | Definición La palabra clave en función de la cual se ordenan los resultados devueltos. Restricciones N/D Rango
-Tamaño: El tamaño de la instantánea, en GiB. Valor predeterminado created_at |
| sort_dir | No | String | Definición El orden de clasificación del resultado. El valor predeterminado es desc. Restricciones N/D Rango Valor predeterminado desc |
| id | No | String | Definición El ID de la instantánea. Restricciones N/D Rango N/D Valor predeterminado N/D |
| ids | No | String | Definición Los ID de instantáneas, que se separan con comas (,). El valor está en formato ids=id1,id2,...,idx. Solo se devuelve la información de instantáneas correspondiente a los ID válidos. Los ID no válidos se ignorarán. Restricciones Se pueden especificar hasta 60 ID a la vez. Si se especifican tanto id como ids en la solicitud, id se ignorará. Rango N/D Valor predeterminado N/D |
| snapshot_type | No | String | Definición El origen de creación de la instantánea. Restricciones N/D Rango N/D Valor predeterminado N/D |
| enterprise_project_id | No | String | Definición El ID del proyecto empresarial al que pertenece la instantánea. Para obtener más información sobre los proyectos empresariales y cómo obtener los ID de proyecto empresariales, consulte Guía del usuario de Enterprise Management. Restricciones N/D Rango N/D Valor predeterminado N/D |
| tag_key | No | String | Definición La clave de etiqueta de instantánea. Restricciones N/D Rango N/D Valor predeterminado N/D |
| tags | No | String | Definición Los pares clave-valor de las etiquetas de instantáneas, por ejemplo, [{"key":"bbb","value":"bbb"}]. Restricciones N/D Rango N/D Valor predeterminado N/D |
| snapshot_chain_id | No | String | Definición El ID de la cadena de instantáneas. Restricciones N/D Rango N/D Valor predeterminado N/A |
| snapshot_group_id | No | String | Definición El ID del grupo de consistencia de instantáneas. Restricciones N/D Rango N/D Valor predeterminado N/D |
Parámetros de solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| X-Auth-Token | Sí | String | Definición El token del usuario. Se puede obtener invocando 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. Restricciones N/D Rango N/D Valor predeterminado N/D |
Parámetros de respuesta
Código de estado: 200
| Parámetro | Tipo | Descripción |
|---|---|---|
| snapshots | Array of SnapshotDetailV5 objects | Definición La información de la instantánea. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | Definición El ID de la instantánea. Rango N/D |
| name | String | Definición El nombre de la instantánea. El sistema crea automáticamente las instantáneas cuyos nombres comienzan con el prefijo autobk_snapshot_ durante la creación de copia de respaldo. Estas instantáneas no se pueden eliminar ni utilizar para revertir los datos. Rango N/D |
| description | String | Definición Descripción de la instantánea. Rango N/D |
| created_at | String | Definición Hora en que se creó la instantánea. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX Rango N/D |
| updated_at | String | Definición Hora en que se actualizó la instantánea. Rango N/D |
| volume_id | String | Definición El ID del disco de origen de la instantánea. Rango N/D |
| size | String | Definición Tamaño de la instantánea, en GiB. Rango N/D |
| status | String | Definición El estado de la instantánea. Rango Para obtener más información, consulte Estado de la instantánea de EVS. |
| project_id | String | Definición El ID del proyecto. Rango N/D |
| enterprise_project_id | String | Definición El ID del proyecto empresarial al que pertenece la instantánea. Rango N/D |
| encrypted | Boolean | Definición Si la instantánea está encriptada. Rango N/D |
| cmk_id | String | Definición El ID de la clave de encriptación utilizada por el disco de origen de la instantánea. Rango N/D |
| category | String | Definición El tipo de instantánea. Rango standard o flash |
| availability_zone | String | Definición La AZ a la que pertenece la instantánea. Rango N/D |
| tags | Map<String,String> | Definición Las etiquetas de la instantánea. Rango N/D |
| instant_access | Boolean | Definición Si la restauración instantánea de instantáneas está habilitada. Rango true: habilitada. Solo los discos respaldados por SSD admiten esta función. false: deshabilitada. Las instantáneas con la restauración instantánea de instantáneas deshabilitada son instantáneas estándar. |
| retention_at | String | Definición La duración de la retención de instantáneas. Rango N/D |
| instant_access_retention_at | String | Definición La duración de la retención de la restauración instantánea de instantáneas. Una vez finalizada la duración de la retención, la restauración instantánea de instantáneas se deshabilita automáticamente para las instantáneas. Rango De forma predeterminada, el valor de este parámetro es el mismo que el de retention_at. |
| incremental | Boolean | Definición Si la instantánea es una instantánea incremental. Rango true o false |
| snapshot_type | String | Definición El origen de creación de la instantánea. Rango auto: creado automáticamente user: creado manualmente copy: replicado |
| progress | String | Definición El progreso de la creación de la instantánea, en porcentaje. Rango N/D |
| encrypt_algorithm | String | Definición El algoritmo de encriptación de instantáneas. Rango N/D |
| snapshot_chains | Array of SnapshotChains objects | Definición La cadena de instantáneas a la que pertenece la instantánea. Rango N/D |
| snapshot_group_id | String | Definición El ID del grupo de coherencia de instantáneas al que pertenece la instantánea. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | Definición El ID de la cadena de instantáneas. Rango N/D |
| availability_zone | String | Definición La AZ del disco al que pertenece la cadena de instantáneas. Rango N/D |
| snapshot_count | Integer | Definición La cantidad de instantáneas de la cadena de instantáneas. Rango ≥ 0 |
| capacity | Integer | Definición El uso del almacenamiento de la cadena de instantáneas. Rango El valor es mayor o igual que 0. |
| project_id | String | Definición El ID del proyecto. Rango N/D |
| volume_id | String | Definición El ID del disco al que pertenece la cadena de instantáneas. Rango N/D |
| category | String | Definición El tipo de cadena de instantáneas. Rango El valor puede ser standard o standard_copy. |
| created_at | String | Definición La fecha y hora de creación. Rango N/D |
| updated_at | String | Definición La fecha y hora de actualización. Rango N/D |
Código de estado: 400
| Parámetro | Tipo | Descripción |
|---|---|---|
| error | Error object | Definición La información de error devuelta si se produce un error. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| code | String | Definición El código de error devuelto si se produce un error. Rango Para obtener más información sobre el código de error, consulte Códigos de error. |
| message | String | Definición El mensaje de error devuelto si se produce un error. Rango N/D |
Ejemplo de solicitudes
GET https://{endpoint}/v5/{project_id}/snapshots/detail Ejemplo de respuestas
Código de estado: 200
OK
{
"snapshots" : [ {
"status" : "available",
"description" : null,
"created_at" : "2013-06-19T07:15:29.000000",
"volume_id" : "ae11e59c-bd56-434a-a00c-04757e1c066d",
"size" : 5,
"id" : "6cd26877-3ca3-4f4e-ae2a-38cc3d6183fa",
"name" : "name_xx2-snap",
"updated_at" : null,
"category" : "flash",
"enterprise_project_id" : "0",
"encrypted" : false,
"availability_zone" : "az1.dc1",
"tags" : { }
}, {
"status" : "available",
"description" : null,
"created_at" : "2013-06-19T09:08:08.000000",
"volume_id" : "ae11e59c-bd56-434a-a00c-04757e1c066d",
"size" : 5,
"id" : "b3253e26-5c37-48dd-8bf2-8795dd1e848f",
"name" : "name_xx2-snap",
"updated_at" : null,
"category" : "flash",
"enterprise_project_id" : "0",
"encrypted" : false,
"availability_zone" : "az1.dc1",
"tags" : { }
} ]
} Código de estado: 400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "EVS.XXX"
}
} Códigos de estado
| Código de estado | Descripción |
|---|---|
| 200 | OK |
| 400 | Bad Request |
Códigos de error
Consulte Códigos de error.