本文へジャンプします。

ニフクラ APIリファレンス

クラウド トップ>APIのご利用にあたって>ニフクラREST API>NiftyDeregisterVpnGatewaysFromSecurityGroup

NiftyDeregisterVpnGatewaysFromSecurityGroup

処理概要

指定したファイアウォールグループからVPNゲートウェイをはずします。

下記の場合は、エラーが返されます。

  • 削除済みのファイアウォールグループを指定した場合
  • 管理外のファイアウォールグループを指定した場合
  • 無効なファイアウォールグループを指定した場合は

ファイアウォールからはずすためには、VPNゲートウェイ名またはVPNゲートウェイIDを指定します。
下記の場合は、エラーが返されます。

  • すでにファイアウォールグループに適用されているVPNゲートウェイを指定した場合
  • 削除済みのVPNゲートウェイを指定した場合
  • 管理外のVPNゲートウェイを指定した場合
  • 無効なVPNゲートウェイを指定した場合

ファイアウォールグループからVPNゲートウェイをはずす処理には、時間がかかる場合があります。
「DescribeSecurityGroups」のレスポンス「groupStatus」でファイアウォールグループのステータスを確認することができます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
GroupName ファイアウォールグループ名
Type : String
group01
RouterSet.n.RouterId VPNゲートウェイユニークID
Type : String
○(VPNゲートウェイ名といずれか) vgw-0001
RouterSet.n.RouterName VPNゲートウェイ名
Type : String
○(VPNゲートウェイユニークIDといずれか) vpngw02

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyDeregisterVpnGatewaysFromSecurityGroupResponse NiftyDeregisterVpnGatewaysFromSecurityGroupレスポンス
Type : NiftyDeregisterVpnGatewaysFromSecurityGroupResponseType
Ancestor : なし
Children : requestId, vpnGatewaySet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyDeregisterVpnGatewaysFromSecurityGroupResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
vpnGatewaySet 解除に成功したVPNゲートウェイの情報セット
Type : VpnGatewayIdSetType
Ancestor : NiftyDeregisterVpnGatewaysFromSecurityGroupResponse
Children : item
 
item 解除に成功したVPNゲートウェイの情報
Type : VpnGatewayIdSetItemType
Ancestor : vpnGatewaySet
Children : vpnGatewayId, niftyVpnGatewayName
 
vpnGatewayId VPNゲートウェイユニークID
  • ※VPNゲートウェイ名のいずれか一方が設定される
Type : xsd:string
Ancestor : item
Children : なし
vgw-0001
niftyVpnGatewayName VPNゲートウェイ名
  • ※VPNゲートウェイIDのいずれか一方が設定される
Type : xsd:string
Ancestor : item
Children : なし
vpngw02

リクエストサンプル

https://jp-east-1.computing.api.nifcloud.com/api/?Action=NiftyDeregisterVpnGatewaysFromSecurityGroup&GroupName=websrv&VpnGatewaySet.1.NiftyVpnGatewayName=vpngw1

応答サンプル

<NiftyDeregisterVpnGatewaysFromSecurityGroupResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <vpnGatewaySet>
    <item>
      <niftyVpnGatewayName>vpngw1</niftyVpnGatewayName>
    </item>
  </vpnGatewaySet>
</NiftyDeregisterVpnGatewaysFromSecurityGroupResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

推奨画面サイズ 1024×768 以上