| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
DescribeCacheClusters
Description
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.
Cluster information will be returned by default. An optional ShowDetails flag can be used to retrieve detailed information about the Cache Nodes associated with the Cache Cluster. Details include the DNS address and port for the Cache Node endpoint.
If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.
If the cluster is in the DELETING state, only cluster level information will be displayed.
While adding Cache Nodes, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. The cluster lifecycle tells the customer when new nodes are AVAILABLE.
While removing existing Cache Nodes from an cluster, endpoint information for the removed nodes will not be displayed.
DescribeCacheClusters supports pagination.
Request Parameters
For information about the common parameters that all actions use, 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 provided in the previous DescribeCacheClusters request. 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 may 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 Cache Nodes information.
Type: Boolean
Required: No
Response Elements
The following
elements are
returned in a DescribeCacheClustersResult structure.
- CacheClusters
A list of CacheClusters.
Type: CacheCluster list
- Marker
The marker obtained from a previous operation response.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- CacheClusterNotFound
CacheClusterId does not refer to an existing Cache Cluster.
HTTP Status Code: 404
- InvalidParameterCombination
HTTP Status Code: 400
- InvalidParameterValue
HTTP Status Code: 400
Examples
Sample Request
https://elasticache.us-east-1.amazonaws.com/ ?Action=DescribeCacheClusters &MaxRecords=100 &Version=2012-11-15 &ShowCacheNodeInfo=false &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2011-07-27T02%3A55%3A54.654Z &AWSAccessKeyId=YOUR-ACCESS-KEY &Signature=YOUR-SIGNATURE
Sample Response
<DescribeCacheClustersResponse xmlns="http://elasticache.amazonaws.com/doc/2012-11-15/">
<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-east-1d</PreferredAvailabilityZone>
<CacheClusterCreateTime>2011-07-26T01:21:46.607Z</CacheClusterCreateTime>
<EngineVersion>1.4.5</EngineVersion>
<AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
<PreferredMaintenanceWindow>fri:08:30-fri:09:00</PreferredMaintenanceWindow>
<CacheSecurityGroups>
<CacheSecurityGroup>
<CacheSecurityGroupName>default</CacheSecurityGroupName>
<Status>active</Status>
</CacheSecurityGroup>
</CacheSecurityGroups>
<NotificationConfiguration>
<TopicStatus>active</TopicStatus>
<TopicArn>arn:aws:sns:us-east-1:123456789012:ElastiCacheNotifications</TopicArn>
</NotificationConfiguration>
<NumCacheNodes>6</NumCacheNodes>
</CacheCluster>
</CacheClusters>
</DescribeCacheClustersResult>
<ResponseMetadata>
<RequestId>f270d58f-b7fb-11e0-9326-b7275b9d4a6c</RequestId>
</ResponseMetadata>
</DescribeCacheClustersResponse>
