本文へジャンプします。

ニフクラ APIリファレンス

CreateVpnGateway

処理概要

VPNゲートウェイを新規作成します。

指定するパラメーター

パラメーター 説明 必須 サンプル値
NiftyVpnGatewayName VPNゲートウェイ名
Type : String
Default : 英数8文字 (システム発行)
   
Type ※指定不可
Type : String
値: IPsec | L2TPv3 | IPsec
   
NiftyVpnGatewayType VPNゲートウェイのタイプ
Type : String
値: small | medium | large
Default: small
   
NiftyRedundancy 冗長化オプション
Type : Boolean
値: true | false
Default: false
   
Placement.AvailabilityZone ゾーン名
Type : String
Default: ニフクラが決定
   
AccountingType 利用料金タイプ
Type : String
値: 1 (月額課金) | 2 (従量課金)
Default: 2
   
NiftyVpnGatewayDescription メモ
Type : String
   
NiftyNetwork.NetworkId プライベート側ネットワークID
Type : String

(プライベート側ネットワーク名といずれか)
 
NiftyNetwork.NetworkName プライベート側ネットワーク名
Type : String

(プライベート側ネットワークIDといずれか)
 
NiftyNetwork.IpAddress プライベート側IPアドレス(IPv4)
Type : String
   
SecurityGroup.n ファイアウォールグループ名
Type : String
   

応答フィールド

フィールド 説明 サンプル値
CreateVpnGatewayResponse CreateVpnGatewayレスポンス
Type : CreateVpnGatewayResponseType
Ancestor : なし
Children : requestId, vpnGateway
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : CreateVpnGatewayResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
vpnGateway VPNゲートウェイ情報
Type : VpnGatewayType
Ancestor : CreateVpnGatewayResponse
Children : vpnGatewayId.,niftyVpnGatewayName,state,type,availabilityZone,attachments, tagSet,niftyVpnGatewayType,niftyRedundancy,niftyVpnGatewayDescription, accountingType, nextMonthAccountingType ,networkInterfaceSet,groupSet,createdTime
versionInformation,backupInformation,routeTableId,routeTableAssociationId
VPNゲートウェイユニークID
Type : xsd:string
Ancestor : vpnGateway
Children : なし
 
vpnGatewayId  
niftyVpnGatewayName VPNゲートウェイ名
Type : xsd:string
Ancestor : vpnGateway
Children : なし
 
state VPNゲートウェイステータス
Type : xsd:string
値 : pending (処理中) | available (起動中) | stopped (停止済み) | warning (異常あり)
Ancestor : vpnGateway
Children : なし
 
type ※返却値なし
Type : xsd:string
Ancestor : vpnGateway
Children : なし
 
availabilityZone ゾーン名
Type : xsd:string
Ancestor : vpnGateway
Children : なし
 
attachments ※空を返却
Type : AttachmentType
Ancestor : vpnGateway
Children : item
 
item ※返却値なし
Type : AttachmentItemType
Ancestor : attachments
Children : vpcId,state
 
vpcId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
state ※返却値なし
Type : xsd:string
値 : attaching(接続中) | attached(接続済) | detaching(解除中) | detached(未接続)
Ancestor : item
Children : なし
 
tagSet リソースに設定されているタグ情報セット
Type : ResourceTagSetType
Ancestor : vpnGateway
Children : item
 
item リソースに設定されているタグ情報
Type : ResourceTagSetItemType
Ancestor : tagSet
Children : key,value
 
key 設定されているタグのキー
Type : xsd:string
Ancestor : item
Children : なし
 
value 設定されているタグの値
Type : xsd:string
Ancestor : item
Children : なし
 
niftyVpnGatewayType VPNゲートウェイのタイプ
Type : xsd:string
値: small | medium | large
Ancestor : vpnGateway
Children : なし
 
niftyRedundancy 冗長化オプション
Type : xsd:boolean
Ancestor : vpnGateway
Children : なし
 
