Menu
Amazon ElastiCache
API Reference (API Version 2015-02-02)

DescribeCacheClusters

Returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.

By default, abbreviated information about the cache clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

If the cluster is in the deleting state, only cluster-level information is displayed.

If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cache cluster state is available, the cluster is ready for use.

If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.

Request Parameters

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

CacheClusterId

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

Type: String

Required: No

Marker

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Type: String

Required: No

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Type: Integer

Required: No

ShowCacheNodeInfo

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Type: Boolean

Required: No

Response Elements

The following elements are returned by the service.

CacheClusters.CacheCluster.N

A list of cache clusters. Each item in the list contains detailed information about one cache cluster.

Type: array of CacheCluster objects

Marker

Provides an identifier to allow retrieval of paginated results.

Type: String

Errors

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

CacheClusterNotFound

The requested cache cluster ID does not refer to an existing cache cluster.

HTTP Status Code: 404

InvalidParameterCombination

Two or more incompatible parameters were specified.

HTTP Status Code: 400

InvalidParameterValue

The value for a parameter is invalid.

HTTP Status Code: 400

Example

Sample Request

Copy
https://elasticache.us-west-2.amazonaws.com/ ?Action=DescribeCacheClusters &MaxRecords=100 &ShowCacheNodeInfo=false &Version=2015-02-02 &SignatureVersion=4 &SignatureMethod=HmacSHA256 &Timestamp=20150202T192317Z &X-Amz-Credential=<credential>

Sample Response

Copy
<DescribeCacheClustersResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/"> <DescribeCacheClustersResult> <CacheClusters> <CacheCluster> <CacheParameterGroup> <ParameterApplyStatus>in-sync</ParameterApplyStatus> <CacheParameterGroupName>default.memcached1.4</CacheParameterGroupName> <CacheNodeIdsToReboot/> </CacheParameterGroup> <CacheClusterId>simcoprod42</CacheClusterId> <CacheClusterStatus>available</CacheClusterStatus> <ConfigurationEndpoint> <Port>11211</Port> <Address>simcoprod42.m2st2p.cfg.cache.amazonaws.com</Address> </ConfigurationEndpoint> <ClientDownloadLandingPage> https://console.aws.amazon.com/elasticache/home#client-download: </ClientDownloadLandingPage> <CacheNodeType>cache.m1.large</CacheNodeType> <Engine>memcached</Engine> <PendingModifiedValues/> <PreferredAvailabilityZone>us-west-2c</PreferredAvailabilityZone> <CacheClusterCreateTime>2015-02-02T01:21:46.607Z</CacheClusterCreateTime> <EngineVersion>1.4.5</EngineVersion> <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> <PreferredMaintenanceWindow>fri:08:30-fri:09:30</PreferredMaintenanceWindow> <CacheSecurityGroups> <CacheSecurityGroup> <CacheSecurityGroupName>default</CacheSecurityGroupName> <Status>active</Status> </CacheSecurityGroup> </CacheSecurityGroups> <NotificationConfiguration> <TopicStatus>active</TopicStatus> <TopicArn>arn:aws:sns:us-west-2:123456789012:ElastiCacheNotifications</TopicArn> </NotificationConfiguration> <NumCacheNodes>6</NumCacheNodes> </CacheCluster> </CacheClusters> </DescribeCacheClustersResult> <ResponseMetadata> <RequestId>f270d58f-b7fb-11e0-9326-b7275b9d4a6c</RequestId> </ResponseMetadata> </DescribeCacheClustersResponse>

See Also

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