Consulta de detalles sobre todos los discos de EVS
Función
Esta API se utiliza para consultar detalles sobre todos los discos de EVS.
Método de invocación
Para obtener más información, consulte Invocación de las API.
URI
GET /v3/{project_id}/volumes/detail
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| project_id | Sí | String | El ID del proyecto. Para obtener más información, consulte Obtención de un ID de proyecto. |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| marker | No | String | El ID del último registro de la página anterior. El valor devuelto es el valor del elemento después de este. |
| name | No | String | El nombre del disco. Puede ingresar hasta 64 caracteres. |
| limit | No | Integer | Cantidad máxima de resultados de consultas 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 tiene más de 50 discos en total, utilice este parámetro y configúrelo en 50 para mejorar la eficiencia de la consulta. A continuación se proporcionan ejemplos: Consulta de 1 a 50 discos: GET /v2/xxx/volumes/detail?limit=50 Consulta de 51 a 100 discos: GET /v2/xxx/volumes/detail?offset=50&limit=50 |
| sort_key | No | String | La palabra clave en función de la cual se ordenan los resultados devueltos. El valor puede ser id, status, size, o created_at, y el valor predeterminado es created_at. |
| sort_dir | No | String | El orden de clasificación de resultados. El valor predeterminado es desc. desc: el orden descendente asc: el orden ascendente |
| offset | No | Integer | El desplazamiento de la consulta. Se consultarán todos los discos después de este desplazamiento. El valor debe ser un número entero mayor que 0 pero menor que el número de discos. |
| status | No | String | El estado del disco. Para obtener más información, consulte Estado del disco de EVS. |
| metadata | No | String | Los metadatos del disco. Este parámetro se transfiere en formato de JSON, por ejemplo, GET /v3/{project_id}/volumes/detail?metadata={"hw:passthrough": "true"}. |
| availability_zone | No | String | La información de AZ. |
Parámetros de solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| X-Auth-Token | Sí | String | El token de 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. |
Parámetros de respuesta
Código de estado: 200
| Parámetro | Tipo | Descripción |
|---|---|---|
| volumes | Array of VolumeDetail objects | Definición La lista de discos devueltos. Rango N/D |
| volumes_links | Array of Link objects | Definición El marcador de posición de consulta en la lista de discos. Si solo se devuelven algunos discos en esta consulta, se devuelve la URL del último disco consultado. Puede utilizar esta URL para continuar consultando los discos restantes en la siguiente consulta. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | Definición El ID del disco. Rango N/D |
| links | Array of Link objects | Definición El URI del disco. Rango N/D |
| name | String | Definición El nombre del disco. Rango N/D |
| status | String | Definición El estado del disco. Para obtener más información, consulte Estado del disco de EVS. Rango N/D |
| attachments | Array of VolumeAttachment objects | Definición Si el disco está conectado. Rango N/D |
| availability_zone | String | Definición La AZ a la que pertenece el disco. Rango N/D |
| disaster_recovery_azs | Array of strings | Definición Las AZ a las que pertenece el disco de DR. Rango N/D |
| source_volid | String | Definición El ID del disco de origen. Este parámetro tiene un valor si el disco se crea a partir de un disco de origen. Actualmente, este campo no se admite. Rango N/D |
| snapshot_id | String | Definición El ID de la instantánea. Este parámetro tiene un valor si el disco se crea a partir de una instantánea. Rango N/D |
| description | String | Definición La descripción del disco. Rango N/D |
| bootable | String | Definición Si el disco es arrancable. Rango
|
| encrypted | Boolean | Definición Actualmente, este campo no se admite. Rango N/D |
| created_at | String | Definición La hora en que se creó el disco. Rango Formato de tiempo: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
| volume_type | String | Definición El tipo de disco. Rango El valor puede ser SATA, SAS, GPSSD, SSD, ESSD, GPSSD2 o ESSD2.
|
| replication_status | String | Definición El campo reservado. Rango N/D |
| consistencygroup_id | String | Definición El campo reservado. Rango N/D |
| metadata | VolumeMetadata object | Definición Los metadatos del disco. Si metadata no contienen el campo hw:passthrough, el tipo de dispositivo de disco es VBD. Si metadata no contiene el campo __system__encrypted, el disco no está encriptado. Rango N/D |
| size | Integer | Definición La capacidad del disco, en GiB. Rango N/D |
| user_id | String | Definición El campo reservado. Rango N/D |
| updated_at | String | Definición La hora en que se actualizó el disco. Rango Formato de tiempo: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
| shareable | Boolean | Definición Si el disco es compartible. Nota: Este campo ha sido obsoleto. Utilice multiattach. Rango N/D |
| multiattach | Boolean | Definición Si el disco es compartible. Rango
|
| os-vol-tenant-attr:tenant_id | String | Definición El ID del proyecto al que pertenece el disco. Rango N/D |
| volume_image_metadata | Object | Definición Los metadatos de la imagen del disco. Rango Para obtener más información sobre el campo volume_image_metadata, consulte Consulta de detalles de imágenes (API nativa de OpenStack V2, obsoleta). |
| os-vol-host-attr:host | String | Definición El campo reservado. Rango N/D |
| os-volume-replication:extended_status | String | Definición El campo reservado. Rango N/D |
| os-vol-mig-status-attr:migstat | String | Definición El campo reservado. Rango N/D |
| os-vol-mig-status-attr:name_id | String | Definición El campo reservado. Rango N/D |
| iops | iops object | Definición La información de IOPS del disco. Este parámetro se devuelve solo para un disco de SSD V2 de propósito general o un disco de SSD V2 de capacidad extrema. Rango N/D |
| throughput | throughput object | Definición La información del throughput del disco. Este parámetro se devuelve solo para un disco de SSD V2 de uso general. Rango N/D |
| snapshot_policy_id | String | Definición El ID de la política de instantáneas aplicada al disco. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| attached_at | String | Definición La hora en que se conectó el disco. Rango Formato de tiempo: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
| attachment_id | String | Definición El ID del adjunto. Rango N/D |
| device | String | Definición El nombre del dispositivo. Rango N/D |
| host_name | String | Definición El nombre del host físico que aloja el servidor en la nube al que está conectado el disco. Rango N/D |
| id | String | Definición El ID del recurso conectado. Rango N/D |
| server_id | String | Definición El ID del servidor al que está conectado el disco. Rango N/D |
| volume_id | String | Definición El ID del disco. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| __system__cmkid | String | Definición El ID del CMK de encriptación en metadata. Este parámetro se utiliza junto con __system__encrypted para la encriptación. La longitud de cmkid se fija en 36 bytes. Rango Utilice una solicitud HTTPS para obtener el ID de clave. Para obtener más información, consulte Consulta de la lista de claves. |
| __system__encrypted | String | Definición El campo de encriptación en metadata. Si este parámetro no aparece, el disco no está encriptado. Rango
|
| hw:passthrough | String | Definición El parámetro que describe el tipo de dispositivo de disco en metadata. Si este parámetro no aparece, el tipo de dispositivo de disco es VBD. Rango
|
| Parámetro | Tipo | Descripción |
|---|---|---|
| frozened | Boolean | Definición La etiqueta congelada. Rango N/D |
| id | String | Definición El identificador de las IOPS del disco. Rango N/D |
| total_val | Integer | Definición El tamaño de las IOPS. Rango N/D |
| volume_id | String | Definición El ID del disco. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| frozened | Boolean | Definición La etiqueta congelada. Rango N/D |
| id | String | Definición El identificador de throughput. Rango N/D |
| total_val | Integer | Definición El tamaño del throughput. Rango N/D |
| volume_id | String | Definición El ID del disco. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| href | String | Definición El enlace de acceso directo correspondiente. Rango N/D |
| rel | String | Definición El nombre del marcador del enlace de acceso directo. 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 |
Ejemplos de solicitudes
GET https://{endpoint}/v3/{project_id}/volumes/detail?status=available Ejemplos de respuestas
Código de estado: 200
OK
{
"volumes" : [ {
"attachments" : [ ],
"availability_zone" : "az-dc-1",
"bootable" : "false",
"consistencygroup_id" : null,
"created_at" : "2016-05-25T02:42:10.856332",
"description" : null,
"encrypted" : false,
"id" : "b104b8db-170d-441b-897a-3c8ba9c5a214",
"links" : [ {
"href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
"rel" : "self"
}, {
"href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
"rel" : "bookmark"
} ],
"metadata" : { },
"name" : "zjb_u25_test",
"os-vol-host-attr:host" : "pod01.xxx#SATA",
"volume_image_metadata" : { },
"os-vol-mig-status-attr:migstat" : null,
"os-vol-mig-status-attr:name_id" : null,
"os-vol-tenant-attr:tenant_id" : "dd14c6ac581f40059e27f5320b60bf2f",
"os-volume-replication:extended_status" : null,
"replication_status" : "disabled",
"multiattach" : false,
"size" : 1,
"snapshot_id" : null,
"source_volid" : null,
"status" : "available",
"updated_at" : "2016-05-25T02:42:22.341984",
"user_id" : "b0524e8342084ef5b74f158f78fc3049",
"volume_type" : "SATA"
} ],
"volumes_links" : [ {
"href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214",
"rel" : "next"
} ]
} Código de estado: 400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "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.