Querying Brief Information About Disks (Discarded)
Function
This API is used to query brief information about disks.
This API has been discarded. Use the API described in Querying EVS Disks (OpenStack Cinder API v2).
URI
GET /v2.1/{project_id}/os-volumes
Parameter |
Mandatory |
Description |
---|---|---|
project_id |
Yes |
Specifies the project ID. For details about how to obtain the ID, see Obtaining a Project ID. |
Request
N/A
Response
Table 2 describes the response parameters.
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the disk ID in UUID format. |
displayName |
String |
Specifies the disk name. |
status |
String |
Specifies the disk status. |
attachments |
Array of objects |
Specifies the attachment information about a disk. |
availabilityZone |
String |
Specifies the AZ to which the disk belongs. |
createdAt |
String |
Specifies the time when the disk was created. |
displayDescription |
String |
Specifies the disk description. |
volumeType |
String |
Specifies the disk type. |
snapshotId |
String |
Specifies the snapshot ID. |
metadata |
Object |
Specifies the disk metadata. |
size |
Integer |
Specifies the disk size. |
Parameter |
Type |
Description |
---|---|---|
device |
String |
Specifies the directory to which the disk is mounted. |
id |
String |
Specifies the ID of the attached resource. |
serverId |
String |
Specifies the ECS ID. |
volumeId |
String |
Specifies the ID of the attached disk. |
Example Request
GET https://{endpoint}/v2.1/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes
Example Response
{ "volumes": [ { "status": " available", "attachments": [{}], "availabilityZone": "nova", "createdAt": "2016-05-20T07:57:56.299000", "displayDescription": null, "volumeType": null, "dispalyName": "test", "snapshotId": null, "metadata": {}, "id": "70b14513-faad-4646-b7ab-a065cef282b4", "size": 1 } ] }
Returned Values
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.