ニフクラAPI (コンピューティング: NiftyDescribePrivateLans)

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラユーザーガイド

クラウドトップ>コンピューティング> API> NiftyDescribePrivateLans

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 レスポンス
␣requestId	string	リクエスト識別子
␣privateLanSet	-	プライベートLAN情報セット
␣␣item	-	プライベートLAN情報
␣␣␣networkId	string	ネットワークユニークID
␣␣␣privateLanName	string	プライベートLAN名
␣␣␣state	string	プライベートLANのステータス値: pending (作成中・削除中) available (左記以外)
␣␣␣cidrBlock	string	プライベートLANのCIDR
␣␣␣availabilityZone	string	ゾーン情報
␣␣␣tagSet	-	※空を返却リソースに設定されているタグ情報セット
␣␣␣␣item	-	リソースに設定されているタグ情報
␣␣␣␣␣key	string	設定されているタグのキー
␣␣␣␣␣value	string	設定されているタグの値
␣␣␣accountingType	string	利用料金タイプ値: 1 (月額課金) 2 (従量課金)
␣␣␣nextMonthAccountingType	string	次月からの利用料金タイプ値: 1 (月額課金) 2 (従量課金)
␣␣␣description	string	プライベートLANのメモ(CDATA付き)
␣␣␣instancesSet	-	プライベートLANに接続しているサーバー情報セット
␣␣␣␣item	-	プライベートLANに接続しているサーバー情報
␣␣␣␣␣instanceUniqueId	string	サーバーユニークID
␣␣␣␣␣instanceId	string	サーバー名
␣␣␣␣␣deviceIndex	string	デバイス番号
␣␣␣␣␣ipAddress	string	IPアドレス
␣␣␣routerSet	-	プライベートLANに接続しているルーター情報セット
␣␣␣␣item	-	プライベートLANに接続しているルーター情報
␣␣␣␣␣routerId	string	ルーターユニークID
␣␣␣␣␣routerName	string	ルーター名
␣␣␣␣␣deviceIndex	string	デバイス番号
␣␣␣␣␣ipAddress	string	IPアドレス
␣␣␣vpnGatewaySet	-	プライベートLANに接続している拠点間VPNゲートウェイ情報セット
␣␣␣␣item	-	プライベートLANに接続している拠点間VPNゲートウェイ情報
␣␣␣␣␣vpnGatewayId	string	拠点間VPNゲートウェイユニークID
␣␣␣␣␣niftyVpnGatewayName	string	拠点間VPNゲートウェイ名
␣␣␣␣␣deviceIndex	string	デバイス番号
␣␣␣␣␣ipAddress	string	IPアドレス
␣␣␣elasticLoadBalancingSet	-	マルチロードバランサーの情報セット
␣␣␣␣item	-	マルチロードバランサーの情報
␣␣␣␣␣elasticLoadBalancerName	string	マルチロードバランサー名
␣␣␣␣␣protocol	string	プロトコル
␣␣␣␣␣elasticLoadBalancerPort	integer	待ち受けポート
␣␣␣␣␣instancePort	integer	宛先ポート
␣␣␣networkInterfaceSet	-	ネットワークインターフェースの情報セット
␣␣␣␣item	-	ネットワークインターフェースの情報
␣␣␣␣␣networkInterfaceId	string	ネットワークインターフェースID
␣␣␣␣␣ipAddress	string	IPアドレス
␣␣␣remoteAccessVpnGatewaySet	-	リモートアクセスVPNゲートウェイの情報セット
␣␣␣␣item	-	リモートアクセスVPNゲートウェイの情報
␣␣␣␣␣remoteAccessVpnGatewayId	string	リモートアクセスVPNゲートウェイID
␣␣␣␣␣remoteAccessVpnGatewayName	string	リモートアクセスVPNゲートウェイ名
␣␣␣␣␣deviceIndex	string	デバイス番号
␣␣␣␣␣ipAddress	string	IPアドレス
␣␣␣createdTime	timestamp	作成日時
␣␣␣sharingStatus	string	共有ステータス

リクエストサンプル

    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>