查询云硬盘接口

最近更新时间:2019-04-29 10:40:51

1. 接口描述

本接口(DescribeVolumes)用于查询云硬盘详细信息。

2. 请求参数

名称 类型 是否必需 描述
VolumeId.N String 硬盘ID,传参方式请参照示例;长度36个字符,包括字母、数字、-不传此参数,则查询该用户下所有硬盘信息。最多传入100个,N为1~100
VolumeCategory String 硬盘分类,两种,有效值是系统盘(system)或者数据盘(data)
VolumeStatus String 硬盘状态,八种creating、available、attaching、inuse、detaching、extending、deleting、error
VolumeType String 磁盘类型,四种,SSD2.0/SSD3.0/EHDD/SATA2.0
VolumeCreateDate String 硬盘创建日期,格式:yyyy-MM-dd,可查出当日创建硬盘信息

3. 返回参数

名称 类型 描述
RequestId String 唯一请求ID,每次请求都会返回
Volumes List 硬盘相关信息列表,若无信息则不返回
VolumeId String 磁盘ID
VolumeName String 硬盘名称
VolumeDesc String 硬盘描述信息
Size String 硬盘大小,单位:GB
VolumeStatus String 硬盘状态,八种creating、available、attaching、inuse、detaching、extending、deleting、error
VolumeType String 硬盘类型,三种,SSD2.0/SSD3.0/SATA2.0
VolumeCategory String 硬盘分类,两种,有效值是系统盘(system)或者数据盘(data)
InstanceId String 硬盘状态为in-use时,该硬盘关联的实例ID(主机ID)
CreateTime String 硬盘创建时间
AvailabilityZone String 硬盘所在可用区
ProjectId Integer 硬盘所属项目组id
DeleteWithInstance Boolean 待挂载的云硬盘是否随云主机删除。取值范围:
true:删除云主机时,该云硬盘随云主机一起删除
false:删除云主机时,保留该云硬盘,仅卸载,不随云主机一起释放
Attachment List 硬盘的当前挂载信息
InstanceId String 硬盘挂载过的实例ID(主机ID)
MountPoint String 硬盘挂载点

4. 示例

输入参数

http://ebs.api.ksyun.com/
?Action=DescribeVolumes
&VolumeType=SSD
&VolumeStatus=in-use
&VolumeCategory=data
&VolumeId.1=d57e9091-e0f7-407d-a153-926314eb2f9f
&VolumeId.2=dfcfd019-f08c-453d-997b-52913ab88ad3

输出参数

{
  "RequestId": "6e2682a1-5968-42f5-80e5-284aae218df0",
  "Volumes": [
    {
      "VolumeId": "d57e9091-e0f7-407d-a153-926314eb2f9f",
      "VolumeName": "QF-ebs-01",
      "VolumeDesc": "Qf-ebs-desc",
      "Size": 20,
      "VolumeStatus": "available",
      "VolumeType": "SSD",
      "VolumeCategory": "data",
      "CreateTime": "2016-12-06 10:38:32"
    },
    {
      "VolumeId": "dfcfd019-f08c-453d-997b-52913ab88ad3",
      "VolumeName": "zhangyun-ebs",
      "Size": 20,
      "VolumeStatus": "in-use",
      "VolumeType": "SSD",
      "VolumeCategory": "data",
      "InstanceId": "af4868ec-8d5e-46a4-83fb-4a33af05da74",
      "CreateTime": "2016-12-05 20:00:03",
      "Attachment": [
        {
          "InstanceId": "af4868ec-8d5e-46a4-83fb-4a33af05da74",
          "MountPoint": "/dev/vdcl"
        }
      ]
    }
  ]
}

金山云,开启您的云计算之旅

立即注册