查询云硬盘信息

最近更新时间:2018-06-14 11:13:19

1. 接口描述

本接口(DescribeCbsStorages)用于查询云硬盘的详细信息。可根据云硬盘ID、云硬盘状态,云硬盘类型等对结果进行过滤。对于过滤条件,不同条件之间为与(AND)的关系,如果不传入则不以此条件过滤。

接口请求域名:cbs.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。

参数名称 必选 类型 描述
diskType String 云盘类型。取值范围:
  • root:表示系统盘
  • data:表示数据盘
  • payMode String 付费方式。取值范围:
  • prePay:表示预付费,即包年包月
  • postPay:表示后付费,即按量计费
  • portable Int 是否是弹性云盘。取值范围:
  • 1:表示弹性云盘
  • 0:表示非弹性云盘
  • projectId Int 项目ID。通过DescribeProject(查询项目列表)接口查询可用项目及其ID。
    storageIds Array[String] 按一个或者多个云硬盘ID过滤
    storageType String 云硬盘介质类型。取值范围:
  • cloudBasic:表示普通云硬盘
  • cloudPremium:表示高性能云硬盘
  • cloudSSD:表示SSD云硬盘
  • storageStatus Array[String] 按一个或者多个云盘状态过滤,取值范围:
  • normal:正常
  • toRecycle:待销毁
  • attaching:挂载中
  • detaching:解挂中
  • snapshotCreating:快照创建中
  • rollback:回滚中
  • expanding:扩容中
  • uInstanceIds Array[String] 云服务器实例ID,可根据此参数查询挂载在指定云服务器下的云硬盘
    zone string 云盘所处的可用区,取值详见地域和可用区
    offset Int 偏移量,默认为0
    limit Int 返回磁盘数量。默认值为20, 最大值为100

    3. 输出参数

    参数名称 类型 描述
    code Int 公共错误码,0表示成功,其他值表示失败。详见错误码页面
    message String 错误信息,详见错误码页面
    storageSet Array[Object] 云硬盘信息数组,见下表
    totalCount Int 返回的云硬盘数量

    storageSet结构

    参数名称 类型 描述
    attached Int 是否已挂载。0表示未挂载,1表示已挂载
    createTime String 创建时间
    deadlineTime String 云硬盘到期时间。
    diskType String 硬盘类型。取值范围:
  • root:表示系统盘
  • data:表示数据盘
  • payMode String 付费方式。取值范围:
  • prePay:表示预付费,即包年包月
  • postPay:表示后付费,即按量计费
  • portable Int 是否是弹性云盘。取值范围:
  • 1:表示弹性云盘
  • 0:表示非弹性云盘
  • projectId Int 项目ID
    snapshotAbility Int 是否具备创建快照的能力。取值范围:
  • 0:表示不具备
  • 1:表示具备
  • storageId String 云硬盘ID
    storageName String 云硬盘名称
    storageSize Int 云硬盘大小,单位为GB
    storageStatus String 云硬盘状态。取值范围:
  • normal:正常
  • toRecycle:待销毁
  • attaching:挂载中
  • detaching:解挂中
  • snapshotCreating:快照创建中
  • rollback:回滚中
  • expanding:扩容中
  • storageType String 云硬盘类型。取值范围:
  • cloudBasic:普通云硬盘
  • cloudPremium:高性能云硬盘
  • cloudSSD:SSD云硬盘
  • uInstanceId String 云硬盘挂载的云服务器 ID
    zone string 云硬盘所处的可用区,取值详见地域和可用区

    4. 错误码表

    以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见云硬盘错误码

    错误代码 英文描述 错误描述
    9003 InvalidParameter 参数错误

    5. 示例

    输入

    https://cbs.api.qcloud.com/v2/index.php?
    <公共请求参数>
    &Action=DescribeCbsStorages
    &storageIds.0=disk-5h58gfba
    &storageIds.1=disk-m0js2w9s
    &storageStatus.0=normal
    

    输出

    {
        "code": 0,
        "message": "",
        "totalCount": 2,
        "storageSet": [
            {
                "storageId": "disk-5h58gfba",
                "uInstanceId": null,
                "storageName": "ssss",
                "projectId": 0,
                "diskType": "data",
                "storageType": "cloudBasic",
                "storageStatus": "normal",
                "zoneId": 100002,
                "zone": "ap-guangzhou-2",
                "createTime": "2015-04-30 10:28:28",
                "storageSize": 10,
                "snapshotAbility": 0,
                "payMode": "prePay",
                "portable": 1,
                "attached": 0,
                "deadlineTime":2017-04-30 10:28:28,
            },
            {
                "storageId": "disk-m0js2w9s",
                "uInstanceId": null,
                "storageName": "baba",
                "projectId": 0,
                "diskType": "data",
                "storageType": "cloudBasic",
                "storageStatus": "normal",
                "zoneId": 100003,
                "zone": "ap-guangzhou-3",
                "createTime": "2015-05-02 10:19:54",
                "storageSize": 10,
                "snapshotAbility": 0,
                "payMode": "prePay",
                "portable": 0,
                "attached": 1,
                "deadlineTime":2016-05-02 10:19:54,
            }
        ]
    }
    

    如果有其他疑问,你也可以通过提问形式与我们联系探讨