| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
ListVolumes
Description
This operation lists the volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes API.
The operation supports pagination. By default, the operation returns a maximum of up to 100
volumes. You can optionally specify the Limit field in the body to limit
the number of volumes in the response. If the number of volumes returned in the response
is truncated, the response includes a Marker field. You can use this
Marker value in your subsequent request to retrieve the next set of
volumes.
Request
Syntax
POST / HTTP/1.1 Host: storagegateway.region.amazonaws.com Authorization:authorizationContent-Type: application/x-amz-json-1.1 x-amz-date:datex-amz-target: StorageGateway_20120630.ListVolumes { "GatewayARN": "String", "Marker": "String", "Limit":Number}
JSON Fields
- GatewayARN
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Required: yes
Type: String
- Limit
Specifies that the list of volumes returned be limited to the specified number of items.
Constraint: Minimum value of 1. Maximum value of 100.
Required: No
Type: Number
- Marker
A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.
Required: No
Type: String
Response
Syntax
HTTP/1.1 200 OK x-amzn-RequestId: x-amzn-RequestId Content-Type: application/x-amz-json-1.1 Content-length: payloadLength Date: date { "GatewayARN": "String", "VolumeInfos": [ {"VolumeARN": "String", "VolumeType": "String" }, ... ], "Marker": "String" }
JSON Fields
- GatewayARN
The Amazon Resource Name (ARN) of a gateway.
Type: String
- VolumeInfos
An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then
VolumeInfosis an empty array "[]".Type: Array
- Marker
Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.
Type: String
- VolumeARN
The Amazon Resource Name (ARN) of the storage volume.
Type: String
- VolumeType
One of the VolumeType values.
Type: String
Errors
This operation returns the following error codes in addition to exceptions common to all operations. For information about these errors and common exceptions, see Error Responses.
GatewayInternalError
GatewayNotConnected
GatewayNotFound
GatewayProxyNetworkConnectionBusy
InternalError
InvalidParameters
NotSupported
Examples
Example Request
The List iSCSI Volumes request in this example does not specify a limit or
marker field in the response body. The response returns the volumes
(up to the first 100) of the gateway.
POST / HTTP/1.1
Host: storagegateway.us-east-1.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20120630.ListVolumes
{
"GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway"
}Example Response
HTTP/1.1 200 OK
x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0
Date: Wed, 12 Sep 2012 12:00:02 GMT
Content-Type: application/x-amz-json-1.1
Content-length: 421
{
"GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway",
"VolumeInfos": [
{
"VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB",
"VolumeType": "STORED iSCSI"
},
{
"VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-3344CCDD",
"VolumeType": "STORED iSCSI"
}
]
}
