• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. OpenStack Cinder API v1 (Deprecated)
  5. EVS Disk
  6. Querying Details About a Disk (Deprecated)

Querying Details About a Disk (Deprecated)

Function

This API is used to query details about a disk.

This API has been deprecated. Use another API. For details, see Querying Details About a Single EVS Disk.

URI

  • URI format

    GET /v1/{project_id}/volumes/{volume_id}

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

    volume_id

    Yes

    Specifies the disk ID.

Request

None

Response

  • Parameter description

    Parameter

    Type

    Description

    volume

    map<string, string>

    Specifies the disk information.

    id

    string

    Specifies the disk ID.

    display_name

    string

    Specifies the disk name.

    status

    string

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

    attachments

    Array

    Specifies the attachment information.

    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.

    display_description

    string

    Specifies the disk description.

    created_at

    string

    Specifies the time when the disk was created.

    volume_type

    string

    Specifies the disk type.

    os-vol-tenant-attr:tenant_id

    string

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

    size

    int

    Specifies the disk size.

    metadata

    map<string,string>

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

    encrypted

    Boolean

    Specifies whether the disk is encrypted.

    bootable

    string

    Specifies whether the disk is bootable.

    shareable

    string

    Specifies whether the disk is shareable.

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

  • Example response
    {
        "volume": {
            "attachments": [],
            "availability_zone": "nova",
            "os-vol-host-attr:host": "db-rabbitmq201#LVM_iSCSI",
            "encrypted": false,
            "os-volume-replication:extended_status": null,
            "volume_image_metadata": null,
            "snapshot_id": null,
            "id": "da4f9c7a-c275-4bc9-80c4-76c7d479a218",
            "size": 1,
            "os-vol-tenant-attr:tenant_id": "3dab0aaf682849678a94ec7b5a3af2ce",
            "os-vol-mig-status-attr:migstat": null,
            "metadata": {},
            "status": "available",
            "display_description": null,
            "source_volid": null,
            "os-vol-mig-status-attr:name_id": null,
            "display_name": "test",
            "bootable": "false",
            "created_at": "2014-12-18T17:14:38.000000",
            "volume_type": "SATA",
            "multiattach": false
        }
    }

    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.