本文へジャンプします。

ニフクラ APIリファレンス

NiftyAssociateRouteTableWithVpnGateway

処理概要

指定したVPNゲートウェイへルートテーブル設定する。
ルートテーブルを指定するためには、ルートテーブルIDが必要です。VPNゲートウェイに設定済のルートテーブルを指定した、管理外のルートテーブルを指定したなど、無効なルートテーブルを指定した場合は、エラーが返されます。 またVPNゲートウェイを指定するためには、VPNゲートウェイユニークIDまたはVPNゲートウェイ名が必要です。処理中のVPNゲートウェイを指定した、削除済みのVPNゲートウェイを指定した、管理外のVPNゲートウェイを指定したなど、無効なVPNゲートウェイを指定した場合は、エラーが返されます。

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
RouteTableId ルートテーブルID
Type:String
 
VpnGatewayId VPNゲートウェイユニークID
Type:String

(VPNゲートウェイ名といずれか)
vgw-8db04f81
NiftyVpnGatewayName VPNゲートウェイ名
Type:String

(VPNゲートウェイユニークIDといずれか)
 
Agreement version up実施したのち、バックアップ状態を解除する事項への同意
Type: Boolean
Default:false

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

応答フィールド

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

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=NiftyAssociateRouteTableWithVpnGateway&RouteTableId=rtb-e4ad488d&VpnGatewayId=vgw-8db04f81&CommonParams

応答サンプル

<NiftyAssociateRouteTableWithVpnGatewayResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <associationId>natassoc-12ad487b</associationId>
</NiftyAssociateRouteTableWithVpnGatewayResponse>

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

APIメニュー

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

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