更新时间:2022-01-22 GMT+08:00
分享

查询单个云硬盘详情(废弃)

功能介绍

查询单个云硬盘的详细信息。

该接口已废弃,请使用性能更佳的接口,具体请参见查询单个云硬盘详情

URI

  • URI格式

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

  • 参数说明

    名称

    是否必选

    描述

    project_id

    项目ID。

    获取方法请参见获取项目ID

    volume_id

    云硬盘ID。

请求消息

  • 请求样例:
    GET https://{endpoint}/v1/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214

响应消息

  • 响应参数

    参数

    参数类型

    描述

    volume

    Object

    云硬盘信息,请参见•volume参数说明

    error

    Object

    出现错误时,返回的错误信息,具体请参见•error参数说明

  • volume参数说明

    参数

    参数类型

    描述

    id

    String

    云硬盘的ID。

    display_name

    String

    云硬盘名称。

    status

    String

    云硬盘状态,具体请参见云硬盘状态

    attachments

    list

    挂载信息

    availability_zone

    String

    云硬盘所属的AZ信息

    os-vol-host-attr:host

    String

    预留属性。

    source_volid

    String

    源云硬盘ID,如果是从源云硬盘创建,则有值

    当前云硬盘服务不支持该字段。

    snapshot_id

    String

    快照ID,如果是从快照创建,则有值

    display_description

    String

    云硬盘描述。

    created_at

    String

    云硬盘创建时间

    时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

    volume_type

    String

    云硬盘类型。

    目前支持“SSD”,“GPSSD”和“SAS”三种。
    • “SSD”为超高IO云硬盘
    • “GPSSD”为通用型SSD云硬盘
    • “SAS”为高IO云硬盘

    os-vol-tenant-attr:tenant_id

    String

    云硬盘所属的租户ID。租户ID就是项目ID。

    size

    Integer

    云硬盘大小,单位为GB。

    metadata

    Object

    云硬盘的元数据。

    如果元数据中不包含hw:passthrough字段,云硬盘默认为VBD类型。

    os-vol-mig-status-attr:migstat

    String

    预留属性。

    os-vol-mig-status-attr:name_id

    String

    预留属性。

    os-volume-replication:extended_status

    String

    预留属性。

    encrypted

    Boolean

    当前云硬盘服务不支持该字段

    bootable

    String

    是否为启动云硬盘。
    • true:表示为启动云硬盘。
    • false:表示为非启动云硬盘。

    shareable

    String

    是否为可共享云硬盘

    说明:

    该字段已经废弃,请使用multiattach。

    multiattach

    Boolean

    是否为共享云硬盘。
    • true:表示为共享云硬盘。
    • false:表示为非共享云硬盘。

    volume_image_metadata

    Object

    如果云硬盘是从镜像创建的则会有该字段,否则该字段为空。

    说明:

    关于“volume_image_metadata”字段的详细说明,具体请参见查询镜像详情(OpenStack原生)

  • attachments参数说明

    参数

    参数类型

    描述

    server_id

    String

    云硬盘挂载到的云服务器的ID。

    attachment_id

    String

    挂载信息对应的ID。

    attached_at

    String

    挂载的时间信息。

    时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

    host_name

    String

    云硬盘挂载到的云服务器对应的物理主机的名称。

    volume_id

    String

    云硬盘ID。

    device

    String

    挂载点。

    id

    String

    挂载的资源ID。

  • metadata参数说明

    参数

    参数类型

    描述

    __system__encrypted

    String

    metadata中的表示加密功能的字段。
    • 0代表不加密。
    • 1代表加密。
    • 该字段不存在时,云硬盘默认为不加密。

    __system__cmkid

    String

    metadata中的加密cmkid字段,与__system__encrypted配合表示需要加密,cmkid长度固定为36个字节。

    hw:passthrough

    String

    metadata中的表示云硬盘设备类型的字段。
    • true表示云硬盘的设备类型为SCSI类型,即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。
    • false表示云硬盘的设备类型为VBD类型,即为默认类型,VBD只能支持简单的SCSI读写命令。
    • 该字段不存在时,云硬盘默认为VBD类型。

    full_clone

    String

    从快照创建云硬盘时,字段的值为0表示使用link克隆方式。

    orderID

    String

    metadata中的表示云硬盘计费类型的字段。

    当该字段有值时,表示该云硬盘的计费类型为包周期计费,否则计费类型为按需计费。

  • error参数说明

    参数

    参数类型

    描述

    message

    String

    出现错误时,返回的错误消息。

    code

    String

    出现错误时,返回的错误码。

    错误码和其对应的含义请参考错误码

  • 响应样例
    {
        "volume": {
            "attachments": [],
            "availability_zone": "az-dc-1",
            "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
        }
    }

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

    其中error是泛指的错误,有badrequest、itemNotFound等,如报错:

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

状态码

  • 正常

    200

错误码

请参考错误码

分享:

    相关文档

    相关产品

关闭导读