本文へジャンプします。

ニフティクラウド APIリファレンス

NiftyCreateRouter

処理概要

ルーターを新規作成します。
ルーターに割り当てるネットワークを指定するためには、ネットワークIDまたはネットワーク名が必要です。削除済みのネットワークを指定した、管理外のネットワークを指定したなど、無効なネットワークを指定した場合は、エラーが返されます。同様に、ルーターのタイプに規定外の値を指定した、すでに存在するルーター名を指定した、利用料金タイプに無効な値を指定したなどの場合は、エラーが返されます。
作成したルーターのゾーンは指定したネットワークと同一のゾーンになります。

指定するパラメーター

パラメーター 説明 必須 サンプル値
RouterName ルーター名
Type : String
   
AvailabilityZone ゾーン名
Type : String
Default: ニフティクラウドが決定
   
AccountingType 利用料金タイプ
Type : String
値 : 1 (月額課金) | 2 (従量課金)
Default : 2
   
Description メモ
Type : String
   
Type ルーターのタイプ
Type : String
値: small | medium | large
Default : small
   
NetworkInterface.n.DeviceIndex ※指定不可
Type : Integer
   
NetworkInterface.n.SecurityGroupId.n ※指定不可
Type : String
   
NetworkInterface.n.NetworkId ネットワークID
Type : String
値 : net-COMMON_GLOBAL (共通グローバル) | net-COMMON_PRIVATE (共通プライベート) | プライベートLAN のネットワークID

(ネットワーク名といずれか)
 
NetworkInterface.n.NetworkName ネットワーク名
Type : String
Default: なし

(ネットワーク名といずれか)
 
NetworkInterface.n.IpAddress IPアドレス
Type: String
Default:なし
   
NetworkInterface.n.Dhcp dhcp設定フラグ
Type : Boolean
Default: false
   
NetworkInterface.n.DhcpOptionsId dhcpオプションID
Type : String
Default: なし
   
NetworkInterface.n.DhcpConfigId dhcpコンフィグID
Type: String
Default:なし
   
SecurityGroup.n ファイアウォールグループ名
Type : String
Default: なし
   

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyCreateRouterResponse NiftyCreateRouterレスポンス
Type : NiftyCreateRouterResponseType
Ancestor : なし
Children : requestId, router
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyCreateRouterResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
router ルーター情報
Type : routerType
Ancestor : NiftyCreateRouterResponse
Children : routerId,routerName,state,availabilityZone,tagSet,accountingType, versionInformation,nextMonthAccountingType,description, networkInterfaceSet, routeTableId,routeTableAssociationId,natTableId,natTableAssociationId,backupInformation,type,createdTime
 
routerId ルーターユニークID
Type : xsd:string
Ancestor : router
Children : なし
 
routerName ルーター名
Type : xsd:string
Ancestor : router
Children : なし
 
state ルーターのステータス
Type : xsd:string
値 : pending (処理中) | available (起動中) | stopped (停止済み) | warning (異常あり)
Ancestor : router
Children : なし
 
availabilityZone ゾーン情報
Type : xsd:string
Ancestor : router
Children : なし
 
tagSet リソースに設定されているタグ情報セット
Type : ResourceTagSetType
Ancestor : router Children : item
 
item リソースに設定されているタグ情報
Type : ResourceTagSetItemType
Ancestor : tagSet
Children : なし
 
key 設定されているタグのキー
Type : xsd:string
Ancestor : item
Children : なし
 
value 設定されているタグの値
Type : xsd:string
Ancestor : item
Children : なし
 
accountingType 利用料金タイプ
Type : xsd:string
値 : 1 (月額課金) | 2 (従量課金)
Ancestor : router
Children : なし
 
nextMonthAccountingType 翌月の利用料金タイプ
Type : xsd:string
値 : 1 (月額課金) | 2 (従量課金)
Ancestor : router
Children : なし
 
description ルーターのメモ
Type : xsd:string
Ancestor : router
Children : なし
 
versionInformation ルータのversion情報
Type :VersionInformationType
Ancestor :item
Children :isLatest, version
 
isLatest ルータのversion最新状態
Type :xsd:boolean
Ancestor :versionInformation
Children :なし
 
version ルータのversion情報
Type :xsd:string
Ancestor :versionInformation
Children :なし
 
networkInterfaceSet ネットワークインターフェイス情報セット
Type : NetworkInterfaceSetType
Ancestor : router
Children : item
 
item ネットワークインターフェイス情報
Type : NetworkInterfaceSetItemType
Ancestor : networkInterfaceSet
Children : networkId,networkName,deviceIndex,ipAddress,cidrBlock,description, dhcp,dhcpOptionId
 
networkId ネットワークユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
networkName ネットワーク名
Type : xsd:string
Ancestor : item
Children : なし
 
deviceIndex デバイス番号
Type : xsd:intger
Ancestor : item
Children : なし
 
ipAddress IPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
cidrBlock ネットワークのCIDR
Type : xsd:string
Ancestor : item
Children : なし
 
dhcp dhcp設定フラグ
Type : xsd:boolean
Ancestor : item
Children : なし
 
dhcpOptionsId dhcpオプションID
Type : xsd:string
Ancestor : item
Children : なし
 
dhcpConfigId dhcpコンフィグID
Type :xsd:string
Ancestor :item
Children :なし
 
description ネットワークのメモ
Type : xsd:string
Ancestor : item
Children : なし
 
routeTableId ルートテーブルID
Type : xsd:string
Ancestor : router
Children : なし
 
routeTableAssociationId ルートテーブル適用ID
Type :xsd:string
Ancestor :router
Children :なし
 
natTableId natテーブルID
Type : xsd:string
Ancestor : router
Children : なし
 
natTableAssociationId natテーブル適用ID
Type :xsd:string
Ancestor : router
Children :なし
 
backupInformation バックアップ情報セット
Type :BackupInformationType
Ancestor :item
Children :isBackup, expirationDate
 
isBackup バックアップが存在するか
Type :xsd:boolean
Ancestor :backupInformation
Children :なし
 
expirationDate バックアップの保持期限
Type :xsd:dateTime
Ancestor :backupInformation
Children :なし
 
type ルーターのタイプ
Type : xsd:string
値 : small | medium | large
Ancestor : router
Children : なし
 
groupSet ファイアウォール情報セット
Type : GroupSetType
Ancestor : router
Children : item
 
item ファイアウォール情報
Type : GroupItemType
Ancestor : groupSet
Children : groupId
 
groupId ファイアウォールグループ名
Type : xsd:string
Ancestor : item
Children : なし
 
createdTime 作成日時
Type : xsd: dateTime
Ancestor : router
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.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&CommonParams

応答サンプル

<NiftyCreateRouterResponse xmlns="https://cp.cloud.nifty.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>memo</description>
  <versionInformation>
    <isLatest>true</isLatest>
    <version>vyos 1.1.5</version>
  </versionInformation>
  <backupInformation>
    <isBackup>false</isBackup>
  </backupInformation>
   <networkInterfaceSet>
      <item>
         <networkId>net-COMMON_GLOBAL</networkId>
         <dhcp>false</dhcp>
      </item>
      <item>
         <networkId>net-ea2432dw</networkId>
         <dhcp>true</dhcp>
         <ipAddress>192.168.0.1</ipAddress>
         <dhcpOptionsId>dopt-df45dsvd</dhcpOptionsId>
         <dhcpConfigId>dconf-0k87jhf0</dhcpConfigId>
      </item>
   </networkInterfaceSet>
  <type>small</type>
   <groupSet/>
 </router> 
</NiftyCreateRouterResponse>

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

APIメニュー

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

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