• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. OpenStack Cinder API v2
  5. EVS Disk
  6. Querying Details About All Disks

Querying Details About All Disks

Function

This API is used to query details about all disks.

URI

  • URI format

    GET /v2/{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 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 ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit.

    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.
    • desc: indicates the descending order.
    • asc: indicates the ascending 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 disk status. For details, see EVS Disk Status.

    metadata

    string

    No

    Specifies the disk metadata.

    availability_zone

    string

    No

    Specifies the AZ.

Request

The following example shows how to query details of the disks in the available state.

  • Example request
    GET https://{endpoint}/v2/{project_id}/volumes/detail?state=available

Response

  • Parameter description

    Parameter

    Type

    Description

    volumes

    list

    Specifies the list of queried disks. For details, see Parameters in the volumes field.

    volumes_links

    list

    Specifies the query position marker in the disk list. 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.

    error

    string

    Specifies the error message returned when an error occurs. For details, see Parameters in the error field.

  • Parameters in the volumes field

    Parameter

    Type

    Description

    id

    string

    Specifies the disk ID.

    links

    list<map<string,string>>

    Specifies the disk URI. For details, see Parameters in the links field.

    name

    string

    Specifies the disk name.

    status

    string

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

    attachments

    array

    Specifies the disk attachment information. For details, see Parameters in the attachments field.

    availability_zone

    string

    Specifies the AZ to which the disk belongs.

    os-vol-host-attr:host

    string

    Specifies the host to which the disk belongs.

    source_volid

    string

    Specifies the source disk ID. This parameter has a value if the disk is created from a source disk.

    snapshot_id

    string

    Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot.

    description

    string

    Specifies the disk description.

    created_at

    string

    Specifies the time when the disk was created.

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

    volume_type

    string

    Specifies the disk type.

    For details about disk types, see volume_type in the parameters of volume in the request of Creating EVS Disks.

    os-vol-tenant-attr:tenant_id

    string

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

    size

    int

    Specifies the disk size, in GB.

    metadata

    map<string,string>

    Specifies the disk metadata. For details, see Parameters in the metadata field.

    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 disk migration status.

    os-vol-mig-status-attr:name_id

    string

    Specifies the ID of the migrated 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 disk backup status.

    user_id

    string

    Reserved field

    consistencygroup_id

    string

    Specifies the ID of the consistency group where the disk belongs.

    bootable

    string

    Specifies whether the disk is bootable.

    updated_at

    string

    Specifies the time when the disk was updated.

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

    shareable

    Boolean

    Specifies whether the disk is shareable.

    NOTE:

    This field is no longer used. Use multiattach.

    multiattach

    Boolean

    Specifies whether the disk is shareable.

    volume_image_metadata

    map<string,string>

    Specifies whether the disk is created from an image. This field has a value if the disk is created from an image. Otherwise, it is left empty.

    NOTE:

    For details about volume_image_metadata, see Querying Image Details in the Image Management Service API Reference.

  • 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.

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

    host_name

    string

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

    volume_id

    string

    Specifies the 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/write. The value can be True or False.
    • True: indicates that the disk is read-only.
    • False: indicates that the disk is read/write.

    attached_mode

    string

    Specifies whether the disk is attached as read-only or read/write. 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/write.

    policy

    string

    Specifies the backup policy ID in the metadata field.

  • Parameters in the error field

    Parameter

    Type

    Description

    message

    string

    Specifies the error message returned when an error occurs.

    code

    string

    Specifies the error code returned when an error occurs.

    For details about the error code, see Error Codes.

  • Example response
    {
        "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: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"
            }
        ]
    }

    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.