/AWS1/CL_SDY=>GETINSTANCESHEALTHSTATUS()
¶
About GetInstancesHealthStatus¶
Gets the current health status (Healthy
, Unhealthy
, or Unknown
) of
one or more instances that are associated with a specified service.
There's a brief delay between when you register an instance and when the health status for the instance is available.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_SERVICEID
TYPE /AWS1/SDYRESOURCEID
/AWS1/SDYRESOURCEID
¶
The ID of the service that the instance is associated with.
Optional arguments:¶
IT_INSTANCES
TYPE /AWS1/CL_SDYINSTANCEIDLIST_W=>TT_INSTANCEIDLIST
TT_INSTANCEIDLIST
¶
An array that contains the IDs of all the instances that you want to get the health status for.
If you omit
Instances
, 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.
IV_MAXRESULTS
TYPE /AWS1/SDYMAXRESULTS
/AWS1/SDYMAXRESULTS
¶
The maximum number of instances that you want Cloud Map to return in the response to a
GetInstancesHealthStatus
request. If you don't specify a value forMaxResults
, Cloud Map returns up to 100 instances.
IV_NEXTTOKEN
TYPE /AWS1/SDYNEXTTOKEN
/AWS1/SDYNEXTTOKEN
¶
For the first
GetInstancesHealthStatus
request, omit this value.If more than
MaxResults
instances match the specified criteria, you can submit anotherGetInstancesHealthStatus
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.