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

ListLocalDisks

Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.

The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).

Request Syntax

{
   "GatewayARN": "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.

GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Type: String

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

Required: Yes

Response Syntax

{
   "Disks": [ 
      { 
         "DiskAllocationResource": "string",
         "DiskAllocationType": "string",
         "DiskId": "string",
         "DiskNode": "string",
         "DiskPath": "string",
         "DiskSizeInBytes": number,
         "DiskStatus": "string"
      }
   ],
   "GatewayARN": "string"
}

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.

Disks

Type: Array of Disk objects

GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Type: String

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

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 information about a gateway's local disks.

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.ListLocalDisks
{
   "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
               

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: 398
{
   "Disks": [
      {
         "DiskAllocationType": "CACHE_STORAGE",
         "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0",
         "DiskNode": "SCSI(0:0)",
         "DiskPath": "/dev/sda",
         "DiskSizeInBytes": 1099511627776
         "DiskStatus": "missing"
      },
      {
         "DiskAllocationType": "UPLOAD_BUFFER",
         "DiskAllocationResource": "",
         "DiskId": "pci-0000:03:00.0-scsi-0:0:1:0",
         "DiskNode": "SCSI(0:1)",
         "DiskPath": "/dev/sdb",
         "DiskSizeInBytes": 1099511627776
         "DiskStatus": "present"
      }
   ],
   "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
               

See Also

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