Updated on 2024-02-27 GMT+08:00

Querying Details About All EVS Disks

Function

This API is used to query details about all EVS disks.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/volumes/detail

Table 1 Path Parameters

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.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

marker

No

String

The ID of the last record on the previous page. The returned value is the value of the item after this one.

name

No

String

The disk name. You can enter up to 64 characters.

limit

No

Integer

The maximum number of query results that can be returned.

The value ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit.

If you have more than 50 disks in total, use this parameter and set it to 50 to improve the query efficiency. Examples are provided as follows:

Querying 1–50 disks: GET /v2/xxx/volumes/detail?limit=50 Querying 51–100 disks: GET /v2/xxx/volumes/detail?offset=50&limit=50

sort_key

No

String

The keyword based on which the returned results are sorted. The value can be id, status, size, or created_at, and the default value is created_at.

sort_dir

No

String

The result sorting order. The default value is desc. desc: the descending order asc: the ascending order

offset

No

Integer

The query offset.

All disks after this offset will be queried. The value must be an integer greater than 0 but less than the number of disks.

status

No

String

The disk status.

metadata

No

String

The disk metadata. This parameter is transferred in JSON format, for example, GET /v3/{project_id}/volumes/detail?metadata={"hw:passthrough": "true"}.

availability_zone

No

String

The AZ information.

Request Parameters

Table 3 Request header 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

Table 4 Response body parameters

Parameter

Type

Description

volumes

Array of VolumeDetail objects

The list of returned disks.

volumes_links

Array of Link objects

The query position marker in the disk list. If only some disks are returned in this query, the URL of the last disk queried is returned. You can use this URL to continue to query the remaining disks in the next query.

Table 5 VolumeDetail

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.

encrypted

Boolean

This field is currently not supported.

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.

  • SATA: the common I/O type (sold out)

  • SAS: the high I/O type

  • GPSSD: the general purpose SSD type

  • SSD: the ultra-high I/O type

  • ESSD: the extreme SSD type

  • GPSSD2: the general purpose SSD V2 type

  • ESSD2: the extreme SSD V2 type

replication_status

String

The reserved field.

consistencygroup_id

String

The reserved field.

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.

user_id

String

The reserved field.

updated_at

String

The time when the disk was updated.

Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

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.

os-vol-mig-status-attr:migstat

String

The reserved field.

os-vol-mig-status-attr:name_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.

Table 6 VolumeAttachment

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.

Table 7 VolumeMetadata

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.

Table 8 iops

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.

Table 9 throughput

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

Table 11 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs.

Table 12 Error

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}/v3/{project_id}/volumes/detail?status=available

Example Responses

Status code: 200

OK

{
  "volumes" : [ {
    "attachments" : [ ],
    "availability_zone" : "az-dc-1",
    "bootable" : "false",
    "consistencygroup_id" : null,
    "created_at" : "2016-05-25T02:42:10.856332",
    "description" : null,
    "encrypted" : false,
    "id" : "b104b8db-170d-441b-897a-3c8ba9c5a214",
    "links" : [ {
      "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
      "rel" : "self"
    }, {
      "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
      "rel" : "bookmark"
    } ],
    "metadata" : { },
    "name" : "zjb_u25_test",
    "os-vol-host-attr:host" : "pod01.xxx#SATA",
    "volume_image_metadata" : { },
    "os-vol-mig-status-attr:migstat" : null,
    "os-vol-mig-status-attr:name_id" : null,
    "os-vol-tenant-attr:tenant_id" : "dd14c6ac581f40059e27f5320b60bf2f",
    "os-volume-replication:extended_status" : null,
    "replication_status" : "disabled",
    "multiattach" : false,
    "size" : 1,
    "snapshot_id" : null,
    "source_volid" : null,
    "status" : "available",
    "updated_at" : "2016-05-25T02:42:22.341984",
    "user_id" : "b0524e8342084ef5b74f158f78fc3049",
    "volume_type" : "SATA"
  } ],
  "volumes_links" : [ {
    "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214",
    "rel" : "next"
  } ]
}

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.