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

DescribeCachediSCSIVolumes

Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.

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 Amazon Resource Name (ARN).

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

Type: Array of strings

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

Required: Yes

Response Syntax

{
   "CachediSCSIVolumes": [ 
      { 
         "CreatedDate": number,
         "SourceSnapshotId": "string",
         "VolumeARN": "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.

CachediSCSIVolumes

An array of objects where each object contains metadata about one cached volume.

Type: Array of CachediSCSIVolume 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
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20120630.DescribeCachediSCSIVolumes

{
  "VolumeARNs": ["arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"]
}

            

Sample 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: 664

{
  "CachediSCSIVolumes": [
    {
      "VolumeiSCSIAttributes": {
        "ChapEnabled": true,
        "LunNumber": 0,
        "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"
      },
      "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",
      "VolumeSizeInBytes": 1099511627776,
      "VolumeStatus": "AVAILABLE",
      "VolumeType": "CACHED iSCSI",
      "VolumeUsedInBytes": 1090000000000",
      

    }
  ]
}

            

See Also

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