RegisterInstancesWithLoadBalancer

Description

ロードバランサーに分散先となるインスタンスを登録します。

インスタンスを登録すると負荷分散を行います。

ロードバランサーに登録された分散先インスタンスのIPアドレスを変更しても、新しいIPアドレスに対し負荷分散されません。

DHCP有効状態での分散先インスタンス再起動、DHCP無効状態での利用者設定による分散先インスタンスのIPアドレス変更などのIPアドレスの変更が伴う操作を実施された場合、対象の分散先インスタンスをロードバランサ―から削除し、再登録する必要があります。

ロードバランサーに分散先となるインスタンスを登録する場合、インスタンスを起動してからにしてください。

ロードバランサーから登録した分散先インスタンスを削除する場合は、DeregisterInstancesFromLoadBalancerを使用してください。

本APIは、ロードバランサーを作成したアカウントと同一のプロジェクトに属するアカウントで発行してください。

登録された分散先インスタンスの状態はDescribeLoadBalancersで確認できます。

Request Parameters

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

  • Instances.member.N

    ロードバランサーに登録するインスタンスIDのリスト。

    • Type: Instance list
    • Required: Yes
  • LoadBalancerName

    インスタンスを登録するロードバランサーの名前。

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

    • Type: String
    • Required: Yes

Response

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

  • Normal response code

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

    • HTTP Status Code: 200

Response Elements

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

  • Instances

    ロードバランサーの分散先インスタンスの更新後のリスト。

Errors

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

  • AccessPointNotFound

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

    • HTTP Status Code: 400
  • InvalidEndPoint

    指定したエンドポイントは無効です。

    • HTTP Status Code: 400
  • InvalidConfigurationRequest

    要求された構成変更は不正です。

    • HTTP Status Code: 409

Examples

Sample Request

この例では、ロードバランサー名が MyLB01 のロードバランサーに、 インスタンスIDが i-315b7e51 の分散先インスタンスを登録します。


https://loadbalancing.(リージョン名).cloud.global.fujitsu.com/?Instances.member.1.InstanceId=i-315b7e51
&LoadBalancerName=MyLB01
&Version=2014-11-01
&Action=RegisterInstancesWithLoadBalancer   
     

この例では、ロードバランサー名がMyLB01のロードバランサーに、インスタンスIDがi-315b7e51でポートIDがp-315b7e51の分散先インスタンスを登録します。


https://loadbalancing.(リージョン名).cloud.global.fujitsu.com/?Instances.member.1.InstanceId=i-315b7e51
&Instances.member.1.PortId=p-315b7e51
&LoadBalancerName=MyLB01
&Version=2014-11-01
&Action=RegisterInstancesWithLoadBalancer       
     

Sample Response (XML)


<RegisterInstancesWithLoadBalancerResponse xmlns=" http://docs.cloudcommunity.global.fujitsu.com/loadbalancing/api/v1.0">
  <RegisterInstancesWithLoadBalancerResult>
    <Instances>
      <member>
        <InstanceId>i-712cde1e</InstanceId>
      </member>
      <member>
        <InstanceId>i-315b7e51</InstanceId>
        <PortId>p-315b7e51</PortId>
      </member>
    </Instances>
  </RegisterInstancesWithLoadBalancerResult>
  <ResponseMetadata>
    <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>
  </ResponseMetadata>
</RegisterInstancesWithLoadBalancerResponse>     
     

Sample Response (JSON)


{
  "RegisterInstancesWithLoadBalancerResponse": {
    "RegisterInstancesWithLoadBalancerResult": {
      "Instances": {
        "member": [
          {
           "InstanceId": "i-712cde1e"
          },
          {
           "InstanceId": "i-315b7e51"
           "PortId": "p-315b7e51"
          }
        ]
      }
    },
    "ResponseMetadata": {
      "RequestId": "83c88b9d-12b7-11e3-8b82-87b12EXAMPLE"
    }
  }
}