ConfigureHealthCheck
Description
This API enables you to define an application healthcheck for the instances.
![[Note]](note.png) | Note |
|---|---|
Completion of this API does not guarantee that operation has completed. Rather, it means that the request has been registered and the changes will happen shortly. |
Request Parameters
| Name | Description | Required |
|---|---|---|
|
|
The mnemonic name associated with the LoadBalancer. The name must be unique within your AWS account. Type: String Default: None Constraints: Must only use alphanumeric characters (case sensitive) and dash (-). Dash cannot be first or last character. Maximum length of name is 32 characters (characters are 16-bit Unicode). |
Yes |
|
|
Structure containing the configuration information for the new healthcheck. Type: |
Yes
Response Elements
| Name | Description |
|---|---|
|
|
Updated healthcheck for the instances. Type: HealthCheck Availability: Always returned |
Special Errors
Common errors for all calls are listed and described in a separate section, please see API Error Codes.
| Error | Description | HTTP Status Code | SOAP Prefix |
|---|---|---|---|
|
LoadBalancerNotFound |
LoadBalancer name does not exist for the account in this region. (For more information, please see LoadBalancer.) |
400 Bad Request | Client |
|
ValidationError |
One or more input parameters are invalid. |
400 Bad Request | Client |
Examples
Sample Request
Example Request (Query)
https://elasticloadbalancing.amazonaws.com/
?SignatureVersion=2
&Action=ConfigureHealthCheck
&Version=2009-05-15
&HealthCheck.Timeout=2
&HealthCheck.Target=HTTP%3A80%2Fservlets-examples%2Fservlet
&HealthCheck.Interval=5
&HealthCheck.UnhealthyThreshold=2
&HealthCheck.HealthyThreshold=2
&LoadBalancerName=manual010AP
&Timestamp=2009-02-09T22%3A26%3A28.000Z
&AWSAccessKeyId=XXX YOUR ACCESS KEY XXX
&Signature=%XXX YOUR SIGNATURE XXX%3D
Sample Response
Example Query Response
<ConfigureHealthCheckResult>
<HealthCheck>
<Interval>5</Interval>
<Target>HTTP:80/servlets-examples/servlet/</Target>
<HealthyThreshold>2</HealthyThreshold>
<Timeout>2</Timeout>
<UnhealthyThreshold>2</UnhealthyThreshold>
</HealthCheck>
</ConfigureHealthCheckResult>
Related Operations
The following operations also return information on the LoadBalancer and/or its instances.