Querying Details About an EVS Disk (Deprecated)
Function
This API is used to query details about a single EVS disk.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/os-vendor-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 |
A token obtained from IAM is valid for 24 hours. When using a token for authentication, cache it to avoid frequently calling the API. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
volume |
VolumeDetailV3 object |
The information of the returned disk. For details, see Parameters in the volume field. |
Parameter |
Type |
Description |
---|---|---|
attachments |
Array of AttachmentV3 objects |
The disk attachment information. For details, see |
availability_zone |
String |
The AZ to which the disk belongs. |
bootable |
String |
Whether the disk is bootable. true: The disk is bootable. false: The disk is not bootable. |
consistencygroup_id |
String |
The reserved field. |
created_at |
String |
The time when the disk was created. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
dedicated_storage_id |
String |
The ID of the dedicated storage pool housing the disk. |
dedicated_storage_name |
String |
The name of the dedicated storage pool housing the disk. |
description |
String |
The disk description. |
encrypted |
Boolean |
This field is currently not supported. |
enterprise_project_id |
String |
The ID of the enterprise project that the disk has been added to. For more information about enterprise projects and how to obtain enterprise project IDs, see |
id |
String |
The disk ID. |
links |
Array of LinkV3 objects |
The disk URI. For details, see |
metadata |
VolumeMetadataV3 object |
The metadata. |
multiattach |
Boolean |
Whether the disk is shareable. true: The disk is shareable. false: The disk is not shareable. |
name |
String |
The disk name. |
replication_status |
String |
The reserved field. |
service_type |
String |
The service type. Supported services are EVS, DSS, and DESS. |
shareable |
Boolean |
Whether the disk is shareable.
NOTE:
This field has been deprecated. Use multiattach. |
size |
Integer |
The disk size, in GiB. |
snapshot_id |
String |
The snapshot ID. This parameter has a value if the disk is created from a snapshot. |
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. |
status |
String |
The disk status. |
tags |
Map<String,String> |
The disk tags. This field has values if the disk has tags. Or, it is left empty. |
updated_at |
String |
The time when the disk was updated. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
user_id |
String |
The reserved field. |
volume_image_metadata |
Object |
The metadata of the disk image.
NOTE:
For details about the volume_image_metadata field, see Querying Image Details (Native OpenStack API). |
volume_type |
String |
The disk type. The value can be SATA, SAS, GPSSD, or SSD.
|
wwn |
String |
The unique identifier used when attaching the disk. |
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. |
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. |
os-vol-host-attr:host |
String |
The reserved field. |
storage_cluster_id |
String |
The reserved field. |
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 |
---|---|---|
href |
String |
The corresponding shortcut link. |
rel |
String |
The shortcut link marker name. Default: next |
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. |
__system__encrypted |
String |
The encryption field in metadata. 0: no encryption 1: encryption If this parameter does not appear, the disk is not encrypted. |
full_clone |
String |
The method of creation when the disk is created from a snapshot.
|
hw:passthrough |
String |
The parameter that describes the disk device type in metadata.
|
orderID |
String |
The parameter that describes the disk billing mode in metadata. If this parameter has a value, the disk is billed on a yearly/monthly basis. If not, the disk is billed on a pay-per-use basis. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error |
Error object |
The error message returned if an error occurs. For details, seeParameters in the error field. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
The error code returned if an error occurs. For the error codes and their meanings, see Error Codes. |
message |
String |
The error message returned if an error occurs. |
Example Requests
GET https://{endpoint}/v3/{project_id}/os-vendor-volumes/{volume_id}
Example Responses
Status code: 200
OK
{ "volume" : { "attachments" : [ ], "links" : [ { "href" : "https://volume.az0.dc1.domainname.com/v3/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", "metadata" : { }, "tags" : { "key1" : "value1", "key2" : "value2" }, "enterprise_project_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635", "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", "service_type" : "EVS", "wwn" : "688860300000d136fa16f48f05992360", "backup_id" : "null" } }
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