DescribeVolumes
In this article:
DescribeVolumes#
Description#
Describes the specified volumes.
Request Parameters#
Filter.N — One or more filters.
Type: List of Filter objects
Required: No
VolumeId.N — IDs of virtual volumes.
Type: Array of strings
Required: No
Supported Filters#
attachment.instance-id — The ID of the instance the volume is attached to.
attachment.device — The name of the device, attached to the instance (for example,
disk1
).attachment.status — The attachment status (
attaching
|attached
|detaching
|detached
).availability-zone — The name of the availability zone in which the volume was created (
ru-msk-comp1p
|ru-msk-vol51
|ru-msk-vol52
).create-time — The timestamp when the volume was created.
size — The size of the volume, GiB.
snapshot-id — The ID of the snapshot from which the volume was created.
status — The state of the volume (
creating
|available
|in-use
|deleting
|error
).tag-key — The tag key. This filter is used to get the tagged volumes with the specified key and any value.
tag:<tag-key> — The key/value a pair of a tag. The tag key is passed in the filter name, while the tag value is used as the filter value.
volume-id — The ID of the volume.
volume-type — Volume type (
st2
|gp2
|io2
).
Response Elements#
requestId — The request ID.
Type: String
volumeSet — Information about the available volumes.
Type: List of Volume objects
Examples#
c2-ec2 DescribeVolumes
c2-ec2 DescribeVolumes VolumeId.1 vol-01234567
c2-ec2 DescribeVolumes Filter.1.Name availability-zone Filter.1.Value.1 ru-msk-vol51
c2-ec2 DescribeVolumes Filter.1.Name tag:<tag-key> Filter.1.Value.1 <tag-value>
c2-ec2 DescribeVolumes Filter.1.Name tag-key Filter.1.Value.1 <tag-key>