computing / Client / describe_vpn_connections

describe_vpn_connections

computing.Client.describe_vpn_connections(**kwargs)

指定されたVPNコネクションの情報を取得します。

VPNコネクションを指定するためには、VPNコネクションユニークIDが必要です。

VPNコネクションを指定しない場合、取得できるすべてのVPNコネクション情報を取得します。

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

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

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

• customer-gateway-configuration

• nifty-customer-gateway-name

• route.destination-cidr-block

• nifty-vpn-gateway-name

• nifty-vpn-connection-description

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_vpn_connections(
    Filter=[
        {
            'ListOfRequestValue': [
                'string',
            ],
            'Name': 'customer-gateway-configuration'|'customer-gateway-id'|'nifty-customer-gateway-name'|'state'|'option.static-routes-only'|'route.destination-cidr-block'|'type'|'vpn-connection-id'|'vpn-gateway-id'|'nifty-vpn-gateway-name'|'nifty-vpn-connection-description'|'nifty-internet-key-exchange'
        },
    ],
    VpnConnectionId=[
        'string',
    ]
)

Parameters:

• Filter (list) –

  • (dict) –

    • ListOfRequestValue (list) –

      • (string) –

    • Name (string) –

• VpnConnectionId (list) –

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'VpnConnectionSet': [
        {
            'CreatedTime': datetime(2015, 1, 1),
            'CustomerGatewayConfiguration': 'string',
            'CustomerGatewayId': 'string',
            'NiftyCustomerGatewayName': 'string',
            'NiftyIpsecConfiguration': {
                'DiffieHellmanGroup': 123,
                'EncapsulatingSecurityPayloadLifetime': 123,
                'EncryptionAlgorithm': 'string',
                'HashingAlgorithm': 'string',
                'InternetKeyExchange': 'string',
                'InternetKeyExchangeLifetime': 123,
                'Mtu': 'string',
                'PreSharedKey': 'string'
            },
            'NiftyTunnel': {
                'DestinationPort': 'string',
                'Encapsulation': 'string',
                'Mode': 'string',
                'PeerSessionId': 'string',
                'PeerTunnelId': 'string',
                'SessionId': 'string',
                'SourcePort': 'string',
                'TunnelId': 'string',
                'Type': 'string'
            },
            'NiftyVpnConnectionDescription': 'string',
            'NiftyVpnGatewayName': 'string',
            'State': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Type': 'string',
            'VgwTelemetry': [
                {
                    'AcceptedRouteCount': 123,
                    'LastStatusChange': datetime(2015, 1, 1),
                    'OutsideIpAddress': 'string',
                    'Status': 'string',
                    'StatusMessage': 'string'
                },
            ],
            'VpnConnectionId': 'string',
            'VpnGatewayId': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • RequestId (string) –

  • VpnConnectionSet (list) –

    • (dict) –

      • CreatedTime (datetime) –

      • CustomerGatewayConfiguration (string) –

      • CustomerGatewayId (string) –

      • NiftyCustomerGatewayName (string) –

      • NiftyIpsecConfiguration (dict) –

        • DiffieHellmanGroup (integer) –

        • EncapsulatingSecurityPayloadLifetime (integer) –

        • EncryptionAlgorithm (string) –

        • HashingAlgorithm (string) –

        • InternetKeyExchange (string) –

        • InternetKeyExchangeLifetime (integer) –

        • Mtu (string) –

        • PreSharedKey (string) –

      • NiftyTunnel (dict) –

        • DestinationPort (string) –

        • Encapsulation (string) –

        • Mode (string) –

        • PeerSessionId (string) –

        • PeerTunnelId (string) –

        • SessionId (string) –

        • SourcePort (string) –

        • TunnelId (string) –

        • Type (string) –

      • NiftyVpnConnectionDescription (string) –

      • NiftyVpnGatewayName (string) –

      • State (string) –

      • TagSet (list) –

        • (dict) –

          • Key (string) –

          • Value (string) –

      • Type (string) –

      • VgwTelemetry (list) –

        • (dict) –

          • AcceptedRouteCount (integer) –

          • LastStatusChange (datetime) –

          • OutsideIpAddress (string) –

          • Status (string) –

          • StatusMessage (string) –

      • VpnConnectionId (string) –

      • VpnGatewayId (string) –