Querying Details About a Disk (Deprecated)¶
Function¶
This API is used to query details about a disk.
Important
This API has been deprecated. Use another API. For details, see Querying Details About a Disk.
URI¶
URI format
GET /v1/{project_id}/volumes/{volume_id}
Parameter description
Parameter
Mandatory
Description
project_id
Yes
The project ID.
volume_id
Yes
The disk ID.
Request¶
Example request
GET https://{endpoint}/v1/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214
Response¶
Response parameters
Parameter
Type
Description
volume
Object
The disk information. For details, see Parameters in the volume field.
error
Object
The error message returned if an error occurs. For details, see Parameters in the error field.
Parameters in the volume field
Parameter
Type
Description
id
String
The disk ID.
display_name
String
The disk name.
status
String
The disk status. For details, see EVS Disk Status.
attachments
list
The attachment information.
availability_zone
String
The AZ to which the disk belongs.
os-vol-host-attr:host
String
The reserved field.
source_volid
String
The source disk ID. This parameter has a value if the disk is created from a source disk.
This field is currently not supported.
snapshot_id
String
The snapshot ID. This parameter has a value if the disk is created from a snapshot.
display_description
String
The disk description.
created_at
String
The time when the disk was created.
Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
volume_type
String
The disk type.
The value can be ESSD, SSD, SAS, SATA, co-p1, or uh-l1.
SSD: the ultra-high I/O type
SAS: the high I/O type
SATA: the common I/O type
co-p1: the high I/O (performance-optimized I) type
uh-l1: the ultra-high I/O (latency-optimized) type
ESSD: the extreme SSD type
The co-p1 and uh-l1 types of disks are used exclusively for HPC ECSs and SAP HANA ECSs.
os-vol-tenant-attr:tenant_id
String
The ID of the tenant to which the disk belongs. The tenant ID is the same as the project ID.
size
Integer
The disk size, in GB.
metadata
Object
The disk metadata.
os-vol-mig-status-attr:migstat
String
The reserved field.
os-vol-mig-status-attr:name_id
String
The reserved field.
os-volume-replication:extended_status
String
The reserved field.
encrypted
Boolean
This field is currently not supported.
bootable
String
Whether the disk is bootable.
true: indicates a bootable disk.
false: indicates a non-bootable disk.
shareable
String
Whether the disk is shareable.
Note
This field is no longer used. Use multiattach.
multiattach
Boolean
Whether the disk is shareable.
true: indicates a shared disk.
false: indicates a non-shared disk.
volume_image_metadata
Object
The metadata of the disk image. This field has a value if the disk is created from an image. Or, it is left empty.
Note
For details about volume_image_metadata, see Querying Image Details (Native OpenStack API) in the Image Management Service API Reference.
Parameters in the attachments field
Parameter
Type
Description
server_id
String
The ID of the server to which the disk is attached.
attachment_id
String
The ID of the attachment information.
attached_at
String
The time when the disk was attached.
Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
host_name
String
The name of the physical host housing the cloud server to which the disk is attached.
volume_id
String
The disk ID.
device
String
The device name.
id
String
The ID of the attached disk.
Parameters in the metadata field
Parameter
Type
Description
__system__encrypted
String
The encryption field in metadata.
0: indicates a non-encrypted disk.
1: indicates an encrypted disk.
If this parameter does not appear, the disk is not encrypted.
__system__cmkid
String
The encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes.
hw:passthrough
String
The parameter that describes the disk device type in metadata. The value can be true or false.
true indicates the SCSI device type, which allows ECS OSs to directly access the underlying storage media and support SCSI reservations commands.
false indicates the VBD device type (the default type), which supports only simple SCSI read/write commands.
If this parameter does not appear, the disk device type is VBD.
full_clone
String
The clone method. If the disk is created from a snapshot, value 0 indicates the linked cloning method.
Parameters in the error field
Parameter
Type
Description
message
String
The error message returned if an error occurs.
code
String
The error code returned if an error occurs.
For details about the error code, see Error Codes.
Example response
{ "volume": { "attachments": [], "availability_zone": "az-dc-1", "os-vol-host-attr:host": "db-rabbitmq201#LVM_iSCSI", "encrypted": false, "os-volume-replication:extended_status": null, "volume_image_metadata": null, "snapshot_id": null, "id": "da4f9c7a-c275-4bc9-80c4-76c7d479a218", "size": 1, "os-vol-tenant-attr:tenant_id": "3dab0aaf682849678a94ec7b5a3af2ce", "os-vol-mig-status-attr:migstat": null, "metadata": {}, "status": "available", "display_description": null, "source_volid": null, "os-vol-mig-status-attr:name_id": null, "display_name": "test", "bootable": "false", "created_at": "2014-12-18T17:14:38.000000", "volume_type": "SAS", "multiattach": false } }
or
{ "error": { "message": "XXXX", "code": "XXX" } }
In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
{ "itemNotFound": { "message": "XXXX", "code": "XXX" } }
Status Codes¶
Normal
200
Error Codes¶
For details, see Error Codes.