Menu
Amazon Route 53
API Reference

ListHealthChecks

Retrieve a list of the health checks that are associated with the current AWS account.

Request Syntax

Copy
GET /2013-04-01/healthcheck?marker=Marker&maxitems=MaxItems HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

marker

If the value of IsTruncated in the previous response was true, you have more health checks. To get another group, submit another ListHealthChecks request.

For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first health check that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more health checks to get.

Length Constraints: Maximum length of 64.

maxitems

The maximum number of health checks that you want ListHealthChecks to return in response to the current request. Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100 health checks.

Request Body

The request does not have a request body.

Response Syntax

Copy
HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <ListHealthChecksResponse> <HealthChecks> <HealthCheck> <CallerReference>string</CallerReference> <CloudWatchAlarmConfiguration> <ComparisonOperator>string</ComparisonOperator> <Dimensions> <Dimension> <Name>string</Name> <Value>string</Value> </Dimension> </Dimensions> <EvaluationPeriods>integer</EvaluationPeriods> <MetricName>string</MetricName> <Namespace>string</Namespace> <Period>integer</Period> <Statistic>string</Statistic> <Threshold>double</Threshold> </CloudWatchAlarmConfiguration> <HealthCheckConfig> <AlarmIdentifier> <Name>string</Name> <Region>string</Region> </AlarmIdentifier> <ChildHealthChecks> <ChildHealthCheck>string</ChildHealthCheck> </ChildHealthChecks> <EnableSNI>boolean</EnableSNI> <FailureThreshold>integer</FailureThreshold> <FullyQualifiedDomainName>string</FullyQualifiedDomainName> <HealthThreshold>integer</HealthThreshold> <InsufficientDataHealthStatus>string</InsufficientDataHealthStatus> <Inverted>boolean</Inverted> <IPAddress>string</IPAddress> <MeasureLatency>boolean</MeasureLatency> <Port>integer</Port> <Regions> <Region>string</Region> </Regions> <RequestInterval>integer</RequestInterval> <ResourcePath>string</ResourcePath> <SearchString>string</SearchString> <Type>string</Type> </HealthCheckConfig> <HealthCheckVersion>long</HealthCheckVersion> <Id>string</Id> </HealthCheck> </HealthChecks> <IsTruncated>boolean</IsTruncated> <Marker>string</Marker> <MaxItems>string</MaxItems> <NextMarker>string</NextMarker> </ListHealthChecksResponse>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

ListHealthChecksResponse

Root level tag for the ListHealthChecksResponse parameters.

Required: Yes

HealthChecks

A complex type that contains one HealthCheck element for each health check that is associated with the current AWS account.

Type: Array of HealthCheck objects

IsTruncated

A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can get the next group of health checks by submitting another ListHealthChecks request and specifying the value of NextMarker in the marker parameter.

Type: Boolean

Marker

For the second and subsequent calls to ListHealthChecks, Marker is the value that you specified for the marker parameter in the previous request.

Type: String

Length Constraints: Maximum length of 64.

MaxItems

The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the current response.

Type: String

NextMarker

If IsTruncated is true, the value of NextMarker identifies the first health check that Amazon Route 53 returns if you submit another ListHealthChecks request and specify the value of NextMarker in the marker parameter.

Type: String

Length Constraints: Maximum length of 64.

Errors

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

IncompatibleVersion

The resource you're trying to access is unsupported on this Amazon Route 53 endpoint.

HTTP Status Code: 400

InvalidInput

The input is not valid.

HTTP Status Code: 400

Examples

Example Request

Copy
GET /2013-04-01/healthcheck?maxitems=1

Example Response

Copy
HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <ListHealthChecksResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <HealthChecks> <HealthCheck> <Id>abcdef11-2222-3333-4444-555555fedcba</Id> <CallerReference>example.com 192.0.2.17</CallerReference> <HealthCheckConfig> <IPAddress>192.0.2.17</IPAddress> <Port>80</Port> <Type>HTTP</Type> <ResourcePath>/docs/route-53-health-check.html</ResourcePath> <FullyQualifiedDomainName>example.com</FullyQualifiedDomainName> <RequestInterval>30</RequestInterval> <FailureThreshold>3</FailureThreshold> <MeasureLatency>true</MeasureLatency> <EnableSNI>true</EnableSNI> <Inverted>false</Inverted> </HealthCheckConfig> <HealthCheckVersion>2</HealthCheckVersion> </HealthCheck> </HealthChecks> <IsTruncated>true</IsTruncated> <NextMarker>aaaaaaaa-1234-5678-9012-bbbbbbcccccc</NextMarker> <MaxItems>1</MaxItems> </ListHealthChecksResponse>

See Also

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