computing / Client / describe_load_balancers

describe_load_balancers

computing.Client.describe_load_balancers(**kwargs)

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

ロードバランサーを指定するためには、ロードバランサー名が必要です。ロードバランサーを指定しない場合は、取得可能なすべてのロードバランサー情報を取得します。

ヘルスチェックの際のサーバー切り離し時間について

• サーバーからの応答時間がタイムアウトを超えた場合にサーバーをロードバランサーから切り離します。

• 設定されるヘルスチェックのタイムアウト時間については、 `ロードバランサー（L4）のヘルスチェックについて <https://docs.nifcloud.com/network/spec/lb/index.htm#lb_healthcheck>`__をご確認ください。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_load_balancers(
    LoadBalancerNames=[
        {
            'InstancePort': 123,
            'LoadBalancerName': 'string',
            'LoadBalancerPort': 123
        },
    ],
    Owner='self'|'other'|'all'
)

Parameters:

• LoadBalancerNames (list) –

  • (dict) –

    • InstancePort (integer) –

    • LoadBalancerName (string) –

    • LoadBalancerPort (integer) –

• Owner (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DescribeLoadBalancersResult': {
        'LoadBalancerDescriptions': [
            {
                'AccountingType': 'string',
                'AvailabilityZones': [
                    'string',
                ],
                'CreatedTime': datetime(2015, 1, 1),
                'DNSName': 'string',
                'Description': 'string',
                'Filter': {
                    'FilterType': 'string',
                    'IPAddresses': [
                        {
                            'IPAddress': 'string'
                        },
                    ]
                },
                'HealthCheck': {
                    'HealthyThreshold': 123,
                    'InstanceStates': [
                        {
                            'Description': 'string',
                            'InstanceId': 'string',
                            'InstanceUniqueId': 'string',
                            'ReasonCode': 'string',
                            'State': 'string'
                        },
                    ],
                    'Interval': 123,
                    'Target': 'string',
                    'Timeout': 123,
                    'UnhealthyThreshold': 123
                },
                'Instances': [
                    {
                        'InstanceId': 'string',
                        'InstanceUniqueId': 'string'
                    },
                ],
                'ListenerDescriptions': [
                    {
                        'Listener': {
                            'BalancingType': 123,
                            'InstancePort': 123,
                            'LoadBalancerPort': 123,
                            'Protocol': 'string',
                            'SSLCertificateId': 'string',
                            'SSLPolicy': {
                                'SSLPolicyId': 'string',
                                'SSLPolicyName': 'string'
                            }
                        }
                    },
                ],
                'LoadBalancerName': 'string',
                'NetworkVolume': 123,
                'NextMonthAccountingType': 'string',
                'Option': {
                    'SessionStickinessPolicy': {
                        'Enabled': True|False,
                        'ExpirationPeriod': 123
                    },
                    'SorryPage': {
                        'Enabled': True|False,
                        'StatusCode': 123
                    }
                },
                'Policies': {
                    'AppCookieStickinessPolicies': [
                        {
                            'CookieName': 'string',
                            'PolicyName': 'string'
                        },
                    ],
                    'LBCookieStickinessPolicies': [
                        {
                            'CookieExpirationPeriod': 'string',
                            'PolicyName': 'string'
                        },
                    ]
                },
                'PolicyType': 'string'
            },
        ]
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

• (dict) –

  • DescribeLoadBalancersResult (dict) –

    • LoadBalancerDescriptions (list) –

      • (dict) –

        • AccountingType (string) –

        • AvailabilityZones (list) –

          • (string) –

        • CreatedTime (datetime) –

        • DNSName (string) –

        • Description (string) –

        • Filter (dict) –

          • FilterType (string) –

          • IPAddresses (list) –

            • (dict) –

              • IPAddress (string) –

        • HealthCheck (dict) –

          • HealthyThreshold (integer) –

          • InstanceStates (list) –

            • (dict) –

              • Description (string) –

              • InstanceId (string) –

              • InstanceUniqueId (string) –

              • ReasonCode (string) –

              • State (string) –

          • Interval (integer) –

          • Target (string) –

          • Timeout (integer) –

          • UnhealthyThreshold (integer) –

        • Instances (list) –

          • (dict) –

            • InstanceId (string) –

            • InstanceUniqueId (string) –

        • ListenerDescriptions (list) –

          • (dict) –

            • Listener (dict) –

              • BalancingType (integer) –

              • InstancePort (integer) –

              • LoadBalancerPort (integer) –

              • Protocol (string) –

              • SSLCertificateId (string) –

              • SSLPolicy (dict) –

                • SSLPolicyId (string) –

                • SSLPolicyName (string) –

        • LoadBalancerName (string) –

        • NetworkVolume (integer) –

        • NextMonthAccountingType (string) –

        • Option (dict) –

          • SessionStickinessPolicy (dict) –

            • Enabled (boolean) –

            • ExpirationPeriod (integer) –

          • SorryPage (dict) –

            • Enabled (boolean) –

            • StatusCode (integer) –

        • Policies (dict) –

          • AppCookieStickinessPolicies (list) –

            • (dict) –

              • CookieName (string) –

              • PolicyName (string) –

          • LBCookieStickinessPolicies (list) –

            • (dict) –

              • CookieExpirationPeriod (string) –

              • PolicyName (string) –

        • PolicyType (string) –

  • ResponseMetadata (dict) –

    • RequestId (string) –