Querying Details About an EVS Disk
Function
This API is used to query details about an EVS disk.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/volumes/{volume_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
The project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
volume_id |
Yes |
String |
The disk ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
The user token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
volume |
CinderVolumeDetail object |
The returned disk. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
The disk ID. |
links |
Array of Link objects |
The disk URI. |
name |
String |
The disk name. |
status |
String |
The disk status. For details, see EVS Disk Status. |
attachments |
Array of VolumeAttachment objects |
Whether the disk is attached. |
availability_zone |
String |
The AZ to which the disk belongs. |
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. |
description |
String |
The disk description. |
bootable |
String |
Whether the disk is bootable. true: The disk is bootable. false: The disk is not bootable. |
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 SATA, SAS, GPSSD, SSD, ESSD, GPSSD2, or ESSD2.
|
metadata |
VolumeMetadata object |
The disk metadata. If metadata does not contain the hw:passthrough field, the disk device type is VBD. If metadata does not contain the __system__encrypted field, the disk is not encrypted. |
size |
Integer |
The disk size, in GiB. |
shareable |
Boolean |
Whether the disk is shareable. Note: This field has been deprecated. Use multiattach. |
multiattach |
Boolean |
Whether the disk is shareable. |
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. |
volume_image_metadata |
Object |
The metadata of the disk image. For details about the volume_image_metadata field, see Querying Image Details (Native OpenStack API). |
os-vol-host-attr:host |
String |
The reserved field. |
os-volume-replication:extended_status |
String |
The reserved field. |
consistencygroup_id |
String |
The reserved field. |
iops |
iops object |
The disk IOPS information. This parameter is returned only for a general purpose SSD V2 or an extreme SSD V2 disk. |
throughput |
throughput object |
The disk throughput information. This parameter is returned only for a general purpose SSD V2 disk. |
updated_at |
String |
The time when the disk was updated. |
replication_status |
String |
The reserved field. |
user_id |
String |
The reserved field. |
encrypted |
Boolean |
The reserved field. |
Parameter |
Type |
Description |
---|---|---|
href |
String |
The corresponding shortcut link. |
rel |
String |
The shortcut link marker name. Default: next |
Parameter |
Type |
Description |
---|---|---|
attached_at |
String |
The time when the disk was attached. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
attachment_id |
String |
The attachment ID. |
device |
String |
The device name. |
host_name |
String |
The name of the physical host housing the cloud server to which the disk is attached. |
id |
String |
The ID of the attached disk. |
server_id |
String |
The ID of the server to which the disk is attached. |
volume_id |
String |
The disk ID. |
Parameter |
Type |
Description |
---|---|---|
__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.
NOTE:
Use an HTTPS request to obtain the key ID. For details, see Querying the Key List. |
__system__encrypted |
String |
The encryption field in metadata. The value can be 0 (no encryption) or 1 (encryption). If this parameter does not appear, the disk is not encrypted. |
full_clone |
String |
If the disk is created from a snapshot and linked cloning needs to be used, set this parameter to 0. |
hw:passthrough |
String |
If this parameter is set to true, the disk device type is SCSI, which allows ECS OSs to directly access the underlying storage media. SCSI reservation commands are supported. If this parameter is set to false, the disk device type is VBD, which is also the default type. VBD supports only simple SCSI read/write commands. If this parameter is not available, the disk device type is VBD. |
Parameter |
Type |
Description |
---|---|---|
frozened |
Boolean |
The frozen tag. Default: false |
id |
String |
The ID of the disk IOPS. |
total_val |
Integer |
The IOPS. |
volume_id |
String |
The disk ID. |
Parameter |
Type |
Description |
---|---|---|
frozened |
Boolean |
The frozen tag. Default: false |
id |
String |
The throughput ID. |
total_val |
Integer |
The throughput. |
volume_id |
String |
The disk ID. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error |
Error object |
The error message returned if an error occurs. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
The error code returned if an error occurs. For details about error codes and their meanings, see Error Codes. |
message |
String |
The error message returned if an error occurs. |
Example Requests
GET https://{endpoint}/v2/{project_id}/volumes/{volume_id}
Example Responses
Status code: 200
OK
{ "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", "replication_status" : "disabled", "id" : "591ac654-26d8-41be-bb77-4f90699d2d41", "size" : 40, "user_id" : "fd03ee73295e45478d88e15263d2ee4e", "os-vol-tenant-attr:tenant_id" : "40acc331ac784f34842ba4f08ff2be48", "os-volume-replication:extended_status" : null, "snapshot_id" : null, "volume_image_metadata" : null, "os-vol-mig-status-attr:migstat" : null, "metadata" : { }, "status" : "error_restoring", "description" : "auto-created_from_restore_from_backup", "name" : "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9", "bootable" : "false", "created_at" : "2016-02-03T02:19:11.723797" } }
Status code: 400
Bad Request
{ "error" : { "message" : "XXXX", "code" : "XXX" } }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot