本文へジャンプします。

ニフクラ APIリファレンス

nifty-describe-privatelans

処理概要

API「 NiftyDescribePrivateLans 」が実行されます。

指定されたプライベートLANの情報を取得します。

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

プライベートLANを指定しない場合、取得できるすべてのプライベートLAN情報を取得します。

絞り込み条件の項目の値を指定する際、ワイルドカード文字(曖昧検索)指定可能です。「 」は0個以上任意文字、 「?」は1個任意文字、「\」はエスケープ変換文字(「*nifty\?\ 」は「 nifty?\」を検索)となります。

曖昧検索が指定可能な絞り込み条件の項目名は、private-lan-name、descriptionになります。

コマンド構文

nifty-describe-privatelans [オプション]

オプション

オプション 短縮 説明 必須
--network-id ID1 [,ID2 ,...] ネットワークユニークIDを指定します。
--privatelan-name NAME1 [,NAME2 ,...] プライベートLAN名を指定します。
--filter "ATTRIBUTE1=VALUE1[,VALUE2,...]" [--filter "ATTRIBUTE2=VALUE1[,VALUE2,...]"] [...] 絞り込み条件を指定します。
“availabilityZone / availability-zone =値1,値2,…” : ゾーン情報による絞り込み
“cidrBlock / cidr / cidr-block(=値1,値2,…” : プライベートLANのCIDRによる絞り込み
“state=値1,値2,…” : プライベートLANのステータスによる絞り込み
“network-id=値1,値2,…” : ネットワークユニークIDによる絞り込み
“private-lan-name=値1,値2,…” : プライベートLAN名による絞り込み
“accountingType=値1,値2,…” :利用料金タイプによる絞り込み
“description=値1,値2,…” : プライベートLANのメモによる絞り込み

出力要素

  • PRIVATELAN / networkId
  • PRIVATELAN / privateLanName
  • PRIVATELAN / state
  • PRIVATELAN / cidrBlock
  • PRIVATELAN / availabilityZone
  • PRIVATELAN / accountingType
  • PRIVATELAN / nextMonthAccountingType
  • PRIVATELAN / description
  • PRIVATELAN / createdTime
  • PRIVATELAN / sharingStatus
  • INSTANCE / instanceUniqueId
  • INSTANCE / instanceId
  • INSTANCE / deviceIndex
  • INSTANCE / ipAddress
  • ROUTER / routerId
  • ROUTER / routerName
  • ROUTER / deviceIndex
  • ROUTER / ipAddress
  • VPNGATEWAY / vpnGatewayId
  • VPNGATEWAY / niftyVpnGatewayName
  • VPNGATEWAY / deviceIndex
  • VPNGATEWAY / ipAddress
  • NETWORK_INTERFACE / networkInterfaceId
  • NETWORK_INTERFACE / ipAddress
  • ELASTICLOADBALANCING / elasticLoadBalancerName
  • ELASTICLOADBALANCING / protocol
  • ELASTICLOADBALANCING / elasticLoadBalancerPort
  • ELASTICLOADBALANCING / instancePort

実行サンプル

PROMPT>nifty-describe-privatelans --network-id net-8db04f81
PRIVATELAN net-8db04f81 networkName available 10.0.1.0/24 east-12 2 1_memo 2014-10-28T10:16:38+09:00 none
INSTANCE i-efba9876 server01 0 111.171.202.1
ROUTER rt-8db04f81 router01 0 111.171.134.16
VPNGATEWAY vgw-8db04f81 vpn01 0 111.171.134.162

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

APIメニュー

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

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