| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
DescribeWorkingStorage
Description
This operation returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture (see How AWS Storage Gateway Works).
Note
Working storage is also referred to as the upload buffer. You can also use the DescribeUploadBuffer operation to add an upload buffer to a stored-volume gateway.
The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.
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.DescribeWorkingStorage { "GatewayARN":"String" }
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
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 { "DiskIds": [ "String", ... ], "GatewayARN": "String", "WorkingStorageUsedInBytes": Number, "WorkingStorageAllocatedInBytes": Number }
JSON Fields
- DiskIds
An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the
DiskIdsarray is empty.Type: Array
- GatewayARN
In response, AWS Storage Gateway returns the ARN of the activated gateway. If you don't remember the ARN of a gateway, you can use the List Gateways operations to return a list of gateways for your account and region.
Type: String
- WorkingStorageAllocatedInBytes
The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.
Type: Number
- WorkingStorageUsedInBytes
The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.
Type: Number
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
UnsupportedOperationForGatewayType
Examples
Example Request
The following example shows a request to obtain a description of a gateway's working storage.
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.DescribeWorkingStorage
{
"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: 271
{
"DiskIds": [
"pci-0000:03:00.0-scsi-0:0:0:0",
"pci-0000:04:00.0-scsi-0:1:0:0"
],
"GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway",
"WorkingStorageAllocatedInBytes": 2199023255552,
"WorkingStorageUsedInBytes": 789207040
} 
