computing / Client / nifty_describe_private_lans

nifty_describe_private_lans

computing.Client.nifty_describe_private_lans(**kwargs)

指定されたプライベートLANの情報を取得します。

プライベートLANを指定するためには、ネットワークユニークIDまたはプライベートLAN名が必要です。

プライベートLANを指定しない場合、取得できるすべてのプライベートLAN情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字（曖昧検索）指定可能です。「∗」は0個以上任意文字、「?」は1個任意文字、「¥」はエスケープ変換文字（「¥∗nifty¥?¥¥」は「∗nifty?¥」を検索）となります。

曖昧検索が指定可能な絞り込み条件の項目名は、private-lan-name、descriptionになります。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_describe_private_lans(
    Filter=[
        {
            'ListOfRequestValue': [
                'string',
            ],
            'Name': 'availabilityZone, availability-zone'|'cidrBlock, cidr, cidr-block'|'state'|'network-id'|'private-lan-name'|'accountingType'|'description'
        },
    ],
    NetworkId=[
        'string',
    ],
    PrivateLanName=[
        'string',
    ]
)

Parameters:

• Filter (list) –

  • (dict) –

    • ListOfRequestValue (list) –

      • (string) –

    • Name (string) –

• NetworkId (list) –

  • (string) –

• PrivateLanName (list) –

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'PrivateLanSet': [
        {
            'AccountingType': 'string',
            'AvailabilityZone': 'string',
            'CidrBlock': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'Description': 'string',
            'ElasticLoadBalancingSet': [
                {
                    'ElasticLoadBalancerName': 'string',
                    'ElasticLoadBalancerPort': 123,
                    'InstancePort': 123,
                    'Protocol': 'string'
                },
            ],
            'InstancesSet': [
                {
                    'DeviceIndex': 'string',
                    'InstanceId': 'string',
                    'InstanceUniqueId': 'string',
                    'IpAddress': 'string'
                },
            ],
            'NetworkId': 'string',
            'NetworkInterfaceSet': [
                {
                    'IpAddress': 'string',
                    'NetworkInterfaceId': 'string'
                },
            ],
            'NextMonthAccountingType': 'string',
            'PrivateLanName': 'string',
            'RemoteAccessVpnGatewaySet': [
                {
                    'DeviceIndex': 'string',
                    'IpAddress': 'string',
                    'RemoteAccessVpnGatewayId': 'string',
                    'RemoteAccessVpnGatewayName': 'string'
                },
            ],
            'RouterSet': [
                {
                    'DeviceIndex': 'string',
                    'IpAddress': 'string',
                    'RouterId': 'string',
                    'RouterName': 'string'
                },
            ],
            'SharingStatus': 'string',
            'State': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VpnGatewaySet': [
                {
                    'DeviceIndex': 'string',
                    'IpAddress': 'string',
                    'NiftyVpnGatewayName': 'string',
                    'VpnGatewayId': 'string'
                },
            ]
        },
    ],
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • PrivateLanSet (list) –

    • (dict) –

      • AccountingType (string) –

      • AvailabilityZone (string) –

      • CidrBlock (string) –

      • CreatedTime (datetime) –

      • Description (string) –

      • ElasticLoadBalancingSet (list) –

        • (dict) –

          • ElasticLoadBalancerName (string) –

          • ElasticLoadBalancerPort (integer) –

          • InstancePort (integer) –

          • Protocol (string) –

      • InstancesSet (list) –

        • (dict) –

          • DeviceIndex (string) –

          • InstanceId (string) –

          • InstanceUniqueId (string) –

          • IpAddress (string) –

      • NetworkId (string) –

      • NetworkInterfaceSet (list) –

        • (dict) –

          • IpAddress (string) –

          • NetworkInterfaceId (string) –

      • NextMonthAccountingType (string) –

      • PrivateLanName (string) –

      • RemoteAccessVpnGatewaySet (list) –

        • (dict) –

          • DeviceIndex (string) –

          • IpAddress (string) –

          • RemoteAccessVpnGatewayId (string) –

          • RemoteAccessVpnGatewayName (string) –

      • RouterSet (list) –

        • (dict) –

          • DeviceIndex (string) –

          • IpAddress (string) –

          • RouterId (string) –

          • RouterName (string) –

      • SharingStatus (string) –

      • State (string) –

      • TagSet (list) –

        • (dict) –

          • Key (string) –

          • Value (string) –

      • VpnGatewaySet (list) –

        • (dict) –

          • DeviceIndex (string) –

          • IpAddress (string) –

          • NiftyVpnGatewayName (string) –

          • VpnGatewayId (string) –

  • RequestId (string) –