Menu
Amazon Route 53
API Reference

GetHealthCheckStatus

Gets status of a specified health check.

Request Syntax

Copy
GET /2013-04-01/healthcheck/HealthCheckId/status HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

HealthCheckId

The ID for the health check that you want the current status for. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

Note

If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use GetHealthCheckStatus to get the status of a calculated health check.

Length Constraints: Maximum length of 64.

Request Body

The request does not have a request body.

Response Syntax

Copy
HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <GetHealthCheckStatusResponse> <HealthCheckObservations> <HealthCheckObservation> <IPAddress>string</IPAddress> <Region>string</Region> <StatusReport> <CheckedTime>timestamp</CheckedTime> <Status>string</Status> </StatusReport> </HealthCheckObservation> </HealthCheckObservations> </GetHealthCheckStatusResponse>

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.

GetHealthCheckStatusResponse

Root level tag for the GetHealthCheckStatusResponse parameters.

Required: Yes

HealthCheckObservations

A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker that is reporting a status about the health check endpoint.

Type: Array of HealthCheckObservation objects

Errors

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

InvalidInput

The input is not valid.

HTTP Status Code: 400

NoSuchHealthCheck

No health check exists with the ID that you specified in the DeleteHealthCheck request.

HTTP Status Code: 404

Examples

Example Request

Copy
GET /2013-04-01/healthcheck/018927304987/status

Example Response

Copy
HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <GetHealthCheckStatusResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <HealthCheckObservations> <HealthCheckObservation> <IPAddress>192.0.2.226</IPAddress> <Region>us-east-2</Region> <StatusReport> <Status>Success: HTTP Status Code: 200. Resolved IP: 192.0.2.2. OK</Status> <CheckedTime>2014-10-27T17:48:25.038Z</CheckedTime> </StatusReport> </HealthCheckObservation> <HealthCheckObservation> <IPAddress>192.0.2.56</IPAddress> <Region>us-west-1</Region> <StatusReport> <Status>Success: HTTP Status Code: 200. Resolved IP: 192.0.2.14. OK</Status> <CheckedTime>2014-10-27T17:48:16.751Z</CheckedTime> </StatusReport> </HealthCheckObservation> ... </HealthCheckObservations> </GetHealthCheckStatusResponse>

See Also

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