ConfigureHealthCheck

Description

Specifies the health check settings to use when evaluating the health state of the distribution destination instances of the specified load balancer.

If you do not specify the health check settings in the API, the following settings will be used:
Interval:
30
Timeout:
5
HealthyThreshold:
10
UnhealthyThreshold:
2
Target:
protocol:port[url]

protocol: Value of InstanceProtocol of the listener.

port: Value of InstancePort of the listener.

url: / when the protocol is HTTP or HTTPS.

Request Parameters

Refer to "Common Parameters" for details on standard parameter information used by all actions.

  • LoadBalancerName

    Name of the load balancer.

    The name must be unique among the load balancers in the projects to which the account belongs.

    • Type: String
    • Required: Yes
  • HealthCheck

    Setting information for the health check.

    The protocol and port number to be specified for the target of HealthCheck must match the InstanceProtocol and InstancePort specified in Listener of the load balancer with the name specified in LoadBalancerName.

Response

The following status code is returned.

  • Normal response code

    This operation was accepted normally.

    • HTTP Status Code: 200

Response Elements

The following element is returned in a structure called ConfigureHealthCheckResult.

  • HealthCheck

    Health check information that is updated for distribution destination instances

Errors

Refer to "Common Errors" for details on error information common to all operations.

  • AccessPointNotFound

    The specified load balancer could not be found

    • HTTP Status Code: 400

Examples

Sample Request

The example below configures a health check target of HTTP:80/ping, implementation interval of 30 seconds, response timeout of 3 seconds, failure decision threshold of 2 times, and restore decision threshold of 2 times, for the distribution destination instances of the load balancer named MyLB01.


https://loadbalancing.(regionName).cloud.global.fujitsu.com/?HealthCheck.HealthyThreshold=2
&HealthCheck.UnhealthyThreshold=2
&HealthCheck.Target=HTTP:80
&HealthCheck.Interval=30
&HealthCheck.Timeout=3
&LoadBalancerName=MyLB01
&Version=2014-11-01
&Action=ConfigureHealthCheck

Sample response (XML)


<ConfigureHealthCheckResponse xmlns=" http://docs.cloudcommunity.global.fujitsu.com/loadbalancing/api/v1.0">
  <ConfigureHealthCheckResult>
    <HealthCheck>
      <Interval>30</Interval>
      <Target>HTTP:80</Target>
      <HealthyThreshold>2</HealthyThreshold>
      <Timeout>3</Timeout>
      <UnhealthyThreshold>2</UnhealthyThreshold>
    </HealthCheck>
  </ConfigureHealthCheckResult>
  <ResponseMetadata>
    <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>
  </ResponseMetadata>
</ConfigureHealthCheckResponse>

Sample Response (JSON)


{
  "ConfigureHealthCheckResponse": {
    "ConfigureHealthCheckResult": {
      "HealthCheck": {
        "Interval": "30",
        "Target": "HTTP:80",
        "HealthyThreshold": "2",
        "Timeout": "3",
        "UnhealthyThreshold": "2"
      }
    },
    "ResponseMetadata": {
      "RequestId": "83c88b9d-12b7-11e3-8b82-87b12EXAMPLE"
    }
  }
}