computing / Client / nifty_describe_nat_tables

nifty_describe_nat_tables

computing.Client.nifty_describe_nat_tables(**kwargs)

指定したNATテーブルの情報を取得します。

NATテーブルを指定するためには、NATテーブルIDが必要です。NATテーブルを指定しない場合は、取得可能なすべてのNATテーブル情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字(曖昧検索)指定可能です。

「∗」は0個以上任意文字、 「?」は1個任意文字、「¥」はエスケープ変換文字(「¥∗niftycloud¥?¥¥」は「∗niftycloud?¥」を検索)となります。

曖昧検索が指定可能な絞り込み条件の項目名は、下記の通りです。

  • nat-rule.description

  • nat-rule.destination.address

  • nat-rule.source.address

  • nat-rule.translation.address

  • nt-rule.outbound-interface.network-name

  • nat-rule.inbound-interface.network-name

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_describe_nat_tables(
    Filter=[
        {
            'ListOfRequestValue': [
                'string',
            ],
            'Name': 'association.association-id'|'association.nat-table-id'|'association.router-id'|'nat-table-id'|'nat-rule.nat-type'|'nat-rule.rule-number'|'nat-rule.description'|'nat-rule.protocol'|'nat-rule.outbound-interface.network-id'|'nat-rule.outbound-interface.network-name'|'nat-rule.inbound-interface.network-id'|'nat-rule.inbound-interface.network-name'|'nat-rule.destination.address'|'nat-rule.destination.port'|'nat-rule.source.address'|'nat-rule.source.port'|'nat-rule.translation.address'|'nat-rule.translation.port'
        },
    ],
    NatTableId=[
        'string',
    ]
)
Parameters:
  • Filter (list) –

    • (dict) –

      • ListOfRequestValue (list) –

        • (string) –

      • Name (string) –

  • NatTableId (list) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NatTableSet': [
        {
            'AssociationSet': [
                {
                    'AssociationId': 'string',
                    'NatTableId': 'string',
                    'RouterId': 'string',
                    'RouterName': 'string'
                },
            ],
            'NatRuleSet': [
                {
                    'Description': 'string',
                    'Destination': {
                        'Port': 123
                    },
                    'InboundInterface': {
                        'NetworkId': 'string',
                        'NetworkName': 'string'
                    },
                    'NatType': 'string',
                    'OutboundInterface': {
                        'NetworkId': 'string',
                        'NetworkName': 'string'
                    },
                    'Protocol': 'string',
                    'RuleNumber': 'string',
                    'Source': {
                        'Address': 'string',
                        'Port': 123
                    },
                    'Translation': {
                        'Address': 'string',
                        'Port': 123
                    }
                },
            ],
            'NatTableId': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • NatTableSet (list) –

      • (dict) –

        • AssociationSet (list) –

          • (dict) –

            • AssociationId (string) –

            • NatTableId (string) –

            • RouterId (string) –

            • RouterName (string) –

        • NatRuleSet (list) –

          • (dict) –

            • Description (string) –

            • Destination (dict) –

              • Port (integer) –

            • InboundInterface (dict) –

              • NetworkId (string) –

              • NetworkName (string) –

            • NatType (string) –

            • OutboundInterface (dict) –

              • NetworkId (string) –

              • NetworkName (string) –

            • Protocol (string) –

            • RuleNumber (string) –

            • Source (dict) –

              • Address (string) –

              • Port (integer) –

            • Translation (dict) –

              • Address (string) –

              • Port (integer) –

        • NatTableId (string) –

        • TagSet (list) –

          • (dict) –

            • Key (string) –

            • Value (string) –

    • RequestId (string) –