调用DescribeVolumes接口查询云盘列表。 ## 调试 ## 请求参数下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见[公共参数](https://www.volcengine.com/docs/6369/67268)。 **Action** string %%require%% `示例值：DescribeVolumes` 要执行的操作，取值：DescribeVolumes。 **Version** string %%require%% `示例值：2020-04-01` API的版本，取值：2020\-04\-01。 **PageSize** integer `可选` `示例值：15` 每页大小，最大 100，默认15。 **PageNumber** integer `可选` `示例值：1` 起始页码，默认1。 **SysTagVisible** boolean `可选` `示例值：true` 无效参数（默认显示系统标签）。 **Kind** string `可选` `示例值：data` 云盘属性，取值说明如下： * system：系统盘。 * data：数据盘。 **ZoneId** string `可选` `示例值：cn-beijing-a` 可用区ID。 **VolumeType** string `可选` `示例值：ESSD_PL0` 云盘类型，取值说明如下： * PTSSD：性能型SSD。 * ESSD_PL0：极速型SSD云盘，PL0规格。 * ESSD_FlexPL: 极速型SSD云盘，FlexPL规格。 * TSSD_TL0：吞吐型SSD云盘。 :::tip ::: 关于云盘规格的详细说明，请参见[云盘规格](https://www.volcengine.com/docs/6396/101839) **VolumeStatus** string `可选` `示例值：creating` 云盘状态，取值说明如下： * available：可用 * attaching：挂载中 * attached：已挂载 * detaching：卸载中 * creating：创建中 * deleting：删除中 * error：错误 * extending：扩容中 * terminatesuspend：待释放 :::tip 退订包年包月云盘时，云盘的状态会变成待释放。 ::: **InstanceId** string `可选` `示例值：i-3ti74if6ay3vj0x1****` 挂载云盘的ECS实例ID。 **VolumeName** string `可选` `示例值：test-volume` 云盘显示名称。命名规则如下： * 首字符仅支持中文、字母或下划线（_）。 * 可包含中文、字母、数字、下划线（_）或中划线（\-）。长度限制在1~128字符之间。 **TagFilters.N.Values.N** string[] `可选` `示例值：value` 根据标签查询资源时指定的标签键。说明如下： * TagFilters.N.Key：N表示标签键的序号。取值范围：1～10。 * 多个标签键之间用&分隔，不允许重复。 * 不传入该参数则表示查询所有标签。 * 传入空字符串时，则返回错误码InvalidTagFilterKey.Malformed。 **TagFilters.N.Key** string[] `可选` `示例值：key` 根据标签查询资源时指定的标签值。说明如下： * TagFilters.N.Values.N：第一个N表示标签键的序号。取值范围：1～10。 * TagFilters.N.Values.N：第二个N表示标签值的序号。取值范围：1～3。 * 多个标签值之间用&分隔。 * 如果传入该参数，则必须先传入TagFilters.N.Key。 * 不传入该参数则表示查询同一标签键下的所有标签值。 * 传入空字符串时，表示查询标签值为空的标签。 **BillingType** integer `可选` `示例值：1` 付费类型，取值说明如下： * pre：预付费（包年包月） * post：后付费（按量计费） **ProjectName** string `可选` `示例值：default` 云盘所属项目。 **VolumeIds.N** string[] `可选` `示例值：vol-3wqdkgao8i4p5d65****` 云盘ID列表。 ## 返回参数下方仅列出本接口特有的返回参数。更多信息请参见[返回结构](https://www.volcengine.com/docs/6369/80336)。 **TotalCount** integer `示例值：2` 符合条件的云盘总数。 **PageNumber** integer `示例值：1` 起始页码。 **PageSize** integer `示例值：50` 每页大小。 **Volumes** object[] `示例值：-` 符合条件的云盘信息。 **VolumeName** string `示例值：datavolume` 云盘名称。 **VolumeType** string `示例值：ESSD_PL0` 云盘类型。 **Description** string `示例值：aaaa` 云盘描述信息 **InstanceId** string `示例值：i-3tirbh6lka3vj0x1****` 云盘挂载的实例ID。 **ImageId** string `示例值：image-3thdzjcwq23vj0wy****` 云盘中的镜像ID。 **Status** string `示例值：attached` 云盘状态，说明如下： * available：可用 * attaching：挂载中 * attached：已挂载 * detaching：卸载中 * creating：创建中 * deleting：删除中 * error：错误 * extending：扩容中 * erminatesuspend：待释放 :::tip 退订包年包月云盘时，云盘的状态会变成待释放。 ::: **Kind** string `示例值：data` 云盘属性，说明如下：： * system：系统盘 * data：数据盘 **VolumeId** string `示例值：vol-3wqdkgao8i4p5d65****` 云盘ID。 **Size** string `示例值：1024` 云盘容量，单位GiB。 **BillingType** integer `示例值：2` 计费类型，说明如下： * 1：包年包月。 * 2：按量计费。 **OverdueTime** string `示例值：2200-01-01 00:00:00` 云盘欠费关停时间。 **OverdueReclaimTime** string `示例值：2200-01-01 00:00:00` 云盘欠费回收时间。 **ProjectName** string `示例值：default` 云盘所属的项目。 **CreatedAt** string `示例值：2025-11-03T14:50:48+08:00` 云盘创建时间。 **UpdatedAt** string `示例值：2025-11-05T14:50:48+08:00` 云盘更新时间。 **DeleteWithInstance** boolean `示例值：true` 释放实例时，该云盘是否随实例一起释放。取值说明如下： * true：云盘随实例一起释放。 * false：云盘不随实例一起释放。 **TradeStatus** integer `示例值：0` 交易状态，取值说明如下： * 0：创建中 * 1：运行中。 * 2：创建失败。 **PayType** string `示例值：Post` 付费类型，说明如下： * Pre：预付费（包年包月） * Post：后付费（按量计费） **ExpiredTime** string `示例值：2025-11-05T14:50:48+08:00` 包年包月到期时间。 **ZoneId** string `示例值：cn-beijing-a` 可用区ID。 **RenewType** integer `示例值：1` 续费方式，取值说明如下： * 1：手动续费 * 2 ：自动续费 * 3 ：到期不续费 **Tags** object[] `示例值：-` 云盘的标签信息。 **Key** string `示例值：tag` 云盘的标签键。 **Value** string `示例值：test` 云盘的标签值。 **AutoSnapshotPolicyId** string `示例值：asp-3vke5nbvug3hhwzz****` 自动快照策略。 **AutoSnapshotPolicyName** string `示例值：testablei` 自动快照策略名称。 **ErrorDetail** string `示例值：error` 具体错误。 **SourceSnapshotId** string `示例值：snap-3wqu6ajcau57gta1****` 源快照。 **SnapshotCount** integer `示例值：3` 快照计数。 **BaselinePerformance** object `示例值：-` 云盘的基准性能。 **IOPS** integer `示例值：2040` 云盘的基准IOPS，单位为次/秒。 **Throughput** integer `示例值：105` 云盘的基准吞吐量，单位为MB/s。 **ExtraPerformance** object `示例值：-` 云盘的额外性能。 **IOPS** integer `示例值：34160` 云盘的额外IOPS。 **Throughput** integer `示例值：232` 云盘的额外吞吐量。 **ExtraPerformanceTypeId** string `示例值：IOPS` 额外性能的类型，取值如下： * Balance：均衡型额外性能。 * IOPS：IOPS型额外性能。 * Throughput：吞吐量型额外性能。 **TotalPerformance** object `示例值：-` 云盘的总性能。 **IOPS** integer `示例值：34160` 云盘的总IOPS，即云盘的基准IOPS和额外IOPS之和。 **Throughput** integer `示例值：232` 云盘的总吞吐量，即云盘的基准吞吐量和额外吞吐量之和。 **PlacementGroupId** string `示例值：pg-d5ard493uxd44up7****` 存储放置组ID **SubgroupNumber** integer `示例值：2` 存储子放置组编号。 ## 请求示例 ```text POST /?Action=DescribeVolumes&Version=2020-04-01 HTTP/1.1 Host: open.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20251217T084931Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251217/cn-beijing/storage_ebs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f {} ``` ## 返回示例 ```json { "ResponseMetadata": { "RequestId": "2025112117474114322108521783****", "Action": "DescribeVolumes", "Version": "2020-04-01", "Service": "storage_ebs", "Region": "cn-beijing" }, "Result": { "TotalCount": 2, "PageNumber": 1, "PageSize": 50, "Volumes": [ { "VolumeName": "datavolume", "VolumeType": "ESSD_PL0", "Description": "aaaa", "InstanceId": "i-3tirbh6lka3vj0x1****", "ImageId": "image-3thdzjcwq23vj0wy****", "Status": "attached", "Kind": "data", "VolumeId": "vol-3wqdkgao8i4p5d65****", "Size": "1024", "BillingType": 2, "OverdueTime": "2200-01-01 00:00:00", "OverdueReclaimTime": "2200-01-01 00:00:00", "ProjectName": "default", "CreatedAt": "2025-11-03T14:50:48+08:00", "UpdatedAt": "2025-11-05T14:50:48+08:00", "DeleteWithInstance": true, "TradeStatus": 0, "PayType": "Post", "ExpiredTime": "2025-11-05T14:50:48+08:00", "ZoneId": "cn-beijing-a", "RenewType": 1, "Tags": [ { "Key": "tag", "Value": "test" } ], "AutoSnapshotPolicyId": "asp-3vke5nbvug3hhwzz****", "AutoSnapshotPolicyName": "testablei", "ErrorDetail": "error", "SourceSnapshotId": "snap-3wqu6ajcau57gta1****", "SnapshotCount": 3, "BaselinePerformance": { "IOPS": 2040, "Throughput": 105 }, "ExtraPerformance": { "IOPS": 34160, "Throughput": 232, "ExtraPerformanceTypeId": "IOPS" }, "TotalPerformance": { "IOPS": 34160, "Throughput": 232 }, "PlacementGroupId": "pg-d5ard493uxd44up7****", "SubgroupNumber": 2 } ] } } ``` ## 错误码下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见[公共错误码](https://www.volcengine.com/docs/6369/68677)文档。 |状态码 |错误码 |错误信息 |说明 | |---|---|---|---| |400 |InvalidRequest |The operation is not permitted due to the request is invalid. |无效的请求。 | |400 |ErrInvalidTagFilterKey |tag filter key invalid |标签过滤键无效。 | |400 |ErrTagFilterKeyConflict |tag filter key conflict |标签过滤器键冲突。 | |400 |ErrMaximumTagFilterKeys |too many tag filter keys |标签过滤键超出限制。 | |400 |ErrInvalidTagFilterValue |tag filter value invalid |标签过滤器值无效。 | |400 |ErrMaximumTagFilterValues |too many tag filter value |标签过滤值超出限制。 |

云服务器