本文へジャンプします。

ニフクラ ユーザーガイド

NiftyDescribePrivateLans

処理概要

指定されたプライベートLANの情報を取得します。
プライベートLANを指定するためには、ネットワークユニークIDまたはプライベートLAN名が必要です。
プライベートLANを指定しない場合、取得できるすべてのプライベートLAN情報を取得します。

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

指定するパラメーター

パラメーター 説明 必須
NetworkId.n string ネットワークユニークID
PrivateLanName.n string プライベートLAN名
Filter.n.Name 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 string 絞り込み条件の項目の値

応答フィールド

フィールド (項目) 説明
NiftyDescribePrivateLansResponse - NiftyDescribePrivateLans レスポンス
Ancestor: なし
Children: requestId | privateLanSet
requestId string リクエスト識別子
Ancestor: NiftyDescribePrivateLansResponse
Children: なし
privateLanSet - プライベートLAN情報セット
Ancestor: NiftyDescribePrivateLansResponse
Children: item
item - プライベートLAN情報
Ancestor: privateLanSet
Children: networkId | privateLanName | state | cidrBlock | availabilityZone | tagSet | accountingType | nextMonthAccountingType | description | instancesSet | routerSet | vpnGatewaySet | elasticLoadBalancingSet | networkInterfaceSet | remoteAccessVpnGatewaySet | createdTime | sharingStatus
networkId string ネットワークユニークID
Ancestor: item
Children: なし
privateLanName string プライベートLAN名
Ancestor: item
Children: なし
state string プライベートLANのステータス
値: pending(作成中・削除中) | available(左記以外)
Ancestor: item
Children: なし
cidrBlock string プライベートLANのCIDR
Ancestor: item
Children: なし
availabilityZone string ゾーン情報
Ancestor: item
Children: なし
tagSet - ※空を返却
リソースに設定されているタグ情報セット
Ancestor: item
Children: item
item - リソースに設定されているタグ情報
Ancestor: tagSet
Children: key | value
key string 設定されているタグのキー
Ancestor: item
Children: なし
value string 設定されているタグの値
Ancestor: item
Children: なし
accountingType string 利用料金タイプ
値: 1 (月額課金) | 2 (従量課金)
Ancestor: item
Children: なし
nextMonthAccountingType string 次月からの利用料金タイプ
値: 1 (月額課金) | 2 (従量課金)
Ancestor: item
Children: なし
description string プライベートLANのメモ(CDATA付き)
Ancestor: item
Children: なし
instancesSet - プライベートLANに接続しているサーバー情報セット
Ancestor: item
Children: item
item - プライベートLANに接続しているサーバー情報
Ancestor: instancesSet
Children: instanceUniqueId | instanceId | deviceIndex | ipAddress
instanceUniqueId string サーバーユニークID
Ancestor: item
Children: なし
instanceId string サーバー名
Ancestor: item
Children: なし
deviceIndex integer デバイス番号
Ancestor: item
Children: なし
ipAddress string IPアドレス
Ancestor: item
Children: なし
routerSet - プライベートLANに接続しているルーター情報セット
Ancestor: item
Children: item
item - プライベートLANに接続しているルーター情報
Ancestor: routerSet
Children: routerId | routerName | deviceIndex | ipAddress
routerId string ルーターユニークID
Ancestor: item
Children: なし
routerName string ルーター名
Ancestor: item
Children: なし
deviceIndex integer デバイス番号
Ancestor: item
Children: なし
ipAddress string IPアドレス
Ancestor: item
Children: なし
vpnGatewaySet - プライベートLANに接続している拠点間VPNゲートウェイ情報セット
Ancestor: item
Children: item
item - プライベートLANに接続している拠点間VPNゲートウェイ情報
Ancestor: vpnGatewaySet
Children: vpnGatewayId | niftyVpnGatewayName | deviceIndex | ipAddress
vpnGatewayId string 拠点間VPNゲートウェイユニークID
Ancestor: item
Children: なし
niftyVpnGatewayName string 拠点間VPNゲートウェイ名
Ancestor: item
Children: なし
deviceIndex integer デバイス番号
Ancestor: item
Children: なし
ipAddress string IPアドレス
Ancestor: item
Children: なし
elasticLoadBalancingSet - マルチロードバランサーの情報セット
Ancestor: item
Children: item
item - マルチロードバランサーの情報
Ancestor: elasticLoadBalancingSet
Children: elasticLoadBalancerName | protocol | elasticLoadBalancerPort | instancePort
elasticLoadBalancerName string マルチロードバランサー名
Ancestor: item
Children: なし
protocol string プロトコル
Ancestor: item
Children: なし
elasticLoadBalancerPort integer 待ち受けポート
Ancestor: item
Children: なし
instancePort integer 宛先ポート
Ancestor: item
Children: なし
networkInterfaceSet - ネットワークインターフェースの情報セット
Ancestor: item
Children: item
item - ネットワークインターフェースの情報
Ancestor: networkInterfaceSet
Children: networkInterfaceId | ipAddress
networkInterfaceId string ネットワークインターフェースID
Ancestor: item
Children: なし
ipAddress string IPアドレス
Ancestor: item
Children: なし
remoteAccessVpnGatewaySet - リモートアクセスVPNゲートウェイの情報セット
Ancestor: item
Children: item
item - リモートアクセスVPNゲートウェイの情報
Ancestor: remoteAccessVpnGatewaySet
Children: remoteAccessVpnGatewayId | remoteAccessVpnGatewayName | deviceIndex | ipAddress
remoteAccessVpnGatewayId string リモートアクセスVPNゲートウェイID
Ancestor: item
Children: なし
remoteAccessVpnGatewayName string リモートアクセスVPNゲートウェイ名
Ancestor: item
Children: なし
deviceIndex integer デバイス番号
Ancestor: item
Children: なし
ipAddress string IPアドレス
Ancestor: item
Children: なし
createdTime timestamp 作成日時
Ancestor: item
Children: なし
sharingStatus 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://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <privateLanSet>
    <item>
      <networkId>net-8db04f81</networkId>
      <privateLanName>networkName</privateLanName>
      <state>available</state>
      <cidrBlock>192.168.1.0/24</cidrBlock>
      <availabilityZone>east-12</availabilityZone>
      <tagSet/>
      <accountingType>2</accountingType>
      <nextMonthAccountingType>1</nextMonthAccountingType>
      <description><![CDATA[memo]]></description>
      <instancesSet>
        <item>
          <instanceUniqueId>i-0xeyoo31</instanceUniqueId>
          <instanceId>server01</instanceId>
          <deviceIndex>0</deviceIndex>
          <ipAddress>192.168.1.3</ipAddress>
        </item>
      </instancesSet>
      <routerSet>
        <item>
          <routerId>rt-0ewfhz7j</routerId>
          <routerName>testRouter01</routerName>
          <deviceIndex>4</deviceIndex>
          <ipAddress>192.168.1.1</ipAddress>
        </item>
      </routerSet>
      <vpnGatewaySet>
        <item>
          <vpnGatewayId>vgw-0id41jxf</vpnGatewayId>
          <niftyVpnGatewayName>vpngw1</niftyVpnGatewayName>
          <deviceIndex>0</deviceIndex>
          <ipAddress>192.168.1.5</ipAddress>
        </item>
      </vpnGatewaySet>
      <elasticLoadBalancingSet>
        <item>
          <elasticLoadBalancerName>mlb01</elasticLoadBalancerName>
          <protocol>TCP</protocol>
          <elasticLoadBalancerPort>443</elasticLoadBalancerPort>
          <instancePort>443</instancePort>
        </item>
      </elasticLoadBalancingSet>
      <networkInterfaceSet>
        <item>
          <networkInterfaceId>ni-3db04f80</networkInterfaceId>
          <ipAddress>192.168.1.2</ipAddress>
        </item>
      </networkInterfaceSet>
      <remoteAccessVpnGatewaySet>
        <item>
          <remoteAccessVpnGatewayId>ravgw-0v3nmzxz</remoteAccessVpnGatewayId>
          <remoteAccessVpnGatewayName>RAVPNGW</remoteAccessVpnGatewayName>
          <deviceIndex>0</deviceIndex>
          <ipAddress>192.168.1.7</ipAddress>
        </item>
      </remoteAccessVpnGatewaySet>
      <createdTime>2014-10-28T10:16:38+09:00</createdTime>
      <sharingStatus>none</sharingStatus>
    </item>
  </privateLanSet>
</NiftyDescribePrivateLansResponse>

  

ニフクラ サイト内検索

APIメニュー

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

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