computing / Client / describe_route_tables

describe_route_tables

computing.Client.describe_route_tables(**kwargs)

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

ルートテーブルを指定するためには、ルートテーブルID が必要です。

ルートテーブルを指定しない場合は、取得可能なすべてのルートテーブル情報を取得します。

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

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_route_tables(
    Filter=[
        {
            'ListOfRequestValue': [
                'string',
            ],
            'Name': 'association.route-table-association-id'|'association.route-table-id'|'association.router-id'|'association.router-name'|'association.main'|'route-table-id'|'route.destination-cidr-block'|'route.gateway-id'|'route.vpc-peering-connection-id'|'route.origin'|'route.state'|'route.ip-address'|'route.network-id'
        },
    ],
    RouteTableId=[
        'string',
    ]
)

Parameters:

• Filter (list) –

  • (dict) –

    • ListOfRequestValue (list) –

      • (string) –

    • Name (string) –

• RouteTableId (list) –

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'RouteTableSet': [
        {
            'AssociationSet': [
                {
                    'Main': True|False,
                    'RouteTableAssociationId': 'string',
                    'RouteTableId': 'string',
                    'RouterId': 'string',
                    'RouterName': 'string'
                },
            ],
            'ElasticLoadBalancerAssociationSet': [
                {
                    'ElasticLoadBalancerId': 'string',
                    'ElasticLoadBalancerName': 'string',
                    'Main': True|False,
                    'RouteTableAssociationId': 'string',
                    'RouteTableId': 'string'
                },
            ],
            'PropagatingVgwSet': [
                {
                    'GatewayId': 'string',
                    'NiftyGatewayName': 'string',
                    'RouteTableAssociationId': 'string'
                },
            ],
            'RouteSet': [
                {
                    'DestinationCidrBlock': 'string',
                    'IpAddress': 'string',
                    'NetworkId': 'string',
                    'NetworkName': 'string',
                    'Origin': 'string',
                    'Priority': 'string',
                    'State': 'string',
                    'VpcPeeringConnectionId': 'string'
                },
            ],
            'RouteTableId': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –

  • RequestId (string) –

  • RouteTableSet (list) –

    • (dict) –

      • AssociationSet (list) –

        • (dict) –

          • Main (boolean) –

          • RouteTableAssociationId (string) –

          • RouteTableId (string) –

          • RouterId (string) –

          • RouterName (string) –

      • ElasticLoadBalancerAssociationSet (list) –

        • (dict) –

          • ElasticLoadBalancerId (string) –

          • ElasticLoadBalancerName (string) –

          • Main (boolean) –

          • RouteTableAssociationId (string) –

          • RouteTableId (string) –

      • PropagatingVgwSet (list) –

        • (dict) –

          • GatewayId (string) –

          • NiftyGatewayName (string) –

          • RouteTableAssociationId (string) –

      • RouteSet (list) –

        • (dict) –

          • DestinationCidrBlock (string) –

          • IpAddress (string) –

          • NetworkId (string) –

          • NetworkName (string) –

          • Origin (string) –

          • Priority (string) –

          • State (string) –

          • VpcPeeringConnectionId (string) –

      • RouteTableId (string) –

      • TagSet (list) –

        • (dict) –

          • Key (string) –

          • Value (string) –