Consulta de detalles sobre un disco de EVS
Función
Esta API se utiliza para consultar detalles sobre un disco de EVS.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /v3/{project_id}/volumes/{volume_id}
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. |
volume_id |
Sí |
String |
El ID del disco. |
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 |
---|---|---|
volume |
CinderVolumeDetail object |
El disco devuelto. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
El ID del disco. |
links |
Array of Link objects |
El URI del disco. |
name |
String |
El nombre del disco. |
status |
String |
El estado del disco. Para obtener más detalles, consulte Estado del disco de EVS. |
attachments |
Array of VolumeAttachment objects |
Si el disco está conectado. |
availability_zone |
String |
La AZ a la que pertenece el disco. |
source_volid |
String |
El 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. |
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. |
description |
String |
La descripción del disco. |
bootable |
String |
Si el disco es arrancable. true: el disco es arrancable. false: el disco no se puede arrancar. |
created_at |
String |
La hora en que se creó el disco. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
volume_type |
String |
El tipo de disco. El valor puede ser SATA, SAS, GPSSD, SSD, ESSD, GPSSD2 o ESSD2.
|
metadata |
VolumeMetadata object |
Los metadatos del disco. Si metadata no contienen el campo hw:passthrough, el tipo de dispositivo de disco es VBD. Si metadata no contienen el campo __system__encrypted, el disco no está cifrado. |
size |
Integer |
El tamaño del disco, en GiB. |
shareable |
Boolean |
Si el disco se puede compartir. Nota: Este campo ha sido obsoleto. Use multiattach. |
multiattach |
Boolean |
Si el disco se puede compartir. |
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. |
volume_image_metadata |
Object |
Los metadatos de la imagen de disco. Para obtener más detalles sobre el campo volume_image_metadata, véase Consulta de detalles de imagen (API nativa de OpenStack). |
os-vol-host-attr:host |
String |
El campo reservado. |
os-volume-replication:extended_status |
String |
El campo reservado. |
consistencygroup_id |
String |
El campo reservado. |
iops |
iops object |
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 extremo. |
throughput |
throughput object |
La información del throughput del disco. Este parámetro se devuelve solo para un disco de SSD V2 de uso general. |
updated_at |
String |
La hora en que se actualizó el disco. |
replication_status |
String |
El campo reservado. |
user_id |
String |
El campo reservado. |
encrypted |
Boolean |
El campo reservado. |
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 |
---|---|---|
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.
NOTA:
Utilice una solicitud de HTTPS para obtener el ID de clave. Para obtener más detalles, consulte Consulta de la lista de claves. |
__system__encrypted |
String |
El campo de encriptación de metadata. El valor puede ser 0 (sin encriptación) o 1 (encriptación). Si este parámetro no aparece, el disco no está cifrado. |
full_clone |
String |
Si el disco se crea a partir de una instantánea y es necesario utilizar la clonación vinculada, establezca este parámetro en 0. |
hw:passthrough |
String |
Si este parámetro se establece en true, el tipo de dispositivo de disco es SCSI, lo que permite que los sistemas operativos de ECS accedan directamente a los medios de almacenamiento subyacentes. Se admiten comandos de reserva SCSI. Si este parámetro se establece en false, el tipo de dispositivo de disco es VBD, que también es el tipo predeterminado. VBD solo admite los comandos simples de lectura/escritura de SCSI. Si este parámetro no está disponible, el tipo de dispositivo de disco es VBD. |
Parámetro |
Tipo |
Descripción |
---|---|---|
frozened |
Boolean |
La etiqueta congelada. Predeterminado: false |
id |
String |
El ID del IOPS del disco. |
total_val |
Integer |
Las IOPS. |
volume_id |
String |
El ID del disco. |
Parámetro |
Tipo |
Descripción |
---|---|---|
frozened |
Boolean |
La etiqueta congelada. Predeterminado: false |
id |
String |
El ID del throughput. |
total_val |
Integer |
El throughput. |
volume_id |
String |
El ID del disco. |
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}/volumes/{volume_id} https://{endpoint}/v3/{project_id}/volumes/{volume_id}
Ejemplo de respuestas
Código de estado: 200
Aceptar
{ "volume" : { "attachments" : [ ], "links" : [ { "href" : "https://volume.az0.dc1.domainname.com/v2/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41", "rel" : "self" }, { "href" : "https://volume.az0.dc1.domainname.com/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41", "rel" : "bookmark" } ], "availability_zone" : "az-dc-1", "os-vol-host-attr:host" : "az-dc-1#SSD", "encrypted" : false, "multiattach" : true, "updated_at" : "2016-02-03T02:19:29.895237", "os-volume-replication:extended_status" : null, "replication_status" : "disabled", "snapshot_id" : null, "id" : "591ac654-26d8-41be-bb77-4f90699d2d41", "size" : 40, "user_id" : "fd03ee73295e45478d88e15263d2ee4e", "os-vol-tenant-attr:tenant_id" : "40acc331ac784f34842ba4f08ff2be48", "volume_image_metadata" : null, "os-vol-mig-status-attr:migstat" : null, "metadata" : { }, "status" : "error_restoring", "description" : "auto-created_from_restore_from_backup", "source_volid" : null, "consistencygroup_id" : null, "os-vol-mig-status-attr:name_id" : null, "name" : "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9", "bootable" : "false", "created_at" : "2016-02-03T02:19:11.723797", "volume_type" : 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.