• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  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 disk. For details, see Parameters in the volume field.

    error

    string

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

  • Parameters in the volume field

    Parameter

    Type

    Description

    id

    string

    Specifies the disk UUID.

    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

    list<map<string, string>>

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

    availability_zone

    string

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

    os-vol-tenant-attr:tenant_id

    string

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

    volume_image_metadata

    map<string, string>

    Specifies the metadata of the disk image.

    NOTE:

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

    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.

    size

    int

    Specifies the disk size, in GB.

    bootable

    string

    Specifies whether the disk is bootable.

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

    string

    Specifies the host to which the disk belongs.

    encrypted

    Boolean

    Specifies whether the disk is encrypted.

    updated_at

    string

    Specifies the time when the disk was updated.

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

    os-volume-replication:extended_status

    string

    Reserved field

    replication_status

    string

    Reserved field

    os-vol-mig-status-attr:migstat

    string

    Reserved field

    consistencygroup_id

    string

    Reserved field

    os-vol-mig-status-attr:name_id

    string

    Reserved field

    shareable

    boolean

    Specifies whether the disk is shareable.

    NOTE:

    This field is no longer used. Use multiattach.

    user_id

    string

    Reserved field

    multiattach

    boolean

    Specifies whether the disk is shareable.

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