Consulta de detalles sobre todos los discos de EVS (obsoletos)
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 a las API.
URI
GET /v3/{project_id}/os-vendor-volumes/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 |
---|---|---|---|
availability_zone |
No |
String |
La AZ a la que pertenece el disco. |
dedicated_storage_id |
No |
String |
El ID del grupo de almacenamiento dedicado. Todos los discos del grupo de almacenamiento dedicado se pueden filtrar por la coincidencia exacta. |
dedicated_storage_name |
No |
String |
El nombre del grupo de almacenamiento dedicado. Todos los discos del grupo de almacenamiento dedicado se pueden filtrar por coincidencia difusa. |
id |
No |
String |
El ID del disco. |
ids |
No |
Array |
Los ID del disco. El valor está en formato ids=['id1','id2',...,'idx']. En la respuesta, el valor ids solo contiene los ID de disco válidos. Se ignoran los ID de disco no válidos. Se pueden consultar los detalles sobre un máximo de 60 discos. Si se especifican tanto id como ids en la solicitud, se omitirá id. |
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. |
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. |
metadata |
No |
String |
Los metadatos del disco. |
multiattach |
No |
String |
Si el disco se puede compartir. true: el disco se puede compartir. false: el disco no se puede compartir. |
name |
No |
String |
El nombre del disco. Puede escribir hasta 64 caracteres. |
offset |
No |
Integer |
El desplazamiento de la consulta. Se consultan todos los discos después de este desplazamiento. El valor debe ser un entero mayor que 0 pero menor que el número de discos. |
service_type |
No |
String |
El tipo de servicio. EVS, DSS y DESS son servicios soportados. |
sort_dir |
No |
String |
El orden de clasificación del resultado. El valor predeterminado es desc. desc: orden descendente asc: orden ascendente |
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. |
status |
No |
String |
El estado del disco. Para obtener más detalles, consulte Estado del disco de EVS. |
volume_type_id |
No |
String |
El ID de tipo de disco. Para obtener más detalles, vaya a Consulta de tipos de disco de EVS y compruebe el valor de id en la tabla para los parámetros en el campo volume_types. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Un token obtenido de IAM tiene una validez de 24 horas. Cuando utilice un token para autenticación, guarde un caché para evitar invocar con frecuencia a la API. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
count |
Integer |
El número total de discos consultados. |
volumes |
Array of VolumeDetailV3 objects |
La lista de discos devueltos. |
volumes_links |
Array of LinkV3 objects |
El marcador de posición de la consulta en la lista de discos. Si solo se devuelven algunos discos en esta consulta, se devuelve la dirección URL del último disco consultado. Puede utilizar esta dirección URL para consultar los discos restantes en la siguiente consulta. Para obtener más detalles, consulte Parámetros en el campo links. |
Parámetro |
Tipo |
Descripción |
---|---|---|
attachments |
Array of AttachmentV3 objects |
La información de conexión de disco. Para más detalles, consulte |
availability_zone |
String |
La AZ a la que pertenece el disco. |
bootable |
String |
Si el disco es arrancable. true: el disco es arrancable. false: el disco no se puede arrancar. |
consistencygroup_id |
String |
El campo reservado. |
created_at |
String |
La hora en que se creó el disco. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
dedicated_storage_id |
String |
El ID del grupo de almacenamiento dedicado que aloja el disco. |
dedicated_storage_name |
String |
El nombre del grupo de almacenamiento dedicado que aloja el disco. |
description |
String |
La descripción del disco. |
encrypted |
Boolean |
Este campo no se admite actualmente. |
enterprise_project_id |
String |
El ID del proyecto de empresa al que se ha agregado el disco. For more information about enterprise projects and how to obtain enterprise project IDs, see |
id |
String |
El ID del disco. |
links |
Array of LinkV3 objects |
El URI del disco. Para más detalles, consulte |
metadata |
VolumeMetadataV3 object |
Los metadatos. |
multiattach |
Boolean |
Si el disco se puede compartir. true: el disco se puede compartir. false: el disco no se puede compartir. |
name |
String |
El nombre del disco. |
replication_status |
String |
El campo reservado. |
service_type |
String |
El tipo de servicio. EVS, DSS y DESS son servicios soportados. |
shareable |
Boolean |
Si el disco se puede compartir.
NOTA:
Este campo ha sido obsoleto. Use multiattach. |
size |
Integer |
El tamaño del disco, en GiB. |
snapshot_id |
String |
El ID de la instantánea. Este parámetro tiene un valor si el disco se crea a partir de una instantánea. |
source_volid |
String |
ID del disco de origen. Este parámetro tiene un valor si el disco se crea a partir de un disco de origen. Este campo no se admite actualmente. |
status |
String |
El estado del disco. |
tags |
Map<String,String> |
Las etiquetas de disco. Este campo tiene valores si el disco tiene etiquetas. O, se deja vacío. |
updated_at |
String |
La hora en que se actualizó el disco. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
user_id |
String |
El campo reservado. |
volume_image_metadata |
Object |
Los metadatos de la imagen de disco.
NOTA:
Para obtener más detalles sobre el campo volume_image_metadata, véase Consulta de detalles de imagen (API nativa de OpenStack). |
volume_type |
String |
El tipo de disco. El valor puede ser SATA, SAS, GPSSD o SSD.
|
wwn |
String |
El identificador único utilizado al conectar el disco. |
os-vol-tenant-attr:tenant_id |
String |
El ID del tenant al que pertenece el disco. El ID del tenant es el mismo que el ID del proyecto. |
os-vol-mig-status-attr:migstat |
String |
El campo reservado. |
os-vol-mig-status-attr:name_id |
String |
El campo reservado. |
os-volume-replication:extended_status |
String |
El campo reservado. |
os-vol-host-attr:host |
String |
El campo reservado. |
storage_cluster_id |
String |
El campo reservado. |
Parámetro |
Tipo |
Descripción |
---|---|---|
attached_at |
String |
La hora a la que se ha conectado el disco. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
attachment_id |
String |
El ID del archivo adjunto. |
device |
String |
El nombre del dispositivo. |
host_name |
String |
El nombre del host físico que alberga el servidor en la nube al que está conectado el disco. |
id |
String |
El ID del disco conectado. |
server_id |
String |
El ID del servidor al que está conectado el disco. |
volume_id |
String |
El ID del disco. |
Parámetro |
Tipo |
Descripción |
---|---|---|
__system__cmkid |
String |
El ID de CMK de encriptación de metadata. Este parámetro se utiliza junto con __system__encrypted para la encriptación. La longitud de cmkid se fija en 36 bytes. |
__system__encrypted |
String |
El campo de encriptación de metadata. 0: sin encriptación 1: encriptación Si este parámetro no aparece, el disco no está encriptado. |
full_clone |
String |
El método de creación cuando el disco se crea a partir de una instantánea.
|
hw:passthrough |
String |
El parámetro que describe el tipo de dispositivo de disco de metadata.
|
orderID |
String |
El parámetro que describe el modo de facturación de disco de metadata. Si este parámetro tiene un valor, el disco se factura anualmente/mensualmente. Si no es así, el disco se factura sobre una base de pago por uso. |
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 |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
El mensaje de error devuelto si se produce un error. Para obtener más detalles, consulte Parámetros en el campo error. |
Parámetro |
Tipo |
Descripción |
---|---|---|
code |
String |
El código de error devuelto si se produce un error. Para conocer los códigos de error y sus significados, véase 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}/os-vendor-volumes/detail
Example Responses
Código de estado: 200
Aceptar
{ "count" : 1, "volumes" : [ { "attachments" : [ ], "availability_zone" : "xxx", "bootable" : "false", "created_at" : "2016-05-25T02:42:10.856332", "encrypted" : false, "id" : "b104b8db-170d-441b-897a-3c8ba9c5a214", "links" : [ { "href" : "https://volume.localdomain.com:8776/v3/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" : { "__openstack_region_name" : "pod01.xxx", "quantityGB" : "1", "volInfoUrl" : "fusionstorage://172.30.64.10/0/FEFEEB07D3924CDEA93C612D4E16882D" }, "name" : "zjb_u25_test", "os-vol-host-attr:host" : "pod01.xxx#SATA", "volume_image_metadata" : { }, "os-vol-tenant-attr:tenant_id" : "dd14c6ac581f40059e27f5320b60bf2f", "replication_status" : "disabled", "multiattach" : false, "size" : 1, "status" : "available", "updated_at" : "2016-05-25T02:42:22.341984", "user_id" : "b0524e8342084ef5b74f158f78fc3049", "volume_type" : "SATA", "service_type" : "EVS", "wwn" : " 688860300000d136fa16f48f05992360" } ], "volumes_links" : [ { "href" : "https://volume.localdomain.com:8776/v3/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214", "rel" : "next" } ] }
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.