Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.

The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

post/#X-Amz-Target=StorageGateway_20130630.DescribeCache

Headers

X-Amz-Target'StorageGateway_20130630.DescribeCache' required

Request body

GatewayARNstring required

The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and Amazon Web Services Region.

Response

Success

GatewayARNstring

The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and Amazon Web Services Region.

DiskIdsDiskId[]

An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the <a>ListLocalDisks</a> API.

CacheAllocatedInBytesinteger

The amount of cache in bytes allocated to a gateway.

CacheUsedPercentagenumber double

Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period.

CacheDirtyPercentagenumber double

The file share's contribution to the overall percentage of the gateway's cache that has not been persisted to Amazon Web Services. The sample is taken at the end of the reporting period.

CacheHitPercentagenumber double

Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period.

CacheMissPercentagenumber double

Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period.

Example response

{
  "CacheAllocatedInBytes": 2199023255552,
  "CacheDirtyPercentage": 0.07,
  "CacheHitPercentage": 99.68,
  "CacheMissPercentage": 0.32,
  "CacheUsedPercentage": 0.07,
  "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/sgw-12A3456B"
}