ConfigureHealthCheck

Description

指定したロードバランサーの分散先インスタンスの状態を評価するヘルスチェック情報を設定します。

Request Parameters

すべての動作で使用する一般的なパラメタの情報に関しては、「Common Parameters」を参照してください。

• LoadBalancerName

  ロードバランサーの名前。

  名前はあなたのアカウントが属するプロジェクト内のロードバランサーの中で一意にする必要があります。

  • Type: String
  • Required: Yes
• HealthCheck

  ヘルスチェックのための設定情報。

  HealthCheckのtargetに指定するプロトコルとポート番号は、ロードバランサー名がLoadBalancerNameのロードバランサーのListenerに指定されたInstanceProtocolおよびInstancePortと一致させる必要があります。

  • Type: HealthCheck
  • Required: Yes

Response

以下のステータスコードを返却します。

• Normal response code

  本動作は正常に受け付けられました。

  • HTTP Status Code: 200

Response Elements

ConfigureHealthCheckResultという構造体で、以下の要素を返却します。

• HealthCheck

  分散先インスタンスに対して更新されたヘルスチェック情報

  • Type: HealthCheck

Errors

すべての動作に共通のエラー情報に関しては、「Common Errors」を参照してください。

• AccessPointNotFound

  指定したロードバランサーが見つかりませんでした。

  • HTTP Status Code: 400

Examples

Sample Request

この例では、ロードバランサー名がMyLB01のロードバランサーの分散先インスタンスに対して、ヘルスチェック対象をHTTP:80/ping、実施時間間隔30秒、応答タイムアウト時間3秒、故障判断の閾値2回、復旧判断の閾値2回で、ヘルスチェックするように設定します。

https://loadbalancing.(リージョン名).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"
    }
  }
}