Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetInstancesHealthStatus

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

Note

There's a brief delay between when you register an instance and when the health status for the instance is available.

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.

If you omit Instances, AWS Cloud Map returns the health status for all the instances that are associated with the specified service.

Note

To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.

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 AWS Cloud Map to return in the response to a GetInstancesHealthStatus request. If you don't specify a value for MaxResults, AWS Cloud Map 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

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, or the instance was recently registered, and information about the instance hasn't propagated yet.

HTTP Status Code: 400

InvalidInput

One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.

HTTP Status Code: 400

ServiceNotFound

No service exists with the specified ID.

HTTP Status Code: 400

Examples

GetInstancesHealthStatus Example

This example illustrates one usage of GetInstancesHealthStatus.

Sample Request


POST / HTTP/1.1
host:servicediscovery.us-west-2.amazonaws.com
x-amz-date:20181118T211818Z
authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20181118/us-west-2/servicediscovery/aws4_request,
               SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,
               Signature=[calculated-signature]
x-amz-target:Route53AutoNaming_v20170314.GetInstancesHealthStatus
content-type:application/x-amz-json-1.1
content-length:[number of characters in the JSON string]

{
    "ServiceId": "srv-e4anhexample0004"
}

Sample Response


HTTP/1.1 200
Content-Length: [number of characters in the JSON string]
Content-Type: application/x-amz-json-1.1

{
    "Status": {
        "i-abcd1234": "HEALTHY",
        "i-abcd1235": "UNHEALTHY"
    }
}