computing / Client / register_instances_with_load_balancer

register_instances_with_load_balancer

computing.Client.register_instances_with_load_balancer(**kwargs)

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

ロードバランサーを指定するためには、ロードバランサー名・ポート番号が必要です。自分が所有していないロードバランサーを指定する場合は、「ニフクラID.ロードバランサー名」の形式で指定する必要があります。

またサーバーを指定するためには、サーバー名が必要です。IPアドレスを固定化しているサーバーを指定できます。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.register_instances_with_load_balancer(
    InstancePort=123,
    Instances=[
        {
            'InstanceId': 'string'
        },
    ],
    LoadBalancerName='string',
    LoadBalancerPort=123
)
Parameters:
  • InstancePort (integer) – [REQUIRED]

  • Instances (list) –

    [REQUIRED]

    • (dict) –

      • InstanceId (string) – [REQUIRED]

  • LoadBalancerName (string) – [REQUIRED]

  • LoadBalancerPort (integer) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'RegisterInstancesWithLoadBalancerResult': {
        'Instances': [
            {
                'InstanceId': 'string',
                'InstanceUniqueId': 'string'
            },
        ]
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –

    • RegisterInstancesWithLoadBalancerResult (dict) –

      • Instances (list) –

        • (dict) –

          • InstanceId (string) –

          • InstanceUniqueId (string) –

    • ResponseMetadata (dict) –

      • RequestId (string) –