niftyVpnGatewayDescription メモ
Type : xsd:string
Ancestor : vpnGateway
Children : なし
 
accountingType 利用料金タイプ
Type : xsd:string
値: 1 (月額課金) | 2 (従量課金)
Ancestor : vpnGateway
Children : なし
 
nextMonthAccountingType 翌月の利用料金タイプ
Type : xsd:string
値 : 1 (月額課金) | 2 (従量課金)
Ancestor : vpnGateway
Children : なし
 
versionInformation VPNゲートウェイのversion情報
Type :versionInformationType
Ancestor :vpnGateway
Children :isLatest, version
 
isLatest VPNゲートウェイのversion最新状態
Type :xsd:boolean
Ancestor :versionInformation
Children :なし
 
version VPNゲートウェイのversion情報
Type :xsd:String
Ancestor :versionInformation
Children :なし
 
networkInterfaceSet ネットワークインターフェイス情報セット
Type : NetworkInterfaceSetType
Ancestor : vpnGateway
Children : item
 
item ネットワークインターフェイス情報
Type : NetworkInterfaceSetItemType
Ancestor : networkInterfaceSet
Children : NetworkId,NetworkName,deviceIndex,ipAddress,cidrBlock,descriprion
 
networkId ネットワークユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
networkName ネットワーク名
Type : xsd:string
Ancestor : item
Children : なし
 
deviceIndex デバイス番号
Type : xsd:integer
Ancestor : item
Children : なし
 
ipAddress IPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
cidrBlock ネットワークのCIDR
Type : xsd:string
Ancestor : item
Children : なし
 
descriprion ネットワークのメモ
Type : xsd:string
Ancestor : item
Children : なし
 
backupInformation バックアップ情報セット
Type :BackupInformationType
Ancestor :vpnGateway
Children :isBackup, expirationDate
 
isBackup バックアップが存在するか
Type :xsd:boolean
Ancestor :backupInformation
Children :なし
 
expirationDate バックアップの保持期限
Type :xsd:dateTime
Ancestor :backupInformation
Children :なし
 
groupSet ファイアウォール情報セット
Type : GroupSetType
Ancestor : vpnGateway
Children : item
 
item ファイアウォール情報
Type : GroupItemType
Ancestor : groupSet
Children : groupId
 
groupId ファイアウォールグループ名
Type : xsd:string
Ancestor : item
Children : なし
 
routeTableId ルートテーブルID
Type :xsd:string
Ancestor :vpnGateway
Children :なし
 
routeTableAssociationId ルートテーブル適用ID
Type :xsd:string
Ancestor :vpnGateway
Children :なし
 
createdTime 作成日時
Type : xsd:dateTime
Ancestor : vpnGateway
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=CreateVpnGateway&NiftyVpnGatewayName=vpn1&NiftyVpnGatewayType=small&Placement.AvailabilityZone=east-11&NiftyNetwork.NetworkName=priNw1l&NiftyNetwork.IpAddress=192.168.0.1&CommonParams

応答サンプル

<CreateVpnGatewayResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <vpnGateway>
  <vpnGatewayId>vgw-8db04f81</vpnGatewayId>
  <niftyVpnGatewayName>vpn1</niftyVpnGatewayName>
  <state>pending</state>
  <availabilityZone>east-11</availabilityZone>
  <attachments/>
  <niftyVpnGatewayType>small</niftyVpnGatewayType>
  <niftyRedundancy>false</niftyRedundancy>
  <niftyVpnGatewayDescription/>
  <AccountingType>2</AccountingType>
  <versionInformation>
   <isLatest>true</isLatest>
   <version>vyos 1.1.5</version>
  </versionInformation>
  <item>
   <networkName>priNw1l</networkName>
   <ipAddress>192.168.0.1</ipAddress>
  </item>
  <backupInformation>
   <isBackup>false</isBackup>
   <expirationDate>2015/01/01</expirationDate>
  </backupInformation>
 </vpnGateway>
</CreateVpnGatewayResponse>

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

APIメニュー

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

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