ニフクラAPI (コンピューティング: RegisterPortWithLoadBalancer)

RegisterPortWithLoadBalancer

処理概要

指定したロードバランサーにポートを追加します。

ロードバランサーを指定するためには、ロードバランサー名が必要です。

ポートの追加に成功した場合は、以下のAPIを実行する必要があります。

• API「RegisterInstancesWithLoadBalancer」（サーバー設定）
• API「ConfigureHealthCheck」（ヘルスチェック設定）

フィルターの設定は、「すべてのアクセスを許可する」になっています。変更を行う場合は以下のAPIを実行する必要があります。

• API「SetFilterForLoadBalancer」（フィルター設定）

Listeners.member.n.ProtocolとListeners.member.n.LoadBalancerPortを両方指定した場合は、Listeners.member.n.LoadBalancerPortの指定が優先されます。

• (※1) Protocol・LoadBalancerPortの関連性は、以下を参考にしてください。

  Protocol	LoadBalancerPort	InstancePort		Protocol	LoadBalancerPort	InstancePort
  HTTP	指定なし	指定なし	->	HTTP	80	80
  HTTPS	指定なし	指定なし	->	HTTPS	443	443
  FTP	指定なし	指定なし	->	FTP	21	21
  HTTP	70	指定なし	->	空(HTTP/HTTPS/FTP以外)	70	70
  HTTPS	80	指定なし	->	HTTP	80	80
  空(HTTP/HTTPS/FTP以外)	80	指定なし	->	HTTP	80	80

指定するパラメーター

パラメーター	型	説明	必須
LoadBalancerName	string	対象のロードバランサー名	○
Listeners.member.n.Protocol	string	追加するポートのプロトコル LoadBalancerPortの値によって設定値と異なる場合があります（※1） 値: HTTP (LoadBalancerPort=80/InstancePort=80で設定される) HTTPS (LoadBalancerPort=443/InstancePort=443で設定される) FTP (LoadBalancerPort=21/InstancePort=21で設定される)	○ (LoadBalancerPortといずれか)
Listeners.member.n.LoadBalancerPort	integer	追加する待ち受けポート	○ (Protocolといずれか)
Listeners.member.n.InstancePort	integer	追加する宛先ポート Default: LoadBalancerPort で設定した値
Listeners.member.n.BalancingType	integer	追加するポートのロードバランス方式 値: 1 (Round-Robin) 2 (Least-Connection) Default: 1

応答フィールド

フィールド (項目)	型	説明
RegisterPortWithLoadBalancerResponse	-	RegisterPortWithLoadBalancer レスポンス
␣RegisterPortWithLoadBalancerResult	-	処理結果の情報セット
␣␣Listeners	-	追加に成功したポートの情報セット
␣␣␣member	-	追加に成功したポートの情報
␣␣␣␣Protocol	string	プロトコル
␣␣␣␣LoadBalancerPort	integer	待ち受けポート
␣␣␣␣InstancePort	integer	宛先ポート
␣␣␣␣BalancingType	integer	ロードバランス方式
␣ResponseMetadata	-	リクエスト情報
␣␣RequestId	string	リクエスト識別子

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/?
  Action=RegisterPortWithLoadBalancer
  &LoadBalancerName=lb0001
  &Listeners.member.1.Protocol=HTTPS
  &Listeners.member.1.BalancingType=2
  &CommonParams

  

応答サンプル

    <RegisterPortWithLoadBalancerResponse xmlns="https://computing.api.nifcloud.com/api/">
  <RegisterPortWithLoadBalancerResult>
    <Listeners>
      <member>
        <Protocol>HTTPS</Protocol>
        <BalancingType>2</BalancingType>
      </member>
    </Listeners>
  </RegisterPortWithLoadBalancerResult>
  <ResponseMetadata>
    <RequestId>f6dd8353-eb6b-6b4fd32e4f05</RequestId>
  </ResponseMetadata>
</RegisterPortWithLoadBalancerResponse>