本文へジャンプします。

ニフクラ APIリファレンス

CreateCustomerGateway

処理概要

カスタマーゲートウェイを新規作成します。

指定するパラメーター

パラメーター 説明 必須 サンプル値
Type ※指定不可
Type : String
値: IPsec | L2TPv3 | IPsec
   
IpAddress カスタマーゲートウェイのインターネット側IPアドレスorドメイン
Type : String
 
BgpAsn ※指定不可
Type : Integer
Default: 65000
   
NiftyCustomerGatewayName カスタマーゲートウェイ名
Type : String
   
NiftyLanSideIpAddress カスタマーゲートウェイ(対向機器)のLAN側IPアドレス
Type : String
   
NiftyLanSideCidrBlock カスタマゲートウェイ(対向機器)のLAN側IPアドレス帯(CIDR)
Type : String
   
NiftyCustomerGatewayDescription メモ
Type : String
   

応答フィールド

フィールド 説明 サンプル値
CreateCustomerGatewayResponse CreateCustomerGatewayレスポンス
Type : CreateCustomerGatewayResponseType
Ancestor : なし
Children : requestId, customerGateway
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : CreateCustomerGatewayResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
customerGateway カスタマーゲートウェイ情報
Type : CustomerGatewayType
Ancestor : CreateCustomerGatewayResponse
Children : customerGatewayId,niftyCustomerGatewayName,state,type,ipAddress,niftyLanSideIpAddress,niftyLanSideCidrBlock,bgpAsn,tagSet,niftyCustomerGatewayDescription,createTime
 
customerGatewayId カスタマーゲートウェイユニークID
Type : xsd:string
Ancestor : customerGateway
Children : なし
 
niftyCustomerGatewayName カスタマーゲートウェイ名
Type : xsd:string
Ancestor : customerGateway
Children : なし
 
state カスタマーゲートウェイステータス
Type : xsd:string
値: pending (処理中) | available (起動中) | stopped (停止済み) | warning (異常あり)
Ancestor : customerGateway
Children : なし
 
type ※返却値なし
Type : xsd:string
値: IPsec | L2TPv3 | IPsec
Ancestor : customerGateway
Children : なし
 
ipAddress カスタマーゲートウェイのインターネット側IPアドレス
Type : xsd:string
Ancestor : customerGateway
Children : なし
 
niftyLanSideIpAddress カスタマーゲートウェイのLAN側IPアドレス
Type : xsd:string
Ancestor : customerGateway
Children : iなし
 
niftyLanSideCidrBlock カスタマゲートウェイ(対向機器)のLAN側IPアドレス帯(CIDR)
Type : xsd:string
Ancestor : customerGateway
Children : なし
 
bgpAsn ※返却値なし
Type : xsd:string
Ancestor : customerGateway
Children : なし
 
tagSet リソースに設定されているタグ情報セット
Type : ResourceTagSetType
Ancestor : customerGateway
Children : item
 
item リソースに設定されているタグ情報
Type : ResourceTagSetItemType
Ancestor : tagSet
Children : key,value
 
key 設定されているタグのキー
Type : xsd:string
Ancestor : item
Children : なし
 
value 設定されているタグの値
Type : xsd:string
Ancestor : item
Children : なし
 
niftyCustomerGatewayDescription メモ
Type : xsd:string
Ancestor : customerGateway
Children : なし
 
createdTime 作成日時
Type : xsd:dateTime
Ancestor : customerGateway
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=CreateCustomerGateway&NiftyCustomerGatewayName=customer1&IpAddress=12.1.2.3&CommonParams

応答サンプル

<CreateCustomerGatewayResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <customerGateway>
  <customerGatewayId>cgw-b4dc3961</customerGatewayId>
  <niftyCustomerGatewayName>cgw1</niftyCustomerGatewayName>
  <state>pending</state>
  <ipAddress>12.1.2.3</ipAddress>
  <niftyVpnGatewayDescription/>
 </customerGateway>
</CreateCustomerGatewayResponse>

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

APIメニュー

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

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