Request Syntax Request Parameters Response Elements Errors Examples See Also

UpdateInstanceCustomHealthStatus

Submits a request to change the health status of a custom health check to healthy or unhealthy.

You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig.

For more information, see HealthCheckCustomConfig.

Request Syntax


{
   "InstanceId": "string",
   "ServiceId": "string",
   "Status": "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.

InstanceId

The ID of the instance that you want to change the health status for.

Type: String

Length Constraints: Maximum length of 64.

Required: Yes

ServiceId

The ID of the service that includes the configuration for the custom health check that you want to change the status for.

Type: String

Length Constraints: Maximum length of 64.

Required: Yes

Status

The new status of the instance, HEALTHY or UNHEALTHY.

Type: String

Valid Values: HEALTHY | UNHEALTHY

Required: Yes

Response Elements

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

Errors

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

CustomHealthNotFound

The health check for the instance that's specified by ServiceId and InstanceId isn't a custom health check.

HTTP Status Code: 400

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

UpdateInstanceCustomHealthStatus Example

This example illustrates one usage of UpdateInstanceCustomHealthStatus.

Sample Request


POST / HTTP/1.1
host:data-servicediscovery.us-west-2.amazonaws.com
x-amz-date:20181118T211819Z
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.DiscoverInstances
content-type:application/x-amz-json-1.1
content-length:[number of characters in the JSON string]

{
    "InstanceId": "i-abcd1234",
    "ServiceId": "srv-e4anhexample0004",
    "Status": "HEALTHY"
}

Sample Response


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