• Elastic Volume Service

evs
  1. Help Center
  2. Elastic Volume Service
  3. API Reference
  4. OpenStack Cinder API v3
  5. EVS Disk
  6. Querying Details About All EVS Disks

Querying Details About All EVS Disks

Function

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

URI

  • URI format

    GET /v3/{project_id}/volumes/detail

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

  • Request filter parameters

    Parameter

    Type

    Mandatory

    Description

    marker

    string

    No

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

    name

    string

    No

    Specifies the EVS disk name. The value can contain a maximum of 255 bytes.

    limit

    int

    No

    Specifies the maximum number of query results that can be returned. The value must be an integer greater than 0.

    If the tenant has more than 50 disks in total, you are advised to use this parameter and set its value to 50 to improve the query efficiency. Examples are provided as follows:

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

    sort_key

    string

    No

    Specifies 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

    string

    No

    Specifies the result sorting order. The default value is desc (descending order).

    offset

    int

    No

    Specifies the offset. If the value is an integer greater than 0 but less than the number of disks, all disks after this offset will be queried.

    status

    string

    No

    Specifies the EVS disk status. For details, see EVS Disk Status.

    metadata

    string

    No

    Specifies the EVS disk metadata.

    availability_zone

    string

    No

    Specifies the AZ.

    changes-since

    string

    No

    Specifies the time when the disk was updated, for example, 2016-01-08T09:41:18. Only administrators can set this parameter.

    glance_metadata

    map<string,string>

    No

    Specifies the filtered query of the image metadata in the {'key':'value'} format. This parameter is supported when the request version is 3.4 or later.

    bootable

    boolean

    No

    Specifies whether the query result contains system disks. The values are as follows:

    • True, true, and 1: The query result contains system disks only.
    • False, false, and 0: The query result does not contain system disks.

    This parameter is supported when the request version is 3.2 or later.

    migration_status

    string

    No

    Specifies the migration status. The value can be starting, migrating, success, or error.

    name~

    string

    No

    Specifies the fuzzy search by disk name. This parameter is supported when the request version is 3.31 or later.

    status~

    string

    No

    Specifies the fuzzy search by disk status. This parameter is supported when the request version is 3.31 or later.

    availability_zone~

    string

    No

    Specifies the fuzzy search by AZ. This parameter is supported when the request version is 3.31 or later.

    migration_status~

    string

    No

    Specifies the fuzzy search by migration status. This parameter is supported when the request version is 3.31 or later.

    with_count

    boolean

    No

    Specifies to return parameter counts in the response. This parameter indicates the number of disks queried. This parameter is in the with_count=true format and is supported when the request version is 3.45 or later.

    This parameter can be used together with parameters marker, limit, sort_key, sort_dir, or offset in the table. It cannot be used with other filter parameters.

Request

None

Response

  • Parameter description

    Parameter

    Type

    Description

    volumes

    list

    Specifies the list of queried EVS disks.

    id

    string

    Specifies the EVS disk ID.

    links

    list<map<string,string>>

    Specifies the URI of the EVS disk.

    name

    string

    Specifies the EVS disk name.

    status

    string

    Specifies the EVS disk status. For details, see EVS Disk Status.

    attachments

    array

    Specifies the attachment information.

    availability_zone

    string

    Specifies the AZ to which the EVS disk belongs.

    os-vol-host-attr:host

    string

    Specifies the host to which the EVS disk belongs.

    source_volid

    string

    Specifies the source EVS disk ID. If the disk is created from a source EVS disk, this parameter has a value.

    snapshot_id

    string

    Specifies the snapshot ID. If the disk is created from a snapshot, this parameter has a value.

    description

    string

    Specifies the EVS disk description.

    created_at

    string

    Specifies the time when the EVS disk was created.

    volume_type

    string

    Specifies the EVS disk type.

    os-vol-tenant-attr:tenant_id

    string

    Specifies the ID of the tenant to which the EVS disk belongs.

    size

    int

    Specifies the EVS disk size.

    metadata

    map<string,string>

    Specifies the EVS 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.

    os-vol-mig-status-attr:migstat

    string

    Specifies the EVS disk migration status.

    os-vol-mig-status-attr:name_id

    string

    Specifies the ID of the migrated EVS disk.

    os-volume-replication:extended_status

    string

    Specifies the disk replication extended status.

    encrypted

    Boolean

    Specifies whether the disk is encrypted.

    replication_status

    string

    Specifies the EVS disk backup status.

    user_id

    string

    Reserved

    consistencygroup_id

    string

    Specifies the ID of the consistency group accommodating the EVS disk.

    bootable

    string

    Specifies whether the EVS disk is bootable.

    updated_at

    string

    Specifies the time when the EVS disk was updated.

    shareable

    Boolean

    Specifies whether the EVS disk is shareable.

    NOTE:

    This field is no longer used. Use multiattach.

    multiattach

    Boolean

    Specifies whether the EVS disk is shareable.

    volume_image_metadata

    map<string,string>

    Specifies whether the EVS disk is created from an image. This parameter is specified when the disk is created from an image. Otherwise, it is left empty.

    NOTE:

    For details about the volume_image_metadata field, see Querying Image Details (Native OpenStack API) in the Image Management Service API Reference.

    volumes_links

    array

    Specifies the query position marker in the disk list. This parameter is at the same level as parameter volumes in the response body. If only some disks are returned in this query, the URL of the last disk queried will be returned. You can use this URL to continue to query the remaining disks in the next query.

    count

    map

    Specifies the number of records returned in this query.

  • Parameters in the links field

    Parameter

    Type

    Description

    href

    string

    Specifies the corresponding shortcut link.

    rel

    string

    Specifies the shortcut link marker name.

  • Parameters in the attachments field

    Parameter

    Type

    Description

    server_id

    string

    Specifies the ID of the server to which the disk is attached.

    attachment_id

    string

    Specifies the ID of the attachment information.

    attached_at

    string

    Specifies the time when the disk was attached.

    host_name

    string

    Specifies the name of the physical host accommodating the server to which the EVS disk is attached.

    volume_id

    string

    Specifies the EVS disk ID.

    device

    string

    Specifies the device name.

    id

    string

    Specifies the ID of the attached resource.

  • Parameters in the metadata field

    Parameter

    Type

    Description

    __system__encrypted

    string

    Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
    • 0: indicates the disk is not encrypted.
    • 1: indicates the disk is encrypted.
    • If this parameter does not appear, the disk is not encrypted by default.

    __system__cmkid

    string

    Specifies the parameter that describes 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.

    hw:passthrough

    string

    Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
    • If this parameter is set to true, the disk device type is SCSI, that is, Small Computer System Interface (SCSI), which allows ECS OSs to directly access the underlying storage media and supports SCSI reservation commands.
    • If this parameter is set to false, the disk device type is VBD (the default type), that is, Virtual Block Device (VBD), which supports only simple SCSI read/write commands.
    • If this parameter does not appear, the disk device type is VBD.

    full_clone

    string

    Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method.

    readonly

    string

    Specifies whether the disk is read-only or read-writable. The value can be True or False.
    • True: indicates that the disk is read-only.
    • False: indicates that the disk is read-writable.

    attached_mode

    string

    Specifies whether the disk is attached as read-only or read-writable. This parameter appears only when the disk has been attached to a server. The value can be ro or rw.
    • ro: indicates the disk is attached as read-only.
    • rw: indicates the disk is attached as read-writable.
  • Example response
    {
        "count": 1, 
        "volumes": [
            {
                "attachments": [ ], 
                "availability_zone": "xxx", 
                "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": {
                    "__openstack_region_name": "pod01.xxx", 
                    "a": "b", 
                    "quantityGB": "1", 
                    "volInfoUrl": "iaas blockstorage://172.30.64.10/0/FEFEEB07D3924CDEA93C612D4E16882D"
                }, 
                "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:driver_data": 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"
            }
        ]
    }

    or

    {
        "error": {
            "message": "XXXX", 
            "code": "XXX"
        }
    }

    In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:

    {
        "itemNotFound": {
            "message": "XXXX", 
            "code": "XXX"
        }
    } 

Returned Values

  • Normal

    200

Error Codes

For details, see Error Codes.