本文へジャンプします。

ニフクラ ユーザーガイド

NiftyCreateRouter

処理概要

ルーターを新規作成します。
ルーターに割り当てるネットワークを指定するためには、ネットワークIDまたはネットワーク名が必要です。
作成したルーターのゾーンは指定したネットワークと同一のゾーンになります。

指定するパラメーター

パラメーター 説明 必須
RouterName string ルーター名
使用可能文字: 半角英数字(15文字)
AvailabilityZone string ゾーン名
Default: ニフクラが決定
AccountingType string 利用料金タイプ
値: 1 (月額課金) | 2 (従量課金)
Default: 2
Description string メモ
使用可能文字: 全角半角(500字)
Type string ルーターのタイプ
値: small | medium | large
Default: small
NetworkInterface.n.DeviceIndex integer ※指定不可
NetworkInterface.n.SecurityGroupId.n string ※指定不可
NetworkInterface.n.NetworkId string ネットワークID
使用可能文字: net-COMMON_GLOBAL(共通グローバル)、net-COMMON_PRIVATE(共通プライベート)、プライベートLAN のネットワークID
○ (ネットワーク名といずれか)
NetworkInterface.n.NetworkName string ネットワーク名
Default: なし
○ (ネットワークIDといずれか)
NetworkInterface.n.IpAddress string IPアドレス
Default: なし
NetworkInterface.n.Dhcp boolean dhcp設定フラグ
値: True (dhcp設定有効) | False (dhcp設定無効)
Default: True
NetworkInterface.n.DhcpOptionsId string dhcpオプションID
Default: なし
NetworkInterface.n.DhcpConfigId string dhcpコンフィグID
Default: なし
SecurityGroup.n string ファイアウォールグループ名
Default: なし

応答フィールド

フィールド (項目) 説明
NiftyCreateRouterResponse - NiftyCreateRouterレスポンス
Ancestor: なし
Children: requestId | router
requestId string リクエスト識別子
Ancestor: NiftyCreateRouterResponse
Children: なし
router - ルーター情報
Ancestor: NiftyCreateRouterResponse
Children: routerId | routerName | state | availabilityZone | accountingType | versionInformation | nextMonthAccountingType | description | networkInterfaceSet | backupInformation | type | groupSet
routerId string ルーターユニークID
Ancestor: router
Children: なし
routerName string ルーター名
Ancestor: router
Children: なし
state string ルーターのステータス
値: pending(処理中)
Ancestor: router
Children: なし
availabilityZone string ゾーン情報
Ancestor: router
Children: なし
accountingType string 利用料金タイプ
値: 1(月額課金) | 2(従量課金)
Ancestor: router
Children: なし
nextMonthAccountingType string 翌月の利用料金タイプ
値: 1(月額課金) | 2(従量課金)
Ancestor: router
Children: なし
description string ルーターのメモ(CDATA付)
Ancestor: router
Children: なし
versionInformation - ルータのversion情報
Ancestor: item
Children: isLatest | version
isLatest boolean ルータのversionが最新か
値: true(最新)
Ancestor: versionInformation
Children: なし
version string ルータのversion情報
Ancestor: versionInformation
Children: なし
networkInterfaceSet - ネットワークインターフェイス情報セット
Ancestor: router
Children: item
item - ネットワークインターフェイス情報
Ancestor: networkInterfaceSet
Children: networkId | networkName | ipAddress | dhcp | dhcpOptionsId | dhcpConfigId
networkId string ネットワークユニークID
Ancestor: item
Children: なし
networkName string ネットワーク名
Ancestor: item
Children: なし
ipAddress string IPアドレス
Ancestor: item
Children: なし
dhcp boolean dhcp設定フラグ
Ancestor: item
Children: なし
dhcpOptionsId string dhcpオプションID
Ancestor: item
Children: なし
dhcpConfigId string dhcpコンフィグID
Ancestor: item
Children: なし
backupInformation - バックアップ情報セット
Ancestor: item
Children: isBackup
isBackup boolean バックアップが存在するか
値: false(存在しない)
Ancestor: backupInformation
Children: なし
type string ルーターのタイプ
値: small | medium | large
Ancestor: router
Children: なし
groupSet - ファイアウォール情報セット
Ancestor: router
Children: item
item - ファイアウォール情報
Ancestor: groupSet
Children: groupId
groupId string ファイアウォールグループ名
Ancestor: item
Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyCreateRouter
  &RouterName=router1
  &AvailabilityZone=east-12
  &AccountingType=2
  &Description=memo
  &Type=small
  &NetworkInterface.1.NetworkId=net-COMMON_GLOBAL
  &NetworkInterface.2.NetworkId=net-ea2432dw
  &NetworkInterface.2.Dhcp=true
  &NetworkInterface.2.IpAddress=192.168.0.1
  &NetworkInterface.2.DhcpOptionsId=dopt-df45dsvd
  &NetworkInterface.2.DhcpConfigId=dconf-0k87jhf0
  &SecurityGroup.1=group01
  &CommonParams

  

応答サンプル

    <NiftyCreateRouterResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <router>
    <routerId>rt-8db04f81</routerId>
    <routerName>router1</routerName>
    <state>pending</state>
    <availabilityZone>east-12</availabilityZone>
    <accountingType>2</accountingType>
    <nextMonthAccountingType>2</nextMonthAccountingType>
    <description><![CDATA[memo]]></description>
    <versionInformation>
      <isLatest>true</isLatest>
      <version>v3.2</version>
    </versionInformation>
    <networkInterfaceSet>
      <item>
        <networkId>net-COMMON_GLOBAL</networkId>
        <dhcp>false</dhcp>
      </item>
      <item>
        <networkId>net-ea2432dw</networkId>
        <ipAddress>192.168.0.1</ipAddress>
        <dhcp>true</dhcp>
        <dhcpOptionsId>dopt-df45dsvd</dhcpOptionsId>
        <dhcpConfigId>dconf-0k87jhf0</dhcpConfigId>
      </item>
    </networkInterfaceSet>
    <backupInformation>
      <isBackup>false</isBackup>
    </backupInformation>
    <type>small</type>
    <groupSet>
      <item>
        <groupId>group01</groupId>
      </item>
    </groupSet>
  </router>
</NiftyCreateRouterResponse>

  

ニフクラ サイト内検索

APIメニュー

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

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