本文へジャンプします。

ニフクラ APIリファレンス

NiftyDescribePrivateLans

処理概要

指定されたプライベートLANの情報を取得します。
プライベートLANを指定するためには、ネットワークユニークIDまたはプライベートLAN名が必要です。削除済みのプライベートLANを指定した、管理外のプライベートLANを指定したなど、無効なプライベートLANを指定した場合は、エラーが返されます。
プライベートLANを指定しない場合、取得できるすべてのプライベートLAN情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字(曖昧検索)指定可能です。「∗」は0個以上任意文字、「?」は1個任意文字、「¥」はエスケープ変換文字(「¥∗nifty¥?¥¥」は「∗nifty?¥」を検索)となります。
曖昧検索が指定可能な絞り込み条件の項目名は、private-lan-name、descriptionになります。

指定するパラメーター

パラメーター 説明 必須 サンプル値
NetworkId.n ネットワークユニークID
Type : String
   
PrivateLanName.n プライベートLAN名
Type : String
   
Filter.n.Name 絞り込み条件の項目名
Type : String
値 : availabilityZone, availability-zone (ゾーン情報) | cidrBlock, cidr, cidr-block(プライベートLANのCIDR) | state(プライベートLANのステータス) | network-id(ネットワークユニークID) | private-lan-name(プライベートLAN名) | accountingType(利用料金タイプ) | description(プライベートLANのメモ)
   
Filter.n.Value.m 絞り込み条件の項目の値
Type : String
   

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyDescribePrivateLansResponse NiftyDescribePrivateLans レスポンス
Type : NiftyDescribePrivateLansResponseType
Ancestor : なし
Children : requestId, privateLanSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyDescribePrivateLansResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
privateLanSet プライベートLAN情報セット
Type : PrivateLanSetType
Ancestor : NiftyDescribePrivateLansResponse
Children : item
 
item プライベートLAN情報
Type : PrivateLanType
Ancestor : privateLanSet
Children : networkId,privateLanName,state,cidrBlock,availabilityZone,tagSet,accountingType,description,instancesSet,routerSet,vpnGatewaySet,createdTime,elasticLoadBalancingSet,createdTime, sharingStatus, networkInterfaceSet
 
networkId ネットワークユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
privateLanName プライベートLAN名
Type : xsd:string
Ancestor : item
Children : なし
 
state プライベートLANのステータス
Type : xsd:string
値 : pending(作成中・削除中) | available(左記以外)
Ancestor : item
Children : なし
 
cidrBlock プライベートLANのCIDR
Type : xsd:string
Ancestor : item
Children : なし
 
availabilityZone ゾーン情報
Type : xsd:string
Ancestor : item
Children : なし
 
tagSet リソースに設定されているタグ情報セット
Type : ResourceTagSetType
Ancestor : item
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 : item
Children : なし
 
nextMonthAccountingType 次月からの利用料金タイプ
Type : xsd:string
値 : 1 (月額課金) | 2 (従量課金)
Ancestor: item
Children : なし
 
description プライベートLANのメモ
Type : xsd:string
Ancestor : item
Children : なし
 
instancesSet プライベートLANに接続しているサーバー情報セット
Type : InstanceIdSetType
Ancestor : item
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 : item
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 : item
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 : なし
 
elasticLoadBalancingSet マルチロードバランサーの情報セット
Type : ElasticLoadBalancerSetTypee
Ancestor : item
Children : item
 
item マルチロードバランサーの情報
Type : ElasticLoadBalancerType
Ancestor : elasticLoadBalancingSet
Children : elasticLoadBalancerName, protocol, elasticLoadBalancerPort, instancePort
 
elasticLoadBalancerName マルチロードバランサー名
Type : xsd:string
Ancestor : item
Children : なし
 
protocol プロトコル
Type : xsd:string
Ancestor : item
Children : なし
 
elasticLoadBalancerPort 待ち受けポート
Type : xsd:integer
Ancestor : item
Children : なし
 
instancePort 宛先ポート
Type : xsd:integer
Ancestor : item
Children : なし
 
networkInterfaceSet ネットワークインターフェースの情報セット
Type : NetworkInterfaceSetType
Ancestor : item
Children : item
 
item ネットワークインターフェースの情報
Type : NetworkInterfaceType
Ancestor : networkInterfaceSet
Children : networkInterfaceId,ipAddress
 
networkInterfaceId ネットワークインターフェースID
Type : xsd:string
Ancestor : item
Children : なし
 
ipAddress IPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
createdTime 作成日時
Type : xsd:dateTime
Ancestor : item
Children : なし
 
sharingStatus 共有ステータス
Type : xsd:string
Ancestor : item
Children : なし
 

リクエストサンプル

https://jp-east-1.computing.api.nifcloud.com/api/?Action=NiftyDescribePrivateLans&Filter.1.Name=state&Fileter.1.Value.1=available&NetworkId.1=net-8db04f81&CommonParams

応答サンプル

<NiftyDescribePrivateLansResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <privateLanSet> 
  <item> 
   <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>
   <nextMonthAccountingType>1</nextMonthAccountingType>
   <description>memo</description>
   <instancesSet/>
   <routerSet/>
   <vpnGatewaySet/>
   <elasticLoadBalancingSet/>
   <networkInterfaceSet>
     <item>
       <networkInterfaceId>ni-3db04f80</networkInterfaceId>
       <ipAddress>10.0.1.1</ipAddress>
     </item>
   </networkInterfaceSet>
   <createdTime>2014-10-28T10:16:38+09:00</createdTime>
   <sharingStatus>none</sharingStatus> 
  </item> 
 </privateLanSet> 
</NiftyDescribePrivateLanResponse>

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

APIメニュー

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

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