Updated on 2022-02-22 GMT+08:00

Querying Details About a Disk

Function

This API is used to query details about a disk.

URI

  • URI format

    GET /v2/{project_id}/os-vendor-volumes/{volume_id}

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    volume_id

    Yes

    Specifies the disk ID.

Request

  • Example request
    GET https://{endpoint}/v2/{project_id}/os-vendor-volumes/b104b8db-170d-441b-897a-3c8ba9c5a214

Response

  • Parameter description

    Parameter

    Type

    Description

    volume

    Object

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

    error

    Object

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

    links

    Array of objects

    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 of objects

    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.

    Currently, this field is not supported by EVS.

    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. The tenant ID is actually the project ID.

    volume_image_metadata

    Object

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

    volume_type

    String

    Specifies the disk type.

    Currently, only SSD and SAS are supported.
    • SSD: specifies the ultra-high I/O disk type.
    • SAS: specifies the high I/O disk type.

    size

    Integer

    Specifies the disk size, in GB.

    bootable

    String

    Specifies whether the disk is bootable.
    • true: specifies a bootable disk.
    • false: specifies a non-bootable disk.

    metadata

    Object

    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.

    os-vol-host-attr:host

    String

    Reserved field

    encrypted

    Boolean

    Currently, this field is not supported by EVS.

    updated_at

    String

    Specifies the time when the disk was updated.

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

    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

    String

    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.
    • true: specifies a shared disk.
    • false: specifies a non-shared disk.

    dedicated_storage_id

    String

    Specifies the ID of the DSS storage pool accommodating the disk.

    dedicated_storage_name

    String

    Specifies the name of the DSS storage pool accommodating the disk.

    wwn

    String

    Specifies the unique identifier used when attaching the disk.

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

    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

    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.

  • 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": "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": "available", 
            "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, 
            "service_type": "EVS", 
            "dedicated_storage_id": null, 
            "dedicated_storage_name": null, 
            "wwn": " 688860300000d136fa16f48f05992360"
        }
    }

    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.