最近更新时间:2023.08.01 15:51:33
首次发布时间:2021.11.17 14:15:55
调用DescribeVolumes接口查询云盘列表。
名称 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeVolumes | 要执行的操作,取值:DescribeVolumes |
VolumeIds.N | String | 否 | VolumeIds.1=vol-jv4gkgfal98bv6pz****&VolumeIds.2=vol-jv4gmy2isp8bv7p7**** | 云盘ID。可以指定一个或多个。 |
VolumeName | String | 否 | test | 云盘名称,支持模糊查询。 |
VolumeType | String | 否 | PTSSD | 云盘类型,取值说明如下:
说明 关于云盘规格的详细说明,请参见云盘规格。 |
ZoneId | String | 否 | cn-beijing-a | 可用区ID。 |
VolumeStatus | String | 否 | available | 云盘状态,取值说明如下: |
InstanceId | String | 否 | i-3ti74if6ay3vj0x1**** | 挂载云盘的ECS实例ID。 |
PageNumber | Int | 否 | 1 | 起始页码,默认1。 |
PageSize | Int | 否 | 15 | 页大小,最大100默认15。 |
Kind | String | 否 | data | 云盘属性,取值说明如下: |
ProjectName | String | 否 | default | 根据云盘所属的Project(项目)名称筛选云盘。 |
TagFilters.N.Key | String | 否 | TagFilters.1.Key=tag | 根据标签查询资源时指定的标签键。说明如下:
|
TagFilters.N.Values.N | String | 否 | TagFilters.1.Values.1=tag&TagFilters.1.Values.2=test | 根据标签查询资源时指定的标签值。说明如下:
|
名称 | 类型 | 描述 |
---|---|---|
TotalCount | Int | 符合条件的云盘总数。 |
PageNumber | Int | 页数索引。 |
PageSize | Int | 分页的页容量。 |
Volumes | Array of object Volumes | 符合条件的云盘信息。具体请参见下表“Volumes结构”。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ZoneId | String | cn-beijing-a | 可用区ID。 |
VolumeId | String | vol-3tirbh6lka3vj0x1**** | 云盘ID。 |
VolumeName | String | test-volume | 云盘名称。 |
VolumeType | String | PTSSD | 云盘类型。 |
Description | String | - | 云盘描述信息。 |
InstanceId | String | i-3tirbh6lka3vj0x1**** | 云盘挂载的实例ID。 |
ImageId | String | image-3thdzjcwq23vj0wy**** | 云盘中的镜像ID。 |
Size | int | 1024 | 云盘容量,单位GiB。 |
Status | String | attached | 云盘状态,取值说明如下: |
Kind | String | system | 云盘属性,取值说明如下: |
CreatedAt | String | 2021-06-28T15:10:47+08:00 | 云盘创建时间。 |
UpdatedAt | String | 2021-06-28T15:10:47+08:00 | 云盘更新时间。 |
BillingType | Int | 2 | 计费类型,取值说明如下: |
PayType | String | post | 付费类型,取值说明如下: |
ProjectName | String | default | 云盘所属的项目。 |
TradeStatus | Int | 1 | 费用中心的云盘状态。 |
ExpiredTime | String | 2200-01-01 00:00:00 | 包年包月到期时间。 |
RenewType | Int | 1 | 续费方式,取值说明如下: |
OverdueReclaimTime | String | - | 云盘欠费回收时间。 |
OverdueTime | String | - | 云盘欠费关停时间。 |
DeleteWithInstance | Boolean | true | 释放实例时,该云盘是否随实例一起释放,取值说明如下: |
Tags | Array of Struct | - | 云盘的标签信息,具体请参见下表“ Tag结构 ”。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Key | String | tag | 云盘的标签键。 |
Value | String | test | 云盘的标签值。 |
GET /?Action=DescribeVolumes&Version=2020-04-01&VolumeIds.1=vol-jv4gkgfal98bv6pz****&VolumeIds.2=vol-jv4gmy2isp8bv7p7**** HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing ServiceName: storage_ebs
{ "ResponseMetadata": { "RequestId": "20230417210548EEFE5B400750987DA5C0", "Action": "DescribeVolumes", "Version": "2020-04-01", "Service": "storage_ebs", "Region": "cn-beijing" }, "Result": { "PageNumber": 1, "PageSize": 15, "TotalCount": 2, "Volumes": [ { "BillingType": 2, "CreatedAt": "2023-03-03T16:23:47+08:00", "DeleteWithInstance": false, "Description": "标签测试", "ExpiredTime": "2200-01-01 00:00:00", "ImageId": "", "InstanceId": "", "Kind": "data", "OverdueReclaimTime": "", "OverdueTime": "", "PayType": "post", "ProjectName": "", "RenewType": 1, "Size": "30", "Status": "available", "Tags": [ { "Key": "tag1", "Value": "test1" } ], "TradeStatus": 1, "UpdatedAt": "2023-04-11T11:16:19+08:00", "VolumeId": "vol-jv4gkgfal98bv6pz****", "VolumeName": "tagtest1", "VolumeType": "ESSD_PL0", "ZoneId": "cn-beijing-b" }, { "BillingType": 2, "CreatedAt": "2023-03-03T15:58:23+08:00", "DeleteWithInstance": false, "Description": "标签测试", "ExpiredTime": "2200-01-01 00:00:00", "ImageId": "", "InstanceId": "", "Kind": "data", "OverdueReclaimTime": "", "OverdueTime": "", "PayType": "post", "ProjectName": "", "RenewType": 1, "Size": "20", "Status": "available", "Tags": [ { "Key": "tag", "Value": "test" } ], "TradeStatus": 1, "UpdatedAt": "2023-04-11T11:16:19+08:00", "VolumeId": "vol-jv4gmy2isp8bv7p7****", "VolumeName": "Tagtest", "VolumeType": "ESSD_PL0", "ZoneId": "cn-beijing-a" } ] } }
HttpCode | 错误码 | 错误信息 |
---|---|---|
404 | VolumeNotFound | 云盘未查询到 |