API文档>块存储>云硬盘相关>云硬盘列表
  • 接口说明
  • 接口调试

云硬盘列表

更新时间：2019-06-04 14:15:54

描述

查询云硬盘信息，可查询一条或多条记录，可根据名称等多个查询条件查询。

请求参数

参数名参数类型是否必填参数说明
Action String 是

操作方法
Region String 是

机房标识，取值参见地域列表
InstanceName String 否

根据云主机名字查询
DueStartTime String 否

到期时间查询---开始时间段
DueEndTime String 否

到期时间查询--结束时间段
Offset Integer 否

记录偏移量，不指定取 0
Count Integer 否

记录数量，不指定为全部
Id.N String 否

标识符集合，支持批量，N为自然数，格式：&Id.0=xxx&Id.1=xxx等
Name String 否

名称
PayType String 否

支付类型，取值范围：

  • PREPAID 包年包月
  • PROBATION 试用
ProductType String 否

云硬盘类型
Status String 否

根据云硬盘状态查询，取值范围：

  • CREATING ： 创建中
  • AVAILABLE ： 待挂载
  • DETACHING ： 卸载中
  • ATTACHING ： 挂载中
  • ATTACHED ： 已挂载
  • DELETING ： 删除中
  • ERROR ： 异常
  • DELETE_ERROR ： 删除异常
  • DELETED ： 已删除
  • MIGRATING ： 变更中
  • RESIZING ： 扩容中
ProductStatus String 否

根据产品状态查询，取值范围：

  • NORMAL-正常
  • OVERTIMER-过期
  • ARREARAGE-欠费

返回参数

名称 类型 说明
Action String 执行的操作
TaskId String 请求标识
TotalCount Integer 过滤条件下总共记录数
VolumeSet VolumeItemType 由VolumeItemType组成的数组格式，返回云硬盘信息

VolumeItemType节点

云硬盘信息的数据类型

名称 类型 说明
Id String 标识符
Uuid String 卷的Uuid,只有在管理员查询时返回
Name String 名称
Description String 描述信息
Type String 卷的类型:normal-普通磁盘,ssd-固态硬盘,sata-sata；
BackType String 后端类型:rbd-普通磁盘,ssd-固态硬盘,sata-sata；
Size Integer 卷的容量，单位 GiB
Status String 状态，CREATING
ProductStatus String 产品状态，正常：NORMAL 过期：OVERTIMER 欠费：ARREARAGE
SnapshotId String 创建卷的快照标识
CreateTime DateTime 创建时间
DueTime DateTime 到期时间
CloseTime DateTime 关闭时间（删除时间）
PayType String 支付类型 ONDEMAND：按量付费；PREPAID：包年包月；PROBATION 试用。
AttachmentSet AttachmentSetItemType 由AttachmentSetItemType组成的数组格式，返回卷当前挂载信息
ImageId String 创建卷的镜像标识
SnapshotCount Integer 卷下面的快照个数
Deleted Boolean 管理员用，是否在回收站 true false
DelType String 删除原因，ADMIN-管理员删除，CUSTOMER-用户主动删除，INSUFFICIENT-欠费删除（系统触发），EXPIRETIME-过期删除（系统触发）
DeletedTime String 管理员用，放入回收站时间
OwnerId String 所属用户Id
ProductModelId String 产品型号ID

AttachmentSetItemType节点

卷当前挂载信息的数据类型

名称 类型 说明
AttachTime DateTime 挂载时间
DeleteOnTermination Boolean 删除虚拟机时是否删除卷，默认为 false
Index Integer 位置，0 表示系统盘，其它为数据盘
Status String 挂载状态：attaching，attached，detaching，detached
VolumeId String 被挂载的卷
InstanceId String 挂载的虚拟机
CheckOffLine Boolean 挂载的虚拟机的操作系统类型，windows返回true，linux返回false

请求示例

https://api.chinac.com/v2/?Action=DescribeVolumes
&Name=cec170508yC3Zdata1
&公共参数

返回示例

{
    "code": 10000,
    "message": "",
    "data": {
        "TaskId":"1sv9i20170509171624597",
        "Action":"DescribeVolumes",
        "TotalCount":1,
        "VolumeSet":[{
            "Id":"vv39ih48dnl9l",
            "Name":"cec170508yC3Zdata1",
            "Description":null,
            "Type":"normal",
            "BackType":"rbd",
            "Size":20,
            "Status":"ATTACHED",
            "ProductStatus":"NORMAL",
            "CreateTime":"2017-05-08T13:23:21 +0800",
            "DueTime":"2017-05-11T13:23:21 +0800",
            "CloseTime":"2017-05-11T14:23:21 +0800",
            "PayType":"PROBATION",
            "AttachmentSet": [{
                "AttachTime":"2017-05-08T13:23:27+0800",
                "DeleteOnTermination":false,
                "Index":1,
                "Status":"ATTACHED",
                "VolumeId":"v-v39ih48dnl9l",
                "InstanceId":"i-q09ih48dm981n",
                "CheckOffLine":null
            }],
            "ImageId":null,
            "SnapshotId":null,
            "SnapshotCount":0,
            "Uuid":"57864f10-e03e-4b6a-b3c4-f8d4be11c741",
            "DelType":null,
            "ProductModelId":"402012",
            "UserId":"18888888",
            "IdLong":"v-v39ih48dnl9l-57864f10-e03e-4b6a-b3c4-f8d4be11c741"
        }]
    }
}
*
*