Help Center> Elastic Volume Service> API Reference> Out-of-Date APIs> API> Disk Management> Querying Details About All EVS Disks (Deprecated)
Updated on 2024-02-27 GMT+08:00

Querying Details About All EVS Disks (Deprecated)

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/os-vendor-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

availability_zone

No

String

The AZ to which the disk belongs.

dedicated_storage_id

No

String

The dedicated storage pool ID. All disks in the dedicated storage pool can be filtered by exact match.

dedicated_storage_name

No

String

The dedicated storage pool name. All disks in the dedicated storage pool can be filtered by fuzzy match.

id

No

String

The disk ID.

ids

No

Array

The disk IDs. The value is in the ids=['id1','id2',...,'idx'] format. In the response, the ids value contains valid disk IDs only. Invalid disk IDs are ignored.

The details about a maximum of 60 disks can be queried.

If id and ids are both specified in the request, id will be ignored.

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.

marker

No

String

The ID of the resource from which the pagination query starts. It is the ID of the last resource on the previous page.

metadata

No

String

The disk metadata.

multiattach

No

String

Whether the disk is shareable. true: The disk is shareable. false: The disk is not shareable.

name

No

String

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

offset

No

Integer

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

service_type

No

String

The service type. Supported services are EVS, DSS, and DESS.

sort_dir

No

String

The result sorting order. The default value is desc.

desc: the descending order asc: the ascending order

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.

status

No

String

The disk status. For details, see EVS Disk Status.

volume_type_id

No

String

The disk type ID. For details, go to Querying EVS Disk Types and check the value of id in the table for parameters in the volume_types field..

Request Parameters

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

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

The total number of disks queried.

volumes

Array of VolumeDetailV3 objects

The list of returned disks.

volumes_links

Array of LinkV3 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 query the remaining disks in the next query. For details, see Parameters in the links field.

Table 5 VolumeDetailV3

Parameter

Type

Description

attachments

Array of AttachmentV3 objects

The disk attachment information. For details, see

Parameters in the attachments field.

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

Enterprise Management User Guide.

id

String

The disk ID.

links

Array of LinkV3 objects

The disk URI. For details, see

Parameters in the links field.

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.

  • SATA: the common I/O type
  • SAS: the high I/O type
  • GPSSD: the general purpose SSD type
  • SSD: the ultra-high I/O type

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.

Table 6 AttachmentV3

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 VolumeMetadataV3

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.

  • 0: linked clone
  • 1: full clone

hw:passthrough

String

The parameter that describes the disk device type in metadata.

  • If this parameter value is true, the disk device type is SCSI, which allows ECS OSs to directly access the underlying storage media and supports SCSI reservation commands.
  • If this parameter value is false, the disk device type is VBD, which supports only simple SCSI read/write commands.
  • If this parameter does not appear, the disk device type is VBD.

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.

Table 8 LinkV3

Parameter

Type

Description

href

String

The corresponding shortcut link.

rel

String

The shortcut link marker name.

Default: next

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs. For details, seeParameters in the error field.

Table 10 Error

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/detail

Example Responses

Status code: 200

OK

{
  "count" : 1,
  "volumes" : [ {
    "attachments" : [ ],
    "availability_zone" : "xxx",
    "bootable" : "false",
    "created_at" : "2016-05-25T02:42:10.856332",
    "encrypted" : false,
    "id" : "b104b8db-170d-441b-897a-3c8ba9c5a214",
    "links" : [ {
      "href" : "https://volume.localdomain.com:8776/v3/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" : {
      "__openstack_region_name" : "pod01.xxx",
      "quantityGB" : "1",
      "volInfoUrl" : "fusionstorage://172.30.64.10/0/FEFEEB07D3924CDEA93C612D4E16882D"
    },
    "name" : "zjb_u25_test",
    "os-vol-host-attr:host" : "pod01.xxx#SATA",
    "volume_image_metadata" : { },
    "os-vol-tenant-attr:tenant_id" : "dd14c6ac581f40059e27f5320b60bf2f",
    "replication_status" : "disabled",
    "multiattach" : false,
    "size" : 1,
    "status" : "available",
    "updated_at" : "2016-05-25T02:42:22.341984",
    "user_id" : "b0524e8342084ef5b74f158f78fc3049",
    "volume_type" : "SATA",
    "service_type" : "EVS",
    "wwn" : " 688860300000d136fa16f48f05992360"
  } ],
  "volumes_links" : [ {
    "href" : "https://volume.localdomain.com:8776/v3/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.