本文へジャンプします。

ニフクラ APIリファレンス

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

NiftyReplaceRouteTableAssociationWithVpnGateway

処理概要

VPNゲートウェイへのルートテーブル設定入れ替えを行う。
VPNゲートウェイに設定されたルートテーブルを解除し、指定したルートテーブルに入れ替える。 ルートテーブルを指定するためには、ルートテーブルIDが必要です。VPNゲートウェイに設定済のルートテーブルを指定した、管理外のルートテーブルを指定したなど、無効なルートテーブルを指定した場合は、エラーが返されます。 設定されいてるVPNゲートウェイが処理中の場合、エラーが返されます。

VPNゲートウェイがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
AssociationId ルートテーブル適用ID
Type:String
 
RouteTableId ルートテーブルID
Type:String
 
Agreement version up実施したのち、バックアップ状態を解除する事項への同意
Type: Boolean
Default:false

(バックアップを保持する場合のみ)
 

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyReplaceRouteTableAssociationWithVpnGatewayResponse NiftyReplaceRouteTableAssociationWithVpnGatewayレスポンス
Type : NiftyReplaceRouteTableAssociationWithVpnGatewayResponseType
Ancestor :なし
Children :requestId, newAssociationId
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyReplaceRouteTableAssociationWithVpnGatewayResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
newAssociationId 新しいルートテーブル適用ID
Type :xsd:string
Ancestor :NiftyReplaceRouteTableAssociationWithVpnGatewayResponse
Children :なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=NiftyReplaceRouteTableAssociationWithVpnGateway&AssociationId=rtbassoc-12ad487b&RouteTableId=rtb-8db04f81&CommonParams

応答サンプル

<NiftyReplaceRouteTableAssociationWithVpnGatewayResponsexmlns="https://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <newAssociationId>rtbassoc-56df987c</newAssociationId>
</NiftyReplaceRouteTableAssociationWithVpnGatewayResponse>

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

APIメニュー

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

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