DeleteVpnConnection
処理概要
指定されたVPNコネクションを削除します。
接続されている拠点間VPNゲートウェイがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。
指定するパラメーター
パラメーター | 型 | 説明 | 必須 |
---|---|---|---|
VpnConnectionId | string |
VPNコネクションユニークID |
○ |
Agreement | boolean |
version up実施したのち、バックアップ状態を解除する事項への同意 値:
|
○ (バックアップを保持する場合のみ) |
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
DeleteVpnConnectionResponse | - |
DeleteVpnConnectionレスポンス |
␣requestId | string |
リクエスト識別子 |
␣return | boolean |
処理ステータス 値:
|
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/
?Action=DeleteVpnConnection
&VpnConnectionId=vpn-44a8938f
&CommonParams
応答サンプル
<DeleteVpnConnectionResponse xmlns="https://computing.api.nifcloud.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<return>true</return>
</DeleteVpnConnectionResponse>