AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to GetInstancesHealthStatusAsync.

Namespace: Amazon.ServiceDiscovery
Assembly: AWSSDK.ServiceDiscovery.dll
Version: 3.x.y.z

Syntax

C#
public abstract GetInstancesHealthStatusResponse GetInstancesHealthStatus(
         GetInstancesHealthStatusRequest request
)

Parameters

request
Type: Amazon.ServiceDiscovery.Model.GetInstancesHealthStatusRequest

Container for the necessary parameters to execute the GetInstancesHealthStatus service method.

Return Value


The response from the GetInstancesHealthStatus service method, as returned by ServiceDiscovery.

Exceptions

ExceptionCondition
InstanceNotFoundException No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
InvalidInputException 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.
ServiceNotFoundException No service exists with the specified ID.

Examples

This example gets the current health status of one or more instances that are associate with a specified service.

GetInstancesHealthStatus example


var client = new AmazonServiceDiscoveryClient();
var response = client.GetInstancesHealthStatus(new GetInstancesHealthStatusRequest 
{
    ServiceId = "srv-e4anhexample0004"
});

Dictionary<string, string> status = response.Status;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also