DescribeVolumes

GET /?Action=DescribeVolumes
Description

Describes one or more specified Block Storage Unit (BSU) volume.
You can use the Filter.N parameter to filter the described volumes on the following properties:

  • attachment.attach-time: The time at which the attachment was initiated.

  • attachment.delete-on-termination: Whether the volume is deleted when terminating the instance.

  • attachment.device: The device to which the volume is plugged in.

  • attachment.instance-id: The ID of the instance the volume is attached to.

  • attachment.status: The attachment state (attaching | attached | detaching | detached).

  • availability-zone: The Availability Zone in which the volume was created.

  • create-time: The time at which the volume was created.

  • tag-key: The key of a tag associated with the resource.

  • tag-value: The value of a tag associated with the resource.

  • tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

  • volume-id: The ID of the volume.

  • volume-type: The type of the volume (standard | gp2 | io1).

  • snapshot-id: The snapshot from which the volume was created.

  • size: The size of the volume, in gibibytes (GiB).

  • status: The state of the volume (creating | available | in-use | deleting | error).

Note

If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.
Body parameter

Required: false
Name: DescribeVolumesRequest

Name Description Required Schema Default Example

Filter.N

One or more filters. Example:
osc-cli fcu DescribeVolumes \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"

false

Filter

MaxResults

The maximum number of results that can be returned in a single page. You can use the NextToken attribute to request the next results pages. This value is between 5 and 1000. If you provide a value larger than 1000, only 1000 results are returned.

false

integer

NextToken

The token to request the next results page.

false

string

VolumeId.N

One or more volume IDs.

false

string
Responses
HTTP Code 200
HTTP Code Description Schema

200

DescribeVolumesResult

Response 200

Response 200

Name Description Required Schema Default Example

nextToken

The token to request the next results page. If the value is null, there is no results left to be returned.

false

string

requestId

The ID of the request.

false

string

volumeSet.N

Information about one or more volumes.

false

Volume