computing / Client / nifty_describe_elastic_load_balancers

nifty_describe_elastic_load_balancers

computing.Client.nifty_describe_elastic_load_balancers(**kwargs)

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

マルチロードバランサーを指定するためには、マルチロードバランサー名または、マルチロードバランサーユニークID・プロトコル・待ち受けポート番号・宛先ポート番号が必要です。マルチロードバランサーを指定しない場合は、取得可能なすべてのマルチロードバランサー情報を取得します。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_describe_elastic_load_balancers(
    ElasticLoadBalancers={
        'ListOfRequestElasticLoadBalancerId': [
            'string',
        ],
        'ListOfRequestElasticLoadBalancerName': [
            'string',
        ],
        'ListOfRequestElasticLoadBalancerPort': [
            123,
        ],
        'ListOfRequestInstancePort': [
            123,
        ],
        'ListOfRequestProtocol': [
            'string',
        ]
    },
    Filter=[
        {
            'ListOfRequestValue': [
                'string',
            ],
            'Name': 'availability-zone'|'state'|'elastic-loadbalancer-id'|'elastic-loadbalancer-name'|'description'|'accounting-type'|'ip-address'|'version'
        },
    ]
)

Parameters:

• ElasticLoadBalancers (dict) –

  • ListOfRequestElasticLoadBalancerId (list) –

    • (string) –

  • ListOfRequestElasticLoadBalancerName (list) –

    • (string) –

  • ListOfRequestElasticLoadBalancerPort (list) –

    • (integer) –

  • ListOfRequestInstancePort (list) –

    • (integer) –

  • ListOfRequestProtocol (list) –

    • (string) –

• Filter (list) –

  • (dict) –

    • ListOfRequestValue (list) –

      • (string) –

    • Name (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NiftyDescribeElasticLoadBalancersResult': {
        'ElasticLoadBalancerDescriptions': [
            {
                'AccountingType': 'string',
                'AvailabilityZones': [
                    'string',
                ],
                'CreatedTime': datetime(2015, 1, 1),
                'DNSName': 'string',
                'ElasticLoadBalancerId': 'string',
                'ElasticLoadBalancerListenerDescriptions': [
                    {
                        'Listener': {
                            'BalancingType': 123,
                            'Description': 'string',
                            'ElasticLoadBalancerPort': 123,
                            'HealthCheck': {
                                'Expectation': [
                                    {
                                        'HttpCode': 'string'
                                    },
                                ],
                                'InstanceStates': [
                                    {
                                        'Description': 'string',
                                        'InstanceId': 'string',
                                        'InstanceUniqueId': 'string',
                                        'ReasonCode': 'string',
                                        'State': 'string'
                                    },
                                ],
                                'Interval': 123,
                                'Path': 'string',
                                'Target': 'string',
                                'UnhealthyThreshold': 123
                            },
                            'InstancePort': 123,
                            'Instances': [
                                {
                                    'InstanceId': 'string',
                                    'InstanceUniqueId': 'string'
                                },
                            ],
                            'Protocol': 'string',
                            'SSLCertificateId': 'string',
                            'SessionStickinessPolicy': {
                                'Enabled': True|False,
                                'ExpirationPeriod': 123,
                                'Method': 123
                            },
                            'SorryPage': {
                                'Enabled': True|False,
                                'RedirectUrl': 'string'
                            }
                        }
                    },
                ],
                'ElasticLoadBalancerName': 'string',
                'NetworkInterfaces': [
                    {
                        'Description': 'string',
                        'DeviceIndex': 'string',
                        'IpAddress': 'string',
                        'IsVipNetwork': True|False,
                        'NetworkId': 'string',
                        'NetworkName': 'string',
                        'SystemIpAddresses': [
                            {
                                'SystemIpAddress': 'string'
                            },
                        ]
                    },
                ],
                'NetworkVolume': 'string',
                'NextMonthAccountingType': 'string',
                'RouteTableAssociationId': 'string',
                'RouteTableId': 'string',
                'State': 'string',
                'VersionInformation': {
                    'IsLatest': True|False,
                    'Version': 'string'
                }
            },
        ]
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

• (dict) –

  • NiftyDescribeElasticLoadBalancersResult (dict) –

    • ElasticLoadBalancerDescriptions (list) –

      • (dict) –

        • AccountingType (string) –

        • AvailabilityZones (list) –

          • (string) –

        • CreatedTime (datetime) –

        • DNSName (string) –

        • ElasticLoadBalancerId (string) –

        • ElasticLoadBalancerListenerDescriptions (list) –

          • (dict) –

            • Listener (dict) –

              • BalancingType (integer) –

              • Description (string) –

              • ElasticLoadBalancerPort (integer) –

              • HealthCheck (dict) –

                • Expectation (list) –

                  • (dict) –

                    • HttpCode (string) –

                • InstanceStates (list) –

                  • (dict) –

                    • Description (string) –

                    • InstanceId (string) –

                    • InstanceUniqueId (string) –

                    • ReasonCode (string) –

                    • State (string) –

                • Interval (integer) –

                • Path (string) –

                • Target (string) –

                • UnhealthyThreshold (integer) –

              • InstancePort (integer) –

              • Instances (list) –

                • (dict) –

                  • InstanceId (string) –

                  • InstanceUniqueId (string) –

              • Protocol (string) –

              • SSLCertificateId (string) –

              • SessionStickinessPolicy (dict) –

                • Enabled (boolean) –

                • ExpirationPeriod (integer) –

                • Method (integer) –

              • SorryPage (dict) –

                • Enabled (boolean) –

                • RedirectUrl (string) –

        • ElasticLoadBalancerName (string) –

        • NetworkInterfaces (list) –

          • (dict) –

            • Description (string) –

            • DeviceIndex (string) –

            • IpAddress (string) –

            • IsVipNetwork (boolean) –

            • NetworkId (string) –

            • NetworkName (string) –

            • SystemIpAddresses (list) –

              • (dict) –

                • SystemIpAddress (string) –

        • NetworkVolume (string) –

        • NextMonthAccountingType (string) –

        • RouteTableAssociationId (string) –

        • RouteTableId (string) –

        • State (string) –

        • VersionInformation (dict) –

          • IsLatest (boolean) –

          • Version (string) –

  • ResponseMetadata (dict) –

    • RequestId (string) –