本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>API> コンピューティング> CreateRemoteAccessVpnGateway
本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/cp/api/CreateRemoteAccessVpnGateway.htmへ移行しました。 今後は新ページをご参照ください。

CreateRemoteAccessVpnGateway

処理概要

リモートアクセスVPNゲートウェイを新規作成します。

指定するパラメーター

パラメーター 説明 必須
RemoteAccessVpnGatewayName string リモートアクセスVPNゲートウェイ名
使用可能文字: 半角英数字15文字以内
備考: 未指定の場合、命名規則に沿って生成されます。
RemoteAccessVpnGatewayType string リモートアクセスVPNゲートウェイのタイプ
値:
  • small
  • medium
  • large
Default: small
AccountingType integer 利用料金タイプ
値:
  • 1 (月額課金)
  • 2 (従量課金)
Default: 2
Placement.AvailabilityZone string ゾーン情報
Default: ニフクラが決定
Description string メモ情報
使用可能文字: 500文字以内※4バイト文字(絵文字や一部の漢字など)は使用できません。
PoolNetworkCidr string プールネットワークのCIDR(IP/CIDR形式)
備考: 16~27の範囲で指定可能です。
NetworkInterface.n.NetworkId string ネットワークID (プライベートLANのネットワークID)
NetworkInterface.n.IpAddress string IPアドレス(IPv4)
備考: 1つのみ指定可能です。
CipherSuite.n string 暗号スイート
備考: AES128-GCM-SHA256 | AES256-GCM-SHA384 | ECDHE-RSA-AES128-GCM-SHA256 | ECDHE-RSA-AES256-GCM-SHA384 が指定可能です。
CACertificateId string CA証明書ID
SSLCertificateId string サーバー認証証明書ID

応答フィールド

フィールド (項目) 説明
CreateRemoteAccessVpnGatewayResponse - CreateRemoteAccessVpnGatewayレスポンス
requestId string リクエスト識別子
return boolean 処理ステータス
値:
  • true (成功)
remoteAccessVpnGateway - リモートアクセスVPNゲートウェイ情報
remoteAccessVpnGatewayId string リモートアクセスVPNゲートウェイユニークID
remoteAccessVpnGatewayName string リモートアクセスVPNゲートウェイ名
remoteAccessVpnGatewayType string リモートアクセスVPNゲートウェイタイプ
accountingType string 利用料金タイプ
値:
  • 1 (月額課金)
  • 2 (従量課金)
nextMonthAccountingType string 次月の利用料金タイプ
値:
  • 1 (月額課金)
  • 2 (従量課金)
description string リモートアクセスVPNゲートウェイメモ情報
availabilityZone string ゾーン情報
status string リモートアクセスVPNゲートウェイステータス
値:
  • wait_create (リモートアクセスVPNゲートウェイ作成待ち)
clientDownloadEndpoint string ※空を返却
poolNetworkCidr string プールネットワークのCIDR情報
poolNetworkGatewayIpAddress string プールネットワークのIPアドレス情報
networkInterfaceSet - ネットワークインターフェース情報セット
item - グローバルネットワークインターフェース情報セット
networkInterfaceId string ※空を返却
subnetId string ※空を返却
vpcId string ※空を返却
description string ※空を返却
ownerId string ※空を返却
niftyNetworkId string ネットワークユニークID
niftyNetworkName string ※空を返却
status string ネットワークインターフェースのステータス
値:
  • in-use (使用中)
macAddress string ※空を返却
privateIpAddress string ※空を返却
privateIpAddressV6 string ※空を返却
privateDnsName string ※空を返却
sourceDestCheck string ※空を返却
groupSet string ※空を返却
attachment - ネットワークインターフェースの接続情報
attachmentId string ※空を返却
deviceIndex string デバイス番号
status string 接続状態
値:
  • attached (接続済み)
attachTime string ※空を返却
deleteOnTermination string サーバー削除時のディスク消去
値:
  • true (消去する)
instanceId string ※空を返却
instanceOwnerId string ※空を返却
association - ネットワークインターフェース関連付け情報
allocationId string ※空を返却
associationId string ※空を返却
ipOwnerId string ※空を返却
publicDnsName string ※空を返却
publicIp string ※空を返却
publicIpV6 string ※空を返却
privateIpAddressesSet string ※空を返却
availabilityZone string ※空を返却
interfaceType string ※空を返却
ipv6AddressesSet string ※空を返却
requesterId string ※空を返却
requesterManaged string ※空を返却
tagSet string ※空を返却
cipherSuiteSet - 暗号スイート情報セット
item - 暗号スイート情報セット
cipherSuite string 暗号スイート情報
sslCertificateId string SSL証明書の発行識別子
caCertificateId string CA証明書の発行識別子
authTypeSet - 認証タイプID情報
item - 認証タイプID情報
authType string 認証タイプID
remoteUserSet string ※空を返却
groupSet string ※空を返却
routeTableId string ※空を返却
routeTableAssociationId string ※空を返却
isConfiguredNat string NATの設定情報
値:
  • true (NATの設定済)
clientTunnelMode string クライアントトンネルモード
versionInformation string リモートアクセスVPNゲートウェイのversion情報
isLatest string ※空を返却
version string ※空を返却
createdTime string ※空を返却

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=CreateRemoteAccessVpnGateway
  &PoolNetworkCidr=192.168.0.0/24
  &NetworkInterface.1.NetworkId=net-0k87j180
  &NetworkInterface.1.IpAddress=192.168.0.1
  &CipherSuite.1=AES128-GCM-SHA256
  &SSLCertificateId=1234
  &CommonParams

  

応答サンプル

    <?xml version="1.0" encoding="UTF-8"?>
<CreateRemoteAccessVpnGatewayResponse>
  <requestId>35dc891f-8171-4abb-8ce8-6312b412ce90</requestId>
  <return>true</return>
  <remoteAccessVpnGateway>
    <remoteAccessVpnGatewayId>ravgw-8db04f81</remoteAccessVpnGatewayId>
    <remoteAccessVpnGatewayName>ravgw-8db04f81</remoteAccessVpnGatewayName>
    <remoteAccessVpnGatewayType>small</remoteAccessVpnGatewayType>
    <accountingType>1</accountingType>
    <nextMonthAccountingType>1</nextMonthAccountingType>
    <description>&lt;![CDATA[memo]]&gt;</description>
    <availabilityZone>east-11</availabilityZone>
    <status>wait_create</status>
    <clientDownloadEndpoint/>
    <poolNetworkCidr>192.168.0.0/24</poolNetworkCidr>
    <poolNetworkGatewayIpAddress>192.168.0.1</poolNetworkGatewayIpAddress>
    <networkInterfaceSet>
      <item>
          <networkInterfaceId/>
          <subnetId/>
          <vpcId/>
          <description/>
          <ownerId/>
          <niftyNetworkId>net-COMMON_GLOBAL</niftyNetworkId>
          <niftyNetworkName/>
          <status>in-use</status>
          <macAddress/>
          <privateIpAddress/>
          <privateIpAddressV6/>
          <privateDnsName/>
          <sourceDestCheck/>
          <groupSet/>
          <attachment>
            <attachmentId/>
            <deviceIndex>0</deviceIndex>
            <status>attached</status>
            <attachTime/>
            <deleteOnTermination>true</deleteOnTermination>
            <instanceId/>
            <instanceOwnerId/>
          </attachment>
          <association>
            <allocationId/>
            <associationId/>
            <ipOwnerId/>
            <publicDnsName/>
            <publicIp/>
            <publicIpV6/>
          </association>
          <privateIpAddressesSet/>
          <availabilityZone/>
          <interfaceType/>
          <ipv6AddressesSet/>
          <requesterId/>
          <requesterManaged/>
          <tagSet/>
        </item>
        <item>
          <networkInterfaceId/>
          <subnetId/>
          <vpcId/>
          <description/>
          <ownerId/>
          <niftyNetworkId>net-0k87j180</niftyNetworkId>
          <niftyNetworkName>privateLan</niftyNetworkName>
          <status>in-use</status>
          <macAddress/>
          <privateIpAddress>192.168.0.1</privateIpAddress>
          <privateIpAddressV6/>
          <privateDnsName/>
          <sourceDestCheck/>
          <groupSet/>
          <attachment>
            <attachmentId/>
            <deviceIndex>0</deviceIndex>
            <status>attached</status>
            <attachTime/>attachTime>
            <deleteOnTermination>true</deleteOnTermination>
            <instanceId/>
            <instanceOwnerId/>
          </attachment>
          <association>
            <allocationId/>
            <associationId/>
            <ipOwnerId/>
            <publicDnsName/>
            <publicIp/>
            <publicIpV6/>
          </association>
          <privateIpAddressesSet/>
          <availabilityZone/>
          <interfaceType/>
          <ipv6AddressesSet/>
          <requesterId/>
          <requesterManaged/>
          <tagSet/>
        </item>
    </networkInterfaceSet>
    <cipherSuiteSet>
      <item>
        <cipherSuite>AES128-GCM-SHA256</cipherSuite>
      </item>
    </cipherSuiteSet>
    <sslCertificateId>1234</sslCertificateId>
    <caCertificateId/>
    <authTypeSet>
      <item>
        <authType>local</authType>
      </item>
    </authTypeSet>
    <remoteUserSet/>
    <groupSet/>
    <routeTableId/>
    <routeTableAssociationId/>
    <isConfiguredNat>true</isConfiguredNat>
    <clientTunnelMode>split</clientTunnelMode>
    <versionInformation>
      <isLatest/>
      <version/>
    </versionInformation>
    <createdTime/>
  </remoteAccessVpnGateway>
</CreateRemoteAccessVpnGatewayResponse>

  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年9月05日時点の情報です。

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