本文へジャンプします。

ニフティクラウド APIリファレンス

nifty-describe-instances

処理概要

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

指定したサーバーの情報を取得します。1回のリクエストで、複数のサーバー情報を取得できます。

サーバーを指定するためには、サーバー名が必要です。サーバーを指定しない場合は、取得可能なすべてのサーバー情報を取得します。削除済みのサーバーを指定した、管理外のサーバーを指定したなど、無効なIDを指定した場合は、エラーが返されます。

コマンド構文

nifty-describe-instances [サーバー名 ,tenancy=TENANCY[サーバー名 ,tenancy=TENANCY[...]]]

パラメーター 指定可能値 必須
tenancy=TENANCY テナント属性を指定します。
default (通常) | dedicated (専有) | all (全て)
 

オプション

オプション 短縮 説明 必須
--tenancy TENANCY   テナント属性を指定します。
default (通常) | dedicated (専有) | all (全て)
※サーバー名を指定しない場合は、オプションとして指定します。
 

出力要素

※ニフティクラウドAPIの応答フィールド名を記述します。

  • RESERVATION / reservationId
  • RESERVATION / ownerId
  • GROUP / groupId
  • INSTANCE / instanceId
  • INSTANCE / instanceUniqueId
  • INSTANCE / imageId
  • INSTANCE / dnsName
  • INSTANCE / privateDnsName
  • INSTANCE / instanceState.name
  • INSTANCE / keyName
  • INSTANCE / amiLaunchIndex
  • INSTANCE / productCodeId
  • INSTANCE / instanceType
  • INSTANCE / launchTime
  • INSTANCE / availabilityZone
  • INSTANCE / kernelId
  • INSTANCE / ramdiskId
  • INSTANCE / monitoring.state
  • INSTANCE / ipAddress
  • INSTANCE / privateIpAddress
  • INSTANCE / ipAddressV6
  • INSTANCE / privateIpAddressV6
  • INSTANCE / subnetId
  • INSTANCE / vpcId
  • INSTANCE / rootDeviceType
  • INSTANCE / accountingType
  • INSTANCE / nextMonthAccountingType
  • INSTANCE / copyInfo
  • INSTANCE / ipType
  • INSTANCE / privateIpType
  • INSTANCE / description
  • INSTANCE / architecture
  • INSTANCE / platform
  • INSTANCE / niftyPrivateNetworkType
  • INSTANCE / tenancy
  • INSTANCE / hotAdd
  • BLOCKDEVICE / deviceName
  • BLOCKDEVICE / volumeId
  • BLOCKDEVICE / status
  • BLOCKDEVICE / attachTime
  • LOADBALANCING / loadBalancerName
  • LOADBALANCING / loadBalancerPort
  • LOADBALANCING / instancePort
  • LOADBALANCING / State
  • AUTO-SCALING / autoScalingGroupName
  • AUTO-SCALING / expireTime
  • SNAPSHOTTING / state
  • NETWORK_INTERFACE / niftyNetworkId
  • NETWORK_INTERFACE / niftyNetworkName
  • NETWORK_INTERFACE / status
  • NETWORK_INTERFACE / macAddress
  • NETWORK_INTERFACE / privateIpAddress
  • NETWORK_INTERFACE / privateIpAddressV6
  • NETWORK_INTERFACE_ATTACHMENT / deviceIndex
  • NETWORK_INTERFACE_ATTACHMENT / status
  • NETWORK_INTERFACE_ATTACHMENT / deleteOnTermination
  • NETWORK_INTERFACE_ASSOCIATION / publicIp
  • NETWORK_INTERFACE_ASSOCIATION / publicIpV6

実行サンプル

PROMPT>nifty-describe-instances server01,tenancy=default
RESERVATION      
INSTANCE server01 i-abfd1234  1  111.171.201.1  10.10.10.10  running  keyname01      mini
2010-08-17T01:15:16.223Z  east-11 monitoring-disabled  111.171.201.1  10.10.10.10
disk  1  server02  static elastic memo STANDARD default 0
BLOCKDEVICE SCSI(0:1)  disk01  attached 2010-11-13T09:15:26.111Z
LOADBALANCING lb0001 80 80
SNAPSHOTTING normal
NETWORK_INTERFACE net-COMMON_GLOBAL available 00-00-00-00-00-00
NETWORK_INTERFACE_ATTACHMENT 0 attached true
NETWORK_INTERFACE_ASSOCIATION 111.171.202.1
NETWORK_INTERFACE net-COMMON_PRIVATE available 00-00-00-00-00-00 10.0.5.111 2001:0db8:bd05:01d2:288a:1fc0:0001:10ee
NETWORK_INTERFACE_ATTACHMENT 0 attaching true

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

APIメニュー

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

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