文档首页 > > API参考> API v3> 云硬盘> 查询所有云硬盘详情

查询所有云硬盘详情

分享
更新时间: 2019/12/18 GMT+08:00

功能介绍

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

URI

  • URI格式

    GET /v3/{project_id}/os-vendor-volumes/detail

  • 参数说明

    参数

    是否必选

    描述

    project_id

    项目ID。

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

  • Request filter参数说明

    参数

    参数类型

    是否必选

    描述

    marker

    String

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

    name

    String

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

    limit

    Integer

    返回结果个数限制。

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

    sort_key

    String

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

    sort_dir

    String

    降序或升序,默认为“desc”。

    • desc表示降序。
    • asc表示升序。

    offset

    Integer

    偏移量(偏移量为一个大于0小于磁盘总个数的整数,表示查询该偏移量后面的所有的磁盘)。

    status

    String

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

    metadata

    String

    云硬盘元数据。

    availability_zone

    String

    云硬盘所属的AZ信息。

    multiattach

    Boolean

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

    service_type

    String

    服务类型,仅支持EVS、DSS、DESS。

    dedicated_storage_id

    String

    专属存储池ID,可过滤出该专属存储池下的所有云硬盘,必须精确匹配。

    dedicated_storage_name

    String

    专属存储池的名字,可过滤出该专属存储池下的所有云硬盘,支持模糊匹配。

    volume_type_id

    String

    云硬盘类型id。

    通过查询云硬盘类型列表可以查到,即volume_types参数说明表格中的“id”。

    id

    String

    云硬盘id。

    ids

    Array of strings

    云硬盘id列表,格式为ids=['id1','id2',...,'idx'],返回“ids”中有效id的云硬盘详情,无效的id会被忽略。

    支持查询最多60个id对应的云硬盘详情。

    如果“id”和“ids”查询参数同时存在,“id”会被忽略。

请求消息

以查询状态为available的共享云硬盘为例。
  • 请求样例:
    GET https://{endpoint}/v3/{project_id}/os-vendor-volumes/detail?status=available&multiattach=true

响应消息

  • 响应参数

    参数

    参数类型

    描述

    volumes

    Array of objects

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

    volumes_links

    Array of objects

    云硬盘列表查询位置标记。如果本次查询只返回部分列表信息时,会返回查询到的当前磁盘mark标记的url,可以继续使用这个url查询剩余列表信息,请参见•links参数说明

    count

    Integer

    查询到的云硬盘总数量,不受分页影响。

    error

    String

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

  • volumes参数说明

    参数

    参数类型

    描述

    id

    String

    云硬盘ID。

    links

    Array of objects

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

    name

    String

    云硬盘名称。

    status

    String

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

    attachments

    Array of objects

    挂载信息,请参见•attachments参数说明

    availability_zone

    String

    云硬盘所属的AZ信息。

    os-vol-host-attr:host

    String

    预留属性。

    source_volid

    String

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

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

    snapshot_id

    String

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

    description

    String

    描述。

    created_at

    String

    云硬盘创建时间。

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

    volume_type

    String

    云硬盘类型。

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

    os-vol-tenant-attr:tenant_id

    String

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

    size

    Integer

    云硬盘大小,单位为GB。

    metadata

    Object

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

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

    如果元数据中不包含__system__encrypted字段,云硬盘默认为不加密。

    os-vol-mig-status-attr:migstat

    String

    预留属性。

    os-vol-mig-status-attr:name_id

    String

    预留属性。

    os-volume-replication:extended_status

    String

    预留属性。

    encrypted

    Boolean

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

    replication_status

    String

    预留属性。

    user_id

    String

    预留属性。

    consistencygroup_id

    String

    预留属性。

    bootable

    String

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

    updated_at

    String

    云硬盘更新时间。

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

    shareable

    Boolean

    是否为共享云硬盘。

    说明:

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

    multiattach

    Boolean

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

    volume_image_metadata

    Object

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

    说明:

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

    service_type

    String

    服务类型,结果为EVS、DSS、DESS。

    dedicated_storage_id

    String

    云硬盘所属的专属存储池ID。

    dedicated_storage_name

    String

    云硬盘所属的专属存储池的名称。

    tags

    Object

    云硬盘的标签。

    如果云硬盘有标签,则会有该字段,否则该字段为空。

    wwn

    String

    云硬盘挂载时的唯一标识。

    enterprise_project_id

    String

    云硬盘上绑定的企业项目ID。

    说明:

    关于企业项目ID的获取及企业项目特性的详细信息,请参见企业管理用户指南

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

    参数

    参数类型

    描述

    __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克隆方式。

  • error参数说明

    参数

    参数类型

    描述

    message

    String

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

    code

    String

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

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

  • 响应样例
    {
        "count": 1, 
        "volumes": [
            {
                "attachments": [ ], 
                "availability_zone": "az-dc-1", 
                "bootable": "false", 
                "consistencygroup_id": null, 
                "created_at": "2016-05-25T02:42:10.856332", 
                "description": null, 
                "encrypted": false, 
                "id": "b104b8db-170d-441b-897a-3c8ba9c5a214", 
                "links": [
                    {
                        "href": "https://volume.localdomain.com:8776/v3/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214", 
                        "rel": "self"
                    }, 
                    {
                        "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214", 
                        "rel": "bookmark"
                    }
                ], 
                "metadata": {}, 
                "name": "zjb_u25_test", 
                "os-vol-host-attr:host": "pod01.xxx#SATA", 
                "volume_image_metadata": { }, 
                "os-vol-mig-status-attr:migstat": null, 
                "os-vol-mig-status-attr:name_id": null, 
                "os-vol-tenant-attr:tenant_id": "dd14c6ac581f40059e27f5320b60bf2f", 
                "os-volume-replication:extended_status": null, 
                "replication_status": "disabled", 
                "multiattach": false, 
                "size": 1, 
                "snapshot_id": null, 
                "source_volid": null, 
                "status": "available", 
                "updated_at": "2016-05-25T02:42:22.341984", 
                "user_id": "b0524e8342084ef5b74f158f78fc3049", 
                "volume_type": "SATA", 
                "service_type": "EVS", 
                "dedicated_storage_id": null, 
                "dedicated_storage_name": null, 
                "wwn": " 688860300000d136fa16f48f05992360"
            }
        ], 
        "volumes_links": [
            {
                "href": "https://volume.localdomain.com:8776/v3/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214", 
                "rel": "next"
            }
        ]
    }
    

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

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

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

状态码

  • 正常

    200

错误码

请参考错误码说明

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区