AWS Storage Gateway Service
API Reference (API Version 2013-06-30)

DescribeStorediSCSIVolumes

Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

Request Syntax

{ "VolumeARNs": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

VolumeARNs

An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

Type: Array of strings

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: Yes

Response Syntax

{ "StorediSCSIVolumes": [ { "CreatedDate": number, "KMSKey": "string", "PreservedExistingData": boolean, "SourceSnapshotId": "string", "TargetName": "string", "VolumeARN": "string", "VolumeAttachmentStatus": "string", "VolumeDiskId": "string", "VolumeId": "string", "VolumeiSCSIAttributes": { "ChapEnabled": boolean, "LunNumber": number, "NetworkInterfaceId": "string", "NetworkInterfacePort": number, "TargetARN": "string" }, "VolumeProgress": number, "VolumeSizeInBytes": number, "VolumeStatus": "string", "VolumeType": "string", "VolumeUsedInBytes": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

StorediSCSIVolumes

Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:

  • ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.

  • LunNumber: The logical disk number.

  • NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.

  • NetworkInterfacePort: The port used to communicate with iSCSI targets.

  • PreservedExistingData: Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

  • SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.

  • StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.

  • TargetARN: The Amazon Resource Name (ARN) of the volume target.

  • VolumeARN: The Amazon Resource Name (ARN) of the stored volume.

  • VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

  • VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.

  • VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

  • VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

  • VolumeSizeInBytes: The size of the volume in bytes.

  • VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.

  • VolumeType: One of the enumeration values describing the type of the volume. Currently, on STORED volumes are supported.

Type: Array of StorediSCSIVolume objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An internal server error has occurred during the request. For more information, see the error and message fields.

HTTP Status Code: 400

InvalidGatewayRequestException

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

HTTP Status Code: 400

Example

Example Request

The following example shows a request that returns a description of a volume.

Sample Request

POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20120630.DescribeStorediSCSIVolumes { "VolumeARNs": ["arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"] }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Content-type: application/x-amz-json-1.1 Content-length: 507 { "StorediSCSIVolumes": [ { "VolumeiSCSIAttributes": { "ChapEnabled": true, "NetworkInterfaceId": "10.243.43.207", "NetworkInterfacePort": 3260, "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" }, "KMSEncrypted": false, "PreservedExistingData": false, "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", "VolumeDiskId": "pci-0000:03:00.0-scsi-0:0:0:0", "VolumeId": "vol-1122AABB", "VolumeProgress": 23.7, "VolumeSizeInBytes": 1099511627776, "VolumeStatus": "BOOTSTRAPPING", "VolumeUsedInBytes": 1090000000000", } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: