Menu
Amazon Route 53
API Reference

GetInstancesHealthStatus

Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.

Request Syntax

{ "Instances": [ "string" ], "MaxResults": number, "NextToken": "string", "ServiceId": "string" }

Request Parameters

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

The request accepts the following data in JSON format.

Instances

An array that contains the IDs of all the instances that you want to get the health status for. To get the IDs for the instances that you've created by using a specified service, submit a ListInstances request.

If you omit Instances, Amazon Route 53 returns the health status for all the instances that are associated with the specified service.

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Maximum length of 64.

Required: No

MaxResults

The maximum number of instances that you want Amazon Route 53 to return in the response to a GetInstancesHealthStatus request. If you don't specify a value for MaxResults, Amazon Route 53 returns up to 100 instances.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

For the first GetInstancesHealthStatus request, omit this value.

If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

Type: String

Length Constraints: Maximum length of 4096.

Required: No

ServiceId

The ID of the service that the instance is associated with.

Type: String

Length Constraints: Maximum length of 64.

Required: Yes

Response Syntax

{ "NextToken": "string", "Status": { "string" : "string" } }

Response Elements

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

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

NextToken

If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

Type: String

Length Constraints: Maximum length of 4096.

Status

A complex type that contains the IDs and the health status of the instances that you specified in the GetInstancesHealthStatus request.

Type: String to string map

Key Length Constraints: Maximum length of 64.

Valid Values: HEALTHY | UNHEALTHY | UNKNOWN

Errors

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

InstanceNotFound

No instance exists with the specified ID.

HTTP Status Code: 400

InvalidInput

One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name might not be a valid DNS name.

HTTP Status Code: 400

ServiceNotFound

No service exists with the specified ID.

HTTP Status Code: 400

See Also

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