计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

查询所有云硬盘详情

更新时间:2023-07-24 GMT+08:00

功能介绍

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

调试

您可以在中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

  • URI格式

    GET /v2/{project_id}/cloudvolumes/detail

  • 参数说明

    参数

    是否必选

    描述

    project_id

    项目ID。

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

  • Request Query参数

    参数

    是否必选

    参数类型

    描述

    availability_zone

    String

    可用区信息。

    dedicated_storage_id

    String

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

    dedicated_storage_name

    String

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

    enterprise_project_id

    String

    指定企业项目id进行过滤。 传入“all_granted_eps”,代表查询权限范围内的所有企业项目下的云硬盘。

    说明:

    id

    String

    云硬盘ID。

    ids

    String

    云硬盘id列表,格式为ids=['id1','id2',...,'idx'],返回“ids”中有效id的云硬盘详情,无效的id会被忽略。 支持查询最多60个id对应的云硬盘详情。 如果“id”和“ids”查询参数同时存在,“id”会被忽略。

    limit

    Integer

    返回结果个数限制。默认值为1000。

    最小值:1

    最大值:1000

    缺省值:1000

    marker

    String

    通过云硬盘ID进行分页查询,默认为查询第一页数据。 marker={{id}}表示查询该云硬盘id后的所有云硬盘的信息(查询结果不包含该id的云硬盘信息)。

    metadata

    String

    云硬盘元数据。

    multiattach

    Boolean

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

    name

    String

    磁盘名称。

    offset

    Integer

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

    server_id

    String

    云服务器id。

    service_type

    String

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

    sort_dir

    String

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

    sort_key

    String

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

    status

    String

    云硬盘状态,取值可参考云硬盘状态

    volume_type_id

    String

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

请求消息

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

响应消息

  • 响应参数

    参数

    参数类型

    描述

    volumes

    Array of objects

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

    count

    Integer

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

    volumes_links

    Array of Link objects

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

    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信息。

    os-vol-host-attr:host

    String

    预留属性。

    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。

    consistencygroup_id

    String

    预留属性。

    bootable

    String

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

    metadata

    Map<String,Object>

    云硬盘的元数据。 __system__cmkid metadata中的加密cmkid字段,与__system__encrypted配合表示需要加密,cmkid长度固定为36个字节。

    说明:

    __system__encrypted metadata中的表示加密功能的字段,0代表不加密,1代表加密。 不指定该字段时,云硬盘的加密属性与数据源保持一致,如果不是从数据源创建的场景,则默认不加密。

    full_clone 从快照创建云硬盘时的创建方式。

    • 0表示使用链接克隆方式。
    • 1表示使用全量克隆方式。

    hw:passthrough

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

    updated_at

    String

    云硬盘更新时间。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

    encrypted

    Boolean

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

    replication_status

    String

    预留属性。

    os-vol-mig-status-attr:migstat

    String

    预留属性。

    os-vol-host-attr:host

    String

    预留属性。

    os-vol-mig-status-attr:name_id

    String

    预留属性。

    os-volume-replication:extended_status

    String

    预留属性。

    shareable

    String

    是否为共享云硬盘。true为共享盘,false为普通云硬盘。 该字段已经废弃,请使用multiattach。

    user_id

    String

    预留属性。

    service_type

    String

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

    dedicated_storage_id

    String

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

    dedicated_storage_name

    String

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

    tags

    Map<String,String>

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

    wwn

    String

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

    multiattach

    Boolean

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

    enterprise_project_id

    String

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

    serial_number

    String

    云硬盘序列号。 只有SCSI类型的非双活卷才会返回该字段,用于与虚拟机中的盘做对应关系。

  • 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。

  • error参数说明

    参数

    参数类型

    描述

    message

    String

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

    code

    String

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

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

  • 响应样例
    {
      "count" : 1,
      "volumes" : [ {
        "attachments" : [ ],
        "availability_zone" : "az-dc-1",
        "bootable" : "false",
        "created_at" : "2016-05-25T02:42:10.856332",
        "description" : null,
        "id" : "b104b8db-170d-441b-897a-3c8ba9c5a214",
        "links" : [ {
          "href" : "https://volume.localdomain.com:8776/v2/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,
        "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/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214",
        "rel" : "next"
      } ]
    }

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

状态码

  • 正常

    200

错误码

请参考错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容