Gets the current health status (Healthy
, Unhealthy
, or Unknown
) of
one or more instances that are associated with a specified service.
servicediscovery_get_instances_health_status(ServiceId, Instances,
MaxResults, NextToken)
[required] The ID of the service that the instance is associated with.
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.
To get the IDs for the instances that you\'ve registered by using a specified service, submit a ListInstances request.
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.
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.
svc$get_instances_health_status( ServiceId = "string", Instances = list( "string" ), MaxResults = 123, NextToken = "string" )
There is a brief delay between when you register an instance and when the health status for the instance is available.