クラウドAPI (コンピューティング: CreateCustomerGateway)

CreateCustomerGateway

処理概要

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

指定するパラメーター

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

応答フィールド

フィールド (項目)	型	説明
CreateCustomerGatewayResponse	-	CreateCustomerGatewayレスポンス Ancestor: なし Children: requestId | customerGateway
requestId	string	リクエスト識別子 Ancestor: CreateCustomerGatewayResponse Children: なし
customerGateway	-	カスタマーゲートウェイ情報 Ancestor: CreateCustomerGatewayResponse Children: customerGatewayId | niftyCustomerGatewayName | state | ipAddress | niftyLanSideIpAddress | niftyLanSideCidrBlock | tagSet | niftyCustomerGatewayDescription | createdTime
customerGatewayId	string	カスタマーゲートウェイユニークID Ancestor: customerGateway Children: なし
niftyCustomerGatewayName	string	カスタマーゲートウェイ名 Ancestor: customerGateway Children: なし
state	string	カスタマーゲートウェイステータス 値: pending(処理中) | available(起動中) | stopped(停止済み) | warning(異常あり) Ancestor: customerGateway Children: なし
ipAddress	string	カスタマーゲートウェイのインターネット側IPアドレス Ancestor: customerGateway Children: なし
niftyLanSideIpAddress	string	カスタマーゲートウェイのLAN側IPアドレス Ancestor: customerGateway Children: なし
niftyLanSideCidrBlock	string	カスタマゲートウェイ(対向機器)のLAN側IPアドレス帯(CIDR) Ancestor: customerGateway Children: なし
tagSet	-	※空を返却 リソースに設定されているタグ情報セット Ancestor: customerGateway Children: item
item	-	リソースに設定されているタグ情報 Ancestor: tagSet Children: key | value
key	string	設定されているタグのキー Ancestor: item Children: なし
value	string	設定されているタグの値 Ancestor: item Children: なし
niftyCustomerGatewayDescription	string	メモ(CDATA付) Ancestor: customerGateway Children: なし
createdTime	timestamp	作成日時 Ancestor: customerGateway Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=CreateCustomerGateway
  &NiftyCustomerGatewayName=customer1
  &IpAddress=12.1.2.3
  &CommonParams

  

応答サンプル

    <CreateCustomerGatewayResponse xmlns="https://computing.api.nifcloud.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>
    <niftyLanSideIpAddress></niftyLanSideIpAddress>
    <niftyLanSideCidrBlock></niftyLanSideCidrBlock>
    <tagSet/>
    <niftyCustomerGatewayDescription><![CDATA[]]></niftyCustomerGatewayDescription>
    <createdTime>2020-06-30T16:16:40+09:00</createdTime>
  </customerGateway>
</CreateCustomerGatewayResponse>