hatoba / Client / get_load_balancer

get_load_balancer

hatoba.Client.get_load_balancer(**kwargs)

ロードバランサーの情報を取得します。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.get_load_balancer(
    InstancePort=123,
    LoadBalancerName='string',
    LoadBalancerPort=123
)

Parameters:

• InstancePort (integer) – [REQUIRED]

• LoadBalancerName (string) – [REQUIRED]

• LoadBalancerPort (integer) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'LoadBalancers': {
        'AccountingType': 123,
        'AvailabilityZones': [
            'string',
        ],
        'Clusters': [
            {
                'Name': 'string',
                'NodePools': [
                    {
                        'Name': 'string',
                        'NodeCount': 123,
                        'Nodes': [
                            {
                                'AvailabilityZone': 'string',
                                'HealthCheckState': 'string',
                                'Name': 'string',
                                'PublicIpAddress': 'string'
                            },
                        ]
                    },
                ]
            },
        ],
        'CreatedTime': 'string',
        'Description': 'string',
        'DnsName': 'string',
        'Filter': {
            'FilterType': 'string',
            'IpAddresses': 'string'
        },
        'HealthCheck': {
            'HealthyThreshold': 123,
            'Interval': 123,
            'Target': 'string',
            'Timeout': 123,
            'UnhealthyThreshold': 123
        },
        'ListenerDescriptions': [
            {
                'Listener': {
                    'BalancingType': 'string',
                    'InstancePort': 'string',
                    'LoadBalancerPort': 'string',
                    'Protocol': 'string',
                    'SslCertificateId': 'string'
                }
            },
        ],
        'LoadBalancerName': 'string',
        'NetworkVolume': 'string',
        'NextMonthAccountingType': 123,
        'Option': {
            'SessionStickinessPolicy': {
                'Enabled': True|False,
                'ExpirationPeriod': 123
            },
            'SorryPage': {
                'Enabled': True|False,
                'StatusCode': 123
            }
        },
        'PolicyType': 'string'
    }
}

Response Structure

• (dict) –

  • LoadBalancers (dict) –

    • AccountingType (integer) –

    • AvailabilityZones (list) –

      • (string) –

    • Clusters (list) –

      • (dict) –

        • Name (string) –

        • NodePools (list) –

          • (dict) –

            • Name (string) –

            • NodeCount (integer) –

            • Nodes (list) –

              • (dict) –

                • AvailabilityZone (string) –

                • HealthCheckState (string) –

                • Name (string) –

                • PublicIpAddress (string) –

    • CreatedTime (string) –

    • Description (string) –

    • DnsName (string) –

    • Filter (dict) –

      • FilterType (string) –

      • IpAddresses (string) –

    • HealthCheck (dict) –

      • HealthyThreshold (integer) –

      • Interval (integer) –

      • Target (string) –

      • Timeout (integer) –

      • UnhealthyThreshold (integer) –

    • ListenerDescriptions (list) –

      • (dict) –

        • Listener (dict) –

          • BalancingType (string) –

          • InstancePort (string) –

          • LoadBalancerPort (string) –

          • Protocol (string) –

          • SslCertificateId (string) –

    • LoadBalancerName (string) –

    • NetworkVolume (string) –

    • NextMonthAccountingType (integer) –

    • Option (dict) –

      • SessionStickinessPolicy (dict) –

        • Enabled (boolean) –

        • ExpirationPeriod (integer) –

      • SorryPage (dict) –

        • Enabled (boolean) –

        • StatusCode (integer) –

    • PolicyType (string) –