• 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 a Single EVS Disk

Querying Details About a Single EVS Disk

Function

This API is used to query details about a single EVS disk.

URI

  • URI format

    GET /v3/{project_id}/volumes/{volume_id}

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

    volume_id

    Yes

    Specifies the EVS disk ID.

Request

None

Response

  • Parameter description

    Parameter

    Type

    Description

    volume

    map

    Specifies the queried EVS disk.

    id

    string

    Specifies the EVS disk UUID.

    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

    list<map<string, string>>

    Specifies the EVS disk attachment information.

    availability_zone

    string

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

    os-vol-tenant-attr:tenant_id

    string

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

    volume_image_metadata

    map<string, string>

    Specifies the metadata of the EVS disk image.

    NOTE:

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

    created_at

    string

    Specifies the time when the EVS disk was created.

    volume_type

    string

    Specifies the EVS disk type.

    size

    int

    Specifies the EVS disk size.

    bootable

    string

    Specifies whether the EVS disk is bootable.

    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-host-attr:host

    string

    Specifies the host to which the EVS disk belongs.

    encrypted

    Boolean

    Specifies whether the disk is encrypted.

    updated_at

    string

    Specifies the time when the EVS disk information was updated.

    os-volume-replication:extended_status

    string

    Reserved

    replication_status

    string

    Reserved

    os-vol-mig-status-attr:migstat

    string

    Reserved

    consistencygroup_id

    string

    Reserved

    os-vol-mig-status-attr:name_id

    string

    Reserved

    shareable

    boolean

    Specifies whether the EVS disk is shareable.

    NOTE:

    This field is no longer used. Use multiattach.

    user_id

    string

    Reserved

    message

    string

    Specifies the returned error message when an error occurs.

    code

    string

    Specifies the returned error code when an error occurs.

    For details about the error code, see Error Codes.

    multiattach

    boolean

    Specifies the shared EVS disk information.

  • 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
    {
        "volume": {
            "attachments": [ ], 
            "links": [
                {
                    "href": "https://volume.az0.dc1.domainname.com/v2/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41", 
                    "rel": "self"
                }, 
                {
                    "href": "https://volume.az0.dc1.domainname.com/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41", 
                    "rel": "bookmark"
                }
            ], 
            "availability_zone": "az1.dc1", 
            "os-vol-host-attr:host": "az1.dc1#SSD", 
            "encrypted": false, 
            "multiattach": true, 
            "updated_at": "2016-02-03T02:19:29.895237", 
            "os-volume-replication:extended_status": null, 
            "replication_status": "disabled", 
            "snapshot_id": null, 
            "id": "591ac654-26d8-41be-bb77-4f90699d2d41", 
            "size": 40, 
            "user_id": "fd03ee73295e45478d88e15263d2ee4e", 
            "os-vol-tenant-attr:tenant_id": "40acc331ac784f34842ba4f08ff2be48", 
            "volume_image_metadata": null, 
            "os-vol-mig-status-attr:migstat": null, 
            "metadata": {
                "__openstack_region_name": "az1.dc1", 
                "quantityGB": "40"
            }, 
            "status": "error_restoring", 
            "description": "auto-created_from_restore_from_backup", 
            "source_volid": null, 
            "consistencygroup_id": null, 
            "os-vol-mig-status-attr:name_id": null, 
            "name": "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9", 
            "bootable": "false", 
            "created_at": "2016-02-03T02:19:11.723797", 
            "volume_type": null
        }
    }

    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:

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

Returned Values

  • Normal

    200

Error Codes

For details, see Error Codes.