更新时间:2022-02-22 GMT+08:00

查询所有云硬盘详情

功能介绍

查询所有云硬盘的详细信息。

URI

  • URI格式

    GET /v2/{project_id}/cloudvolumes/detail

  • 参数说明

    参数

    是否必选

    描述

    project_id

    项目ID。

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

  • Request filter参数

    参数

    参数类型

    是否必选

    描述

    marker

    String

    分页查询的起始资源id,取值为上一页最后一条查询记录的资源id。

    name

    String

    磁盘名称。最大支持255个字节。

    status

    String

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

    limit

    Integer

    返回结果个数限制。

    最小值1,最大值1000,默认为1000。返回的结果中记录数不超过limit值。

    availability_zone

    String

    AZ信息。

    sort_key

    String

    返回结果按该关键字排序,支持id,status,size,created_at等关键字,默认为“created_at”。

    sort_dir

    String

    返回结果按照降序或升序排列,默认为“desc”。
    • 降序:desc
    • 升序:asc

请求消息

以查询状态为available的云硬盘为例。
  • 请求样例:
    GET https://{endpoint}/v2/{project_id}/cloudvolumes/detail?status=available

响应消息

  • 响应参数

    参数

    参数类型

    描述

    volumes

    Array of objects

    查询请求返回的云硬盘列表,请参见•volumes响应参数

    error

    Object

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

  • volumes参数说明

    参数

    参数类型

    描述

    id

    String

    云硬盘的ID。

    links

    Array of objects

    云硬盘uri自描述信息,请参见•links参数说明

    name

    String

    云硬盘名称。

    status

    String

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

    attachments

    Array of objects

    云硬盘的挂载信息,请参见•attachments参数说明

    availability_zone

    String

    云硬盘所属的AZ信息。

    source_volid

    String

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

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

    snapshot_id

    String

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

    description

    String

    云硬盘描述。

    os-vol-tenant-attr:tenant_id

    String

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

    volume_image_metadata

    Object

    云硬盘镜像的元数据。

    说明:

    关于“volume_image_metadata”字段的详细说明,具体请参见“镜像服务API参考”中的“查询镜像详情(OpenStack原生)”章节。

    created_at

    String

    云硬盘创建时间。

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

    volume_type

    String

    云硬盘类型。

    目前支持“SSD”和“SAS”。
    • “SSD”为超高IO云硬盘
    • “SAS”为高IO云硬盘

    size

    Integer

    云硬盘大小,单位为GB。

    bootable

    String

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

    metadata

    Object

    云硬盘的元数据,请参见•metadata参数说明

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

    os-vol-host-attr:host

    String

    预留属性。

    shareable

    String

    是否为共享云硬盘。

    说明:

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

    multiattach

    Boolean

    是否为共享云硬盘。
    • true:表示为共享云硬盘。
    • false:表示为非共享云硬盘。
  • links参数说明

    参数

    参数类型

    描述

    href

    String

    对应的快捷链接。

    rel

    String

    快捷链接标记名称。

  • 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参数说明

    参数

    参数类型

    描述

    full_clone

    String

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

  • error参数说明

    参数

    参数类型

    描述

    message

    String

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

    code

    String

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

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

  • 响应样例
    {
        "volumes": [
            {
                "id": "c6ccc84e-feff-4114-ad83-42a11c0434e2", 
                "links": [
                    {
                        "href": "https://volume.az0.dc1.domainname.com/v2/9e179fd535e44f19a9dabb36deadf47e/volumes/c6ccc84e-feff-4114-ad83-42a11c0434e2", 
                        "rel": "self"
                    }, 
                    {
                        "href": "https://volume.az0.dc1.domainname.com/9e179fd535e44f19a9dabb36deadf47e/volumes/c6ccc84e-feff-4114-ad83-42a11c0434e2", 
                        "rel": "bookmark"
                    }
                ], 
                "name": "test_volume", 
                "status": "available", 
                "attachments": [ ], 
                "description": null, 
                "size": 100, 
                "metadata": null, 
                "bootable": "false", 
                "availability_zone": "az-dc-1", 
                "os-vol-host-attr:host": "az-dc-1#sata", 
                "source_volid": null, 
                "snapshot_id": null, 
                "created_at": "2015-09-17T06:37:16.275659", 
                "volume_type": "SATA", 
                "os-vol-tenant-attr:tenant_id": "9e179fd535e44f19a9dabb36deadf47e", 
                "volume_image_metadata": null
            }, 
            {
                "id": "a05d9342-bf27-44a6-8ab8-33afc7545d19", 
                "links": [
                    {
                        "href": "https://volume.az0.dc1.domainname.com/v2/9e179fd535e44f19a9dabb36deadf47e/volumes/a05d9342-bf27-44a6-8ab8-33afc7545d19", 
                        "rel": "self"
                    }, 
                    {
                        "href": "https://volume.az0.dc1.domainname.com/9e179fd535e44f19a9dabb36deadf47e/volumes/a05d9342-bf27-44a6-8ab8-33afc7545d19", 
                        "rel": "bookmark"
                    }
                ], 
                "name": "test_volume", 
                "status": "available", 
                "attachments": [ ], 
                "description": null, 
                "size": 100, 
                "metadata": null, 
                "bootable": "false", 
                "availability_zone": "az-dc-1", 
                "os-vol-host-attr:host": "az-dc-1#sata", 
                "source_volid": null, 
                "snapshot_id": null, 
                "created_at": "2015-09-17T06:37:16.192556", 
                "volume_type": "SATA", 
                "os-vol-tenant-attr:tenant_id": "9e179fd535e44f19a9dabb36deadf47e", 
                "volume_image_metadata": null
            }
        ]
    }

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

状态码

  • 正常

    200

错误码

请参考错误码说明