Querying Details About a Disk

Function

This API is used to query details about a 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 disk ID.

Request

  • Example request

    GET https://{endpoint}/v3/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214
    

Response

  • Response parameters

    Parameter

    Type

    Description

    volume

    Object

    The queried disk. For details, see Parameters in the volume field.

    error

    Object

    The error message returned if an error occurs. For details, see Parameters in the error field.

  • Parameters in the volume field

    Parameter

    Type

    Description

    id

    String

    The disk ID.

    links

    list<map<String, String>>

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

    name

    String

    The disk name.

    status

    String

    The disk status. For details, see EVS Disk Status.

    attachments

    list<map<String, String>>

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

    availability_zone

    String

    The AZ to which the disk belongs.

    source_volid

    String

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

    This field is currently not supported.

    snapshot_id

    String

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

    description

    String

    The disk description.

    os-vol-tenant-attr:tenant_id

    String

    The ID of the tenant to which the disk belongs. The tenant ID is the same as the project ID.

    volume_image_metadata

    Object

    The metadata of the disk image.

    Note

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

    created_at

    String

    The time when the disk was created.

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

    volume_type

    String

    The disk type.

    The value can be ESSD, SSD, SAS, SATA, co-p1, or uh-l1.

    • SSD: the ultra-high I/O type

    • SAS: the high I/O type

    • SATA: the common I/O type

    • co-p1: the high I/O (performance-optimized I) type

    • uh-l1: the ultra-high I/O (latency-optimized) type

    • ESSD: the extreme SSD type

      The co-p1 and uh-l1 types of disks are used exclusively for HPC ECSs and SAP HANA ECSs.

    size

    Integer

    The disk size, in GB.

    bootable

    String

    Whether the disk is bootable.

    • true: indicates a bootable disk.

    • false: indicates a non-bootable disk.

    metadata

    Object

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

    os-vol-host-attr:host

    String

    The reserved field.

    encrypted

    Boolean

    This field is currently not supported.

    updated_at

    String

    The time when the disk was updated.

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

    os-volume-replication:extended_status

    String

    The reserved field.

    replication_status

    String

    The reserved field.

    os-vol-mig-status-attr:migstat

    String

    The reserved field.

    consistencygroup_id

    String

    The reserved field.

    os-vol-mig-status-attr:name_id

    String

    The reserved field.

    shareable

    Boolean

    Whether the disk is shareable.

    Note

    This field is no longer used. Use multiattach.

    user_id

    String

    The reserved field.

    multiattach

    Boolean

    Whether the disk is shareable.

    • true: indicates a shared disk.

    • false: indicates a non-shared disk.

    storage_cluster_id

    String

    The reserved field.

  • Parameters in the links field

    Parameter

    Type

    Description

    href

    String

    The corresponding shortcut link.

    rel

    String

    The shortcut link marker name.

  • Parameters in the attachments field

    Parameter

    Type

    Description

    server_id

    String

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

    attachment_id

    String

    The ID of the attachment information.

    attached_at

    String

    The time when the disk was attached.

    host_name

    String

    The name of the physical host housing the cloud server to which the disk is attached.

    volume_id

    String

    The disk ID.

    device

    String

    The device name.

    id

    String

    The ID of the attached disk.

  • Parameters in the metadata field

    Parameter

    Type

    Description

    __system__encrypted

    String

    The encryption field in metadata.

    • 0: indicates a non-encrypted disk.

    • 1: indicates an encrypted disk.

    • If this parameter does not appear, the disk is not encrypted.

    __system__cmkid

    String

    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

    The parameter that describes the disk device type in metadata. The value can be true or false.

    • true indicates the SCSI device type, which allows ECS OSs to directly access the underlying storage media and support SCSI reservations commands.

    • false indicates the VBD device type (the default type), which supports only simple SCSI read/write commands.

    • If this parameter does not appear, the disk device type is VBD.

    full_clone

    String

    The clone method. If the disk is created from a snapshot, value 0 indicates the linked cloning method.

  • Parameters in the error field

    Parameter

    Type

    Description

    message

    String

    The error message returned if an error occurs.

    code

    String

    The error code returned if 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": "az-dc-1",
            "os-vol-host-attr:host": "az-dc-1#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": {},
            "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"
        }
    }
    

Status Codes

  • Normal

    200

Error Codes

For details, see Error Codes.