computing / Client / describe_vpn_gateways

describe_vpn_gateways

computing.Client.describe_vpn_gateways(**kwargs)

指定した拠点間VPNゲートウェイの情報を取得します。

拠点間VPNゲートウェイを指定するためには、拠点間VPNゲートウェイユニークIDまたは拠点間VPNゲートウェイ名が必要です。

拠点間VPNゲートウェイを指定しない場合、取得できるすべての拠点間VPNゲートウェイ情報を取得します。

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

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

• nifty-vpn-gateway-name

• nifty-vpn-gateway-description

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_vpn_gateways(
    Filter=[
        {
            'ListOfRequestValue': [
                'string',
            ],
            'Name': 'attachment.state'|'attachment.vpc-id'|'availability-zone'|'state'|'type'|'vpn-gateway-id'|'nifty-vpn-gateway-name'|'nifty-vpn-gateway-type'|'nifty-vpn-gateway-description'|'nifty-vpn-gateway-accountingType'|'ip-address'|'latest-version-information'|'version'
        },
    ],
    NiftyVpnGatewayName=[
        'string',
    ],
    VpnGatewayId=[
        'string',
    ]
)

Parameters:

• Filter (list) –

  • (dict) –

    • ListOfRequestValue (list) –

      • (string) –

    • Name (string) –

• NiftyVpnGatewayName (list) –

  • (string) –

• VpnGatewayId (list) –

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'VpnGatewaySet': [
        {
            'AccountingType': 'string',
            'Attachments': 'string',
            'AvailabilityZone': 'string',
            'BackupInformation': {
                'ExpirationDate': datetime(2015, 1, 1),
                'IsBackup': True|False
            },
            'CreatedTime': datetime(2015, 1, 1),
            'GroupSet': [
                {
                    'GroupId': 'string'
                },
            ],
            'NetworkInterfaceSet': [
                {
                    'CidrBlock': 'string',
                    'Descriprion': 'string',
                    'DeviceIndex': 'string',
                    'IpAddress': 'string',
                    'IsOutsideNetwork': True|False,
                    'NetworkId': 'string',
                    'NetworkName': 'string'
                },
            ],
            'NextMonthAccountingType': 'string',
            'NiftyRedundancy': True|False,
            'NiftyVpnGatewayDescription': 'string',
            'NiftyVpnGatewayName': 'string',
            'NiftyVpnGatewayType': 'string',
            'RouteTableAssociationId': 'string',
            'RouteTableId': 'string',
            'State': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VersionInformation': {
                'IsLatest': True|False,
                'Version': 'string'
            },
            'VpnGatewayId': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • RequestId (string) –

  • VpnGatewaySet (list) –

    • (dict) –

      • AccountingType (string) –

      • Attachments (string) –

      • AvailabilityZone (string) –

      • BackupInformation (dict) –

        • ExpirationDate (datetime) –

        • IsBackup (boolean) –

      • CreatedTime (datetime) –

      • GroupSet (list) –

        • (dict) –

          • GroupId (string) –

      • NetworkInterfaceSet (list) –

        • (dict) –

          • CidrBlock (string) –

          • Descriprion (string) –

          • DeviceIndex (string) –

          • IpAddress (string) –

          • IsOutsideNetwork (boolean) –

          • NetworkId (string) –

          • NetworkName (string) –

      • NextMonthAccountingType (string) –

      • NiftyRedundancy (boolean) –

      • NiftyVpnGatewayDescription (string) –

      • NiftyVpnGatewayName (string) –

      • NiftyVpnGatewayType (string) –

      • RouteTableAssociationId (string) –

      • RouteTableId (string) –

      • State (string) –

      • TagSet (list) –

        • (dict) –

          • Key (string) –

          • Value (string) –

      • VersionInformation (dict) –

        • IsLatest (boolean) –

        • Version (string) –

      • VpnGatewayId (string) –