全部文档
当前文档
最近更新时间：2024-08-09 15:21:59
本接口（DescribeVolumes）用于查询云硬盘详细信息。
名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
VolumeId.N | String | 否 | 云硬盘ID，传参方式请参照示例；长度36个字符，包括字母、数字、-不传此参数，则查询该用户下所有硬盘信息。最多传入100个，N为1~100 |
VolumeCategory | String | 否 | 云硬盘作用分类两种：有效值是系统盘（system）或者数据盘（data） |
VolumeStatus | String | 否 | 云硬盘运行状态十种creating（创建中）、available（待挂载）、attaching（挂载中）、inuse（使用中）、detaching（卸载中）、extending（扩容中）、deleting（删除中）、error（错误）、recycling（回收中）、type_changing（类型变更中） |
VolumeType | String | 否 | 云硬盘类型：ESSD_PL0/ESSD_PL1/ESSD_PL2/ESSD_PL3/SSD3.0/EHDD |
VolumeCreateDate | String | 否 | 云硬盘创建日期，格式：yyyy-MM-dd，可查出当日创建硬盘信息 |
Marker | Integer | 否 | 分页标识，单次调用未返回全部实例时，标记下次调用的返回值的起点，默认值是0 |
MaxResults | Integer | 否 | 单次调用所返回的最大实例数目，取值为10~1000，超过1000记为1000 |
Version | String | 是 | API版本号，传2016-03-04 |
名称 | 类型 | 是否必返回 | 描述 |
|---|---|---|---|
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 | 否 | 云硬盘类型：ESSD_PL1/ESSD_PL2/ESSD_PL3/SSD3.0/EHDD |
VolumeCategory | String | 否 | 云硬盘分类，两种，有效值是系统盘（system）或者数据盘（data） |
InstanceId | String | 否 | 云硬盘状态为in-use时，该云硬盘关联的实例ID（主机ID） |
CreateTime | String | 否 | 云硬盘创建时间 |
ExpireTime | String | 否 | 云硬盘到期时间 |
AvailabilityZone | String | 否 | 云硬盘所在可用区 |
ChargeType | String | 否 | 云硬盘计费方式 |
InstanceTradeType | String | 否 | 云硬盘订单状态，取值范围：1:正式 2:试用 |
ProjectId | Integer | 否 | 硬盘所属项目组id |
Attachment | List | 否 | 硬盘的当前挂载信息 |
InstanceId | String | 否 | 硬盘当前挂载的实例ID（主机ID） |
MountPoint | String | 否 | 硬盘挂载点 |
DeleteWithInstance | Boolean | 否 | 待挂载的云硬盘是否随云主机删除。取值范围： |
HistoryAttachment | List | 否 | 硬盘的历史挂载信息 |
InstanceId | String | 否 | 硬盘历史挂载的实例ID（主机ID） |
AttachTime | String | 否 | 硬盘本地历史的挂载时间 |
DetachTime | String | 否 | 硬盘本地历史的卸载时间 |
MountPoint | String | 否 | 硬盘本地历史挂载点 |
TotalCount | Integer | 是 | 符合条件的云硬盘总数 |
Marker | Integer | 否 | 分页标识，单次调用未返回全部实例时，标记下次调用的返回值的起点，默认值是0 |
MaxResults | Integer | 否 | 单次调用所返回的最大实例数目 |
输入参数
http://ebs.api.ksyun.com/
?Action=DescribeVolumes
&Version=2016-03-04
&VolumeType=SSD3.0
&VolumeStatus=in-use
&VolumeId.1=162460f4-176a-4729-9b6e-750e3fee13b2
&VolumeId.2=f66ca915-9ef2-416f-b025-3ce1c69d79f2
&VolumeId.3=534b90fb-26f4-4984-8ef6-8b61a460b7c4
&VolumeId.4=726375fb-3834-40b6-9a1d-24fa4542187f输出参数
{
"RequestId": "ea82d72e-0169-4970-8beb-92d3a10964d7",
"Volumes": [
{
"VolumeId": "162460f4-176a-4729-9b6e-750e3fee13b2",
"VolumeName": "ebs1_system_disk",
"VolumeDesc": "",
"Size": 20,
"VolumeStatus": "in-use",
"VolumeType": "SSD3.0",
"VolumeCategory": "system",
"InstanceId": "1e00e3ca-52e3-46d2-891d-e07088cfa2ea",
"AvailabilityZone": "cn-beijing-6a",
"ChargeType": "Monthly",
"InstanceTradeType": 1,
"CreateTime": "2021-07-21 10:28:02",
"Attachment": [
{
"InstanceId": "1e00e3ca-52e3-46d2-891d-e07088cfa2ea",
"MountPoint": "/dev/vda",
"DeleteWithInstance": true
}
],
"ProjectId": 0,
"ExpireTime": "2021-08-21 23:59:59"
},
{
"VolumeId": "f66ca915-9ef2-416f-b025-3ce1c69d79f2",
"VolumeName": "ebs1_data_disk",
"Size": 100,
"VolumeStatus": "in-use",
"VolumeType": "SSD3.0",
"VolumeCategory": "data",
"InstanceId": "1e00e3ca-52e3-46d2-891d-e07088cfa2ea",
"AvailabilityZone": "cn-beijing-6a",
"ChargeType": "Monthly",
"InstanceTradeType": 1,
"CreateTime": "2021-06-15 22:09:58",
"Attachment": [
{
"InstanceId": "1e00e3ca-52e3-46d2-891d-e07088cfa2ea",
"MountPoint": "/dev/vdb",
"DeleteWithInstance": false
}
],
"ProjectId": 0,
"ExpireTime": "2021-08-15 23:59:59"
},
{
"VolumeId": "534b90fb-26f4-4984-8ef6-8b61a460b7c4",
"VolumeName": "ebs2_system_disk",
"VolumeDesc": "",
"Size": 50,
"VolumeStatus": "in-use",
"VolumeType": "SSD3.0",
"VolumeCategory": "system",
"InstanceId": "af585e94-3d37-4b6b-ac12-99b16f13c73c",
"AvailabilityZone": "cn-beijing-6c",
"ChargeType": "Daily",
"InstanceTradeType": 1,
"CreateTime": "2021-07-09 13:33:03",
"Attachment": [
{
"InstanceId": "af585e94-3d37-4b6b-ac12-99b16f13c73c",
"MountPoint": "/dev/vda",
"DeleteWithInstance": true
}
],
"ProjectId": 0
},
{
"VolumeId": "726375fb-3834-40b6-9a1d-24fa4542187f",
"VolumeName": "ebs2_data_disk",
"Size": 500,
"VolumeStatus": "in-use",
"VolumeType": "EHDD",
"VolumeCategory": "data",
"InstanceId": "af585e94-3d37-4b6b-ac12-99b16f13c73c",
"AvailabilityZone": "cn-beijing-6c",
"ChargeType": "Daily",
"InstanceTradeType": 1,
"CreateTime": "2021-05-08 14:38:11",
"Attachment": [
{
"InstanceId": "af585e94-3d37-4b6b-ac12-99b16f13c73c",
"MountPoint": "/dev/vdb",
"DeleteWithInstance": true
}
],
"HistoryAttachment": [
{
"InstanceId": "5c49b207-04bd-427b-b60d-dc1dce96f933",
"AttachTime": "2021-05-08 14:40:05",
"DetachTime": "2021-05-08 17:02:58",
"MountPoint": "/dev/vdb"
}
],
"ProjectId": 0
}
]
}纯净模式