本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>API> コンピューティング> RegisterPortWithLoadBalancer

RegisterPortWithLoadBalancer

処理概要

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

ロードバランサーを指定するためには、ロードバランサー名が必要です。削除済みのロードバランサーを指定した、管理外のロードバランサーを指定したなど、無効なロードバランサーを指定した場合は、エラーが返されます。

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

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

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

  • API「SetFilterForLoadBalancer」(フィルター設定)

Listeners.member.n.Protocolは、指定した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 指定なし -> カスタム 70 70
    HTTPS 80 指定なし -> HTTP 80 80
    カスタム 80 指定なし -> HTTP 80 80

指定するパラメーター

パラメーター 説明 必須
LoadBalancerName string 対象のロードバランサー名
Listeners.member.n.Protocol string

追加するポートのプロトコル
LoadBalancerPortの値によって設定値と異なる場合があります(※1)


値: HTTP | HTTPS | FTP | 空 (カスタム)
○ (LoadBalancerPortといずれか)
Listeners.member.n.LoadBalancerPort integer 追加する待ち受けポート
Default: Protocolでの指定値による (80(Protocol=HTTP) | 443(Protocol=HTTPS) | 21(Protocol=FTP))
○ (Protocolといずれか)
Listeners.member.n.InstancePort integer 追加する宛先ポート
Default: Protocolでの指定値による (80(Protocol=HTTP) | 443(Protocol=HTTPS) | 21(Protocol=FTP))
Listeners.member.n.BalancingType integer 追加するポートのロードバランス方式
値: 1 (Round-Robin) | 2 (Least-Connection)
Default: 1

応答フィールド

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

リクエストサンプル

    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://cp.cloud.nifty.com/api/">
  <RegisterPortWithLoadBalancerResult>
    <Listeners>
      <member>
        <Protocol>HTTPS</Protocol>
        <LoadBalancerPort>443</LoadBalancerPort>
        <InstancePort>443</InstancePort>
        <BalancingType>2</BalancingType>
      </member>
    </Listeners>
  </RegisterPortWithLoadBalancerResult>
  <ResponseMetadata>
    <RequestId>f6dd8353-eb6b-6b4fd32e4f05</RequestId>
  </ResponseMetadata>
</RegisterPortWithLoadBalancerResponse>

  

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

推奨画面サイズ 1024×768 以上