computing / Client / register_port_with_load_balancer

register_port_with_load_balancer

computing.Client.register_port_with_load_balancer(**kwargs)

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

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

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

  • API「RegisterInstancesWithLoadBalancer」(サーバー設定)

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

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

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

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

See also: NIFCLOUD API Documentation

Request Syntax

response = client.register_port_with_load_balancer(
    Listeners=[
        {
            'BalancingType': 123,
            'InstancePort': 123,
            'LoadBalancerPort': 123,
            'Protocol': 'HTTP'|'HTTPS'|'FTP'
        },
    ],
    LoadBalancerName='string'
)
Parameters:
  • Listeners (list) –

    • (dict) –

      • BalancingType (integer) –

      • InstancePort (integer) –

      • LoadBalancerPort (integer) –

      • Protocol (string) –

  • LoadBalancerName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'RegisterPortWithLoadBalancerResult': {
        'Listeners': [
            {
                'BalancingType': 123,
                'InstancePort': 123,
                'LoadBalancerPort': 123,
                'Protocol': 'string'
            },
        ]
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –

    • RegisterPortWithLoadBalancerResult (dict) –

      • Listeners (list) –

        • (dict) –

          • BalancingType (integer) –

          • InstancePort (integer) –

          • LoadBalancerPort (integer) –

          • Protocol (string) –

    • ResponseMetadata (dict) –

      • RequestId (string) –