本文へジャンプします。

ニフクラ APIリファレンス

NiftyCreatePrivateLan

処理概要

プライベートLANを新規作成します。

指定するパラメーター

パラメーター 説明 必須 サンプル値
PrivateLanName プライベートLAN名
Type : String
Default : 英数8文字(システム発行)
   
CidrBlock プライベートLANのCIDR
Type : String
 
AvailabilityZone ゾーン情報
Type : String
   
AccountingType 利用料金タイプ
Type : String
値 : 1 (月額課金) | 2 (従量課金)
Default : 2
   
Description プライベートLANのメモ
Type : String
Default : なし
   

応答フィールド

フィールド 説明 サンプル値
NiftyCreatePrivateLanResponse NiftyCreatePrivateLanレスポンス
Type : NiftyCreatePrivateLanResponseType
Ancestor : なし
Children : requestId, privateLan
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyCreatePrivateLanResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
privateLan プライベートLAN情報
Type : NetworkType
Ancestor : NiftyCreatePrivateLanResponse
Children : networkId,privateLanName,state,cidrBlock,availabilityZone,tagSet,accountingType,description,instancesSet,routerSet,vpnGatewaySet,createdTime
 
networkId ネットワークユニークID
Type : xsd:string
Ancestor : privateLan
Children : なし
 
privateLanName プライベートLAN名
Type : xsd:string
Ancestor : privateLan
Children : なし
 
state プライベートLANのステータス
Type : xsd:string
値 : pending(作成中・削除中) | available(左記以外)
Ancestor : privateLan
Children : なし
 
cidrBlock プライベートLANのCIDR
Type : xsd:string
Ancestor : privateLan
Children : なし
 
availabilityZone ゾーン情報
Type : xsd:string
Ancestor : privateLan
Children : なし
 
tagSet リソースに設定されているタグ情報セット
Type : ResourceTagSetType
Ancestor : privateLan
Children : item
 
item リソースに設定されているタグ情報
Type : ResourceTagSetItemType
Ancestor : tagSet
Children : key, value
 
key 設定されているタグのキー
Type : xsd:string
Ancestor : item
Children : なし
 
value 設定されているタグの値
Type : xsd:string
Ancestor : item
Children : なし
 
accountingType 利用料金タイプ
Type : xsd:string
値 : 1 (月額課金) | 2 (従量課金)
Ancestor : privateLan
Children : なし
 
description プライベートLANのメモ
Type : xsd:string
Ancestor : privateLan
Children : なし
 
instancesSet プライベートLANに接続しているサーバー情報セット
Type : InstanceIdSetType
Ancestor : privateLan
Children : item
 
item プライベートLANに接続しているサーバー情報
Type : InstanceIdType
Ancestor : instancesSet
Children : instanceUniqueId,instanceId,deviceIndex,ipAddress
 
instanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
instanceId サーバー名
Type : xsd:string
Ancestor : item
Children : なし
 
deviceIndex デバイス番号
Type : xsd:int
Ancestor : item
Children : なし
 
ipAddress IPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
routerSet プライベートLANに接続しているルーター情報セット
Type : RouterIdSetType
Ancestor : privateLan
Children : item
 
item プライベートLANに接続しているルーター情報
Type : RouterIdType
Ancestor : routerSet
Children : routerId,routerName,deviceIndex,ipAddress
 
routerId ルーターユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
routerName ルーター名
Type : xsd:string
Ancestor : item
Children : なし
 
deviceIndex デバイス番号
Type : xsd:int
Ancestor : item
Children : なし
 
ipAddress IPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
vpnGatewaySet プライベートLANに接続しているVPNゲートウェイ情報セット
Type : VpnGatewayIdSetType
Ancestor : privateLan
Children : item
 
item プライベートLANに接続しているVPNゲートウェイ情報
Type : VpnGatewayIdType
Ancestor : vpnGatewaySet
Children : vpnGatewayId,niftyVpnGatewayName,deviceIndex,ipAddress
 
vpnGatewayId ルーターユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
niftyVpnGatewayName ルーター名
Type : xsd:string
Ancestor : item
Children : なし
 
deviceIndex デバイス番号
Type : xsd:int
Ancestor : item
Children : なし
 
ipAddress IPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
createdTime 作成日時
Type : xsd: dateTime
Ancestor : privateLan
Children : なし
 

リクエストサンプル

https://jp-east-1.computing.api.nifcloud.com/api/?AccountingType=2&\Action=NiftyCreatePrivateLan&Placement.AvailabilityZone=east-12&CidrBlock=192.168.0.0%2F16&Description=memo&PrivateLanName=privateLanName&CommonParams

応答サンプル

<NiftyCreatePrivateLanResponse xmlns="https://cp.cloud.nifty.com/api/">   
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>  
 <privateLan>  
  <networkId>net-8db04f81</networkId> 
  <privateLanName>networkName</privateLanName> 
  <state>available</state> 
  <cidrBlock>10.0.1.0/24</cidrBlock> 
  <availabilityZone>east-12</availabilityZone> 
  <tagSet/> 
  <accountingType>2</accountingType> 
  <description>memo</description> 
  <instancesSet/> 
  <routerSet/> 
  <vpnGatewaySet/> 
  <createdTime>2014-10-28T10:16:38+09:00</createdTime>
 </privateLan>  
</NiftyCreatePrivateLanResponse>

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

APIメニュー

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

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