• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Nova
  5. Disk Management
  6. Querying Brief Information About Disks (Discarded)

Querying Brief Information About Disks (Discarded)

Function

This API is used to query brief information about disks.

Constraints

  • This API will be discarded. You are advised to use the EVS API "Querying EVS Disks (Native OpenStack API V2)".

URI

GET /v2.1/{project_id}/os-volumes

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

Request

N/A

Response

Response parameters

Table 2 describes the response parameters.

Table 2 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

List

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

Dict

Specifies the disk metadata.

size

Int

Specifies the disk size.

Table 3 attachments field description

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.

Examples

  • Example request
    GET /v2/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes
    GET /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

See General Request Returned Values.