本文へジャンプします。

ニフクラ ユーザーガイド

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

DescribeInstances

処理概要

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

指定するパラメーター

パラメーター 型 説明 必須
InstanceId.n string サーバー名
Default: 空 (取得可能なすべてのサーバー)
Tenancy.n string テナント属性
値: dafault (通常) | dedicated (専有) | all (全て)
Default: default

応答フィールド

フィールド (項目) 型 説明
DescribeInstancesResponse DescribeInstancesResponseType DescribeInstancesレスポンス
Ancestor: なし
Children: requestId | reservationSet
requestId string リクエスト識別子
Ancestor: DescribeInstancesResponse
Children: なし
reservationSet ReservationSetType 取得した情報セット
Ancestor: DescribeInstancesResponse
Children: item
item ReservationInfoType 取得した情報
Ancestor: reservationSet
Children: reservationId | ownerId | groupSet | instancesSet
reservationId string ※返却値なし
Ancestor: item
Children: なし
ownerId string ※返却値なし
Ancestor: item
Children: なし
groupSet GroupSetType 適用しているファイアウォールグループ情報
Ancestor: item
Children: item
item GroupItemType ファイアウォールグループ情報
Ancestor: groupSet
Children: groupId
groupId string ファイアウォールグループ名
Ancestor: item
Children: なし
instancesSet RunningInstancesSetType 取得したサーバーの情報セット
Ancestor: item
Children: item
item RunningInstancesItemType 取得したサーバーの情報
Ancestor: instancesSet
Children: instanceId | instanceUniqueId | imageId | instanceState | privateDnsName | dnsName | reason | keyName | amiLaunchIndex | productCodes | instanceType | launchTime | placement | kernelId | ramdiskId | platform | monitoring | subnetId | vpcId | privateIpAddress | ipAddress | privateIpAddressV6 | ipAddressV6 | stateReason | architecture | rootDeviceType | rootDeviceName | blockDeviceMapping | instanceLifecycle | spotInstanceRequestId | accountingType | nextMonthAccountingType | loadbalancing | copyInfo | autoscaling | ipType | niftyPrivateIpType | description | niftySnapshotting | niftyPrivateNetworkType | tenancy | networkInterfaceSet | imageName | hotAdd | niftyElasticLoadBalancing | instanceBackupRule | isoImageSet
instanceId string サーバー名
Ancestor: item
Children: なし
instanceUniqueId string サーバーユニークID
Ancestor: item
Children: なし
imageId string OSイメージID
Ancestor: item
Children: なし
instanceState InstanceStateType サーバーの現在のステータス
Ancestor: item
Children: code | name
code integer 現在のステータスコード
値: 0 (pending) | 16 (running) | 80 (stopped) | 96 (warning) | 112 (waiting) | 128 (creating) | 201 (suspending) | 202 (uploading) | 203 (import_error)
Ancestor: instanceState
Children: なし
name string 現在のステータス名
値: pending (処理中) | running (起動済み) | stopped (停止済み) | warning (異常あり) | waiting (作成待ち) | creating (作成中) | suspending (アップロード一時停止) | uploading (アップロード中) | import_error (インポートエラー)
Ancestor: instanceState
Children: なし
privateDnsName string プライベートIPアドレス
Ancestor: item
Children: なし
dnsName string グローバルIPアドレス
Ancestor: item
Children: なし
reason string ※返却値なし
Ancestor: item
Children: なし
keyName string SSHキー名
Ancestor: item
Children: なし
amiLaunchIndex string ※返却値なし
Ancestor: item
Children: なし
productCodes ProductCodesSetType ※返却値なし
Ancestor: item
Children: item
item ProductCodesSetItemType ※返却値なし
Ancestor: productCodes
Children: productCode
productCode string ※返却値なし
Ancestor: item
Children: なし
instanceType string サーバータイプ
値: e-mini | mini | c-small | e-small | small | c-small2 | e-small2 | small2 | c-small4 | e-small4 | small4 | e-small8 | small8 | e-small16 | small16 | c-medium | e-medium | medium | c-medium4 | e-medium4 | medium4 | c-medium8 | e-medium8 | medium8 | e-medium16 | medium16 | e-medium24 | medium24 | c-large | e-large | large | c-large8 | e-large8 | large8 | e-large16 | large16 | e-large24 | large24 | e-large32 | large32 | e-extra-large8 | extra-large8 | e-extra-large16 | extra-large16 | e-extra-large24 | extra-large24 | e-extra-large32 | extra-large32 | e-extra-large48 | extra-large48 | e-double-large16 | double-large16 | e-double-large24 | double-large24 | e-double-large32 | double-large32 | e-double-large48 | double-large48 | e-double-large64 | double-large64 | e-double-large96 | double-large96 | triple-large48 | triple-large64 | triple-large96 | triple-large128 | quad-large128 | quad-large256 | septa-large256
Ancestor: item
Children: なし
launchTime timestamp サーバーの作成日時(yyyy-mm-ddThh:mi:ss.sssZ)
Ancestor: item
Children: なし
placement PlacementResponseType ゾーン情報
Ancestor: item
Children: availabilityZone
availabilityZone string ゾーン情報
Ancestor: placement
Children: なし
kernelId string ※返却値なし
Ancestor: item
Children: なし
ramdiskId string ※返却値なし
Ancestor: item
Children: なし
platform string OS種別
値: windows | redhat | centos | ubuntu
Ancestor: item
Children: なし
imageName string イメージ名
Ancestor: item
Children: なし
monitoring InstanceMonitoringStateType 監視情報
Ancestor: item
Children: state
state string 基本監視ステータス
値: disabled (基本監視の設定なし) | enabled (基本監視設定あり)
Ancestor: monitoring
Children: なし
subnetId string ※返却値なし
Ancestor: item
Children: なし
vpcId string ※返却値なし
Ancestor: item
Children: なし
privateIpAddress string プライベートIPアドレス
Ancestor: item
Children: なし
ipAddress string グローバルIPアドレス
Ancestor: item
Children: なし
privateIpAddressV6 string プライベートIPアドレス（IPv6）
Ancestor: item
Children: なし
ipAddressV6 string グローバルIPアドレス（IPv6）
Ancestor: item
Children: なし
stateReason StateReasonType ※返却値なし
Ancestor: item
Children: code | message
code integer ※返却値なし
Ancestor: stateReason
Children: なし
message string ※返却値なし
Ancestor: stateReason
Children: なし
architecture string OSイメージのアーキテクチャ
値: i386 | x86_64
Ancestor: item
Children: なし
rootDeviceType string ディスクの種類
Ancestor: item
Children: なし
rootDeviceName string ※返却値なし
Ancestor: item
Children: なし
blockDeviceMapping InstanceBlockDeviceMappingResponseType 接続しているディスクの情報セット
Ancestor: item
Children: item
item InstanceBlockDeviceMappingResponseItemType 接続しているディスクの情報
Ancestor: blockDeviceMapping
Children: deviceName | ebs
deviceName string ※返却値なし
Ancestor: item
Children: なし
ebs EbsInstanceBlockDeviceMappingResponseType 接続しているディスクの詳細情報
Ancestor: item
Children: volumeId | status | attachTime | deleteOnTermination
volumeId string ディスク名
Ancestor: ebs
Children: なし
status string 接続ステータス
値: available(接続中) | in-use(使用中) | processing(処理中)
Ancestor: ebs
Children: なし
attachTime timestamp ディスク接続日時(yyyy-mm-ddThh:mi:ss.sssZ)
Ancestor: ebs
Children: なし
deleteOnTermination boolean サーバー削除時のディスク消去
値: true (消去する) | false (消去しない)
Ancestor: ebs
Children: なし
instanceLifecycle string ※返却値なし
Ancestor: item
Children: なし
spotInstanceRequestId string ※返却値なし
Ancestor: item
Children: なし
accountingType string 利用料金タイプ
値: 1 (月額課金) | 2 (従量課金)
Ancestor: item
Children: なし
nextMonthAccountingType string 次月の利用料金タイプ
値: 1 (月額課金) | 2 (従量課金)
Ancestor: item
Children: なし
loadbalancing InstanceLoadBalancerMappingResponseType 適用しているロードバランサー情報
Ancestor: item
Children: item
item InstanceLoadBalancerMappingResponseItemType ロードバランサー情報
Ancestor: loadbalancing
Children: loadBalancerName | loadBalancerPort | instancePort | State
loadBalancerName string ロードバランサー名
Ancestor: item
Children: なし
loadBalancerPort integer 待ち受けポート
Ancestor: item
Children: なし
instancePort integer 宛先ポート
Ancestor: item
Children: なし
State string ヘルスステータス
Ancestor: item
Children: なし
copyInfo string コピー元サーバー名
Ancestor: item
Children: なし
autoscaling InstanceAutoScaleMappingResponseType スケールアウトサーバー情報
Ancestor: item
Children: autoScalingGroupName | expireTime
autoScalingGroupName string オートスケール名
Ancestor: autoscaling
Children: なし
expireTime timestamp 有効時間(yyyy-mm-ddThh:mi:ssZ)
Ancestor: autoscaling
Children: なし
ipType string グローバルIPアドレスのタイプ
値: static (固定) | elastic(付替) | dynamic (動的) | none(グローバルIPなし)
Ancestor: item
Children: なし
niftyPrivateIpType string プライベートIPアドレスのタイプ
値: static (固定) | elastic (付替)
Ancestor: item
Children: なし
description string メモ情報
Ancestor: item
Children: なし
hotAdd string HotAdd可否情報
値: 0(HotAdd可能) | 1(サーバーを停止→起動すればHotAdd可能) | 2(HotAdd不可)
Ancestor: item
Children: なし
niftySnapshotting NiftySnapshottingType サーバーのスナップショット情報セット
Ancestor: item
Children: item
item NiftySnapshottingItemType サーバーのスナップショット情報
Ancestor: niftySnapshotting
Children: state
state string サーバーのスナップショットのステータス名
値: wait_create(スナップショット作成待ち) | processing_create(スナップショット作成中) | normal(スナップショット保持中) | wait_delete(スナップショット削除待ち) | processing_delete(スナップショット削除中) | processing_revert(スナップショットリストア中) | wait_instance_delete(サーバー削除待ち) | processing_instance_delete(サーバー削除中)
Ancestor: item
Children: なし
niftyPrivateNetworkType string プライベートネットワーク状況
値: STANDARD | VLAN | SECURE_NETWORK | PRIVATE_LAN
Ancestor: item
Children: なし
tenancy string テナント属性
値: default (通常) | dedicated (専有)
Ancestor: item
Children: なし
networkInterfaceSet NetworkInterfaceSetType ネットワークインターフェース情報セット
Ancestor: item
Children: item
item NetworkInterfaceSetItemType ネットワークインターフェース情報
Ancestor: networkInterfaceSet
Children: networkInterfaceId | subnetId | vpcId | description | ownerId | niftyNetworkId | niftyNetworkName | status | macAddress | privateIpAddress | privateIpAddressV6 | privateDnsName | sourceDestCheck | groupSet | attachment | association | privateIpAddressesSet
networkInterfaceId string ネットワークインターフェースID ※ネットワークインターフェースを使用している場合はネットワークインターフェースIDを返却する
Ancestor: item
Children: なし
subnetId string ※空を返却
Ancestor: item
Children: なし
vpcId string ※空を返却
Ancestor: item
Children: なし
description string ※空を返却
Ancestor: item
Children: なし
ownerId string ※空を返却
Ancestor: item
Children: なし
niftyNetworkId string ネットワークユニークID
Ancestor: item
Children: なし
niftyNetworkName string ネットワーク名
Ancestor: item
Children: なし
status string ネットワークインタフェースのステータス
値: available(利用可能) | in-use(使用中) | processing (処理中)
Ancestor: item
Children: なし
macAddress string ネットワークインタフェースのMACアドレス
Ancestor: item
Children: なし
privateIpAddress string プライベートIPアドレスまたはプライベート付替IPアドレス (グローバルで無いときのみ)
Ancestor: item
Children: なし
privateIpAddressV6 string プライベートIPアドレス（IPv6）
Ancestor: item
Children: なし
privateDnsName string ※空を返却
Ancestor: item
Children: なし
sourceDestCheck string ソース
Ancestor: item
Children: なし
groupSet GroupSetType 適用しているファイアウォール情報　※空を返却
Ancestor: item
Children: item
item GroupItemType ファイアウォール情報
Ancestor: groupSet
Children: groupId
groupId string ファイアウォールグループ名
Ancestor: item
Children: なし
attachment InstanceNetworkInterfaceAttachmentType ネットワークインターフェースの接続情報
Ancestor: item
Children: attachmentID | deviceIndex | status | attachTime | deleteOnTermination
attachmentID string アタッチメントID ※ネットワークインターフェースを使用している場合はネットワークインターフェースのアタッチメントIDを返却する
Ancestor: attachment
Children: なし
deviceIndex integer デバイス番号
Ancestor: attachment
Children: なし
status string 接続状態
Ancestor: attachment
Children: なし
attachTime timestamp サーバーへの接続時刻 ※ネットワークインターフェースを使用している場合はネットワークインターフェースのサーバーへの接続時刻を返却する
Ancestor: attachment
Children: なし
deleteOnTermination boolean サーバー削除時のネットワークインターフェース消去
値: true(消去)
Ancestor: attachment
Children: なし
association InstanceNetworkInterfaceAssociationType ネットワークインタフェースに関連付けられているパブリックIP（固定グローバルIPアドレス、付替IPアドレス）の情報
Ancestor: item
Children: publicIp | publicIpV6 | publicDnsName | ipOwnerId
publicIp string グローバルIPアドレスまたはグローバル付替IPアドレス
Ancestor: association
Children: なし
publicIpV6 string グローバルIPアドレス(IPv6)
Ancestor: association
Children: なし
publicDnsName string ※空を返却
Ancestor: association
Children: なし
ipOwnerId string ※空を返却
Ancestor: association
Children: なし
privateIpAddressesSet InstancePrivateIpAddressesSetType ※空を返却
Ancestor: item
Children: item
item InstancePrivateIpAddressesSetItemType インスタンスに付属するプライベートIP
Ancestor: privateIpAddressesSet
Children: association | primary | privateDnsName | privateIpAddress
association InstanceNetworkInterfaceAssociation 付替IPアドレスの関連付け情報
Ancestor: item
Children: ipOwnerId | publicDnsName | publicIp
ipOwnerId string 付替IPアドレスのオーナーID
Ancestor: association
Children: なし
publicDnsName string パブリックDNS名
Ancestor: association
Children: なし
publicIp string ネットワークインターフェースのパブリックIP
Ancestor: association
Children: なし
primary boolean ネットワークインターフェースのプライマリープライベートIPであるかどうか
Ancestor: item
Children: なし
privateDnsName string プライベートDNS名
Ancestor: item
Children: なし
privateIpAddress string ネットワークインターフェースのプライベートIP
Ancestor: item
Children: なし
niftyElasticLoadBalancing InstanceElasticLoadBalancerMappingResponseType 適用しているマルチロードバランサーの情報
Ancestor: item
Children: item
item InstanceElasticLoadBalancerMappingResponseItemType 適用しているマルチロードバランサーの情報
Ancestor: niftyElasticLoadBalancing
Children: elasticLoadBalancerId | elasticLoadBalancerName | protocol | elasticLoadBalancerPort | instancePort
elasticLoadBalancerId string 適用しているマルチロードバランサーユニークID
Ancestor: item
Children: なし
elasticLoadBalancerName string 適用しているマルチロードバランサー名
Ancestor: item
Children: なし
protocol string 適用しているマルチロードバランサーのプロトコル
Ancestor: item
Children: なし
elasticLoadBalancerPort integer 適用しているマルチロードバランサーの待ち受けポート
Ancestor: item
Children: なし
instancePort integer 適用しているマルチロードバランサーの宛先ポート
Ancestor: item
Children: なし
instanceBackupRule InstanceBackupRuleMappingResponseType 適用しているバックアップルールの情報
Ancestor: item
Children: instanceBackupRuleId | instanceBackupRuleName
instanceBackupRuleId string 適用しているバックアップルールID
Ancestor: instanceBackupRule
Children: なし
instanceBackupRuleName string 適用しているバックアップルール名
Ancestor: instanceBackupRule
Children: なし
isoImageSet InstanceIsoImageMappingResponseType 適用しているISOイメージの情報
Ancestor: item
Children: item
item InstanceIsoImageMappingResponseItemType 適用しているISOイメージの情報
Ancestor: isoImageSet
Children: isoImageId | isoImageName
isoImageId string 適用しているISOイメージユニークID
Ancestor: item
Children: なし
isoImageName string 適用しているISOイメージ名
Ancestor: item
Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/?
  Action=DescribeInstances
  &InstanceId.1=server01
  &CommonParams

応答サンプル

    <DescribeInstancesResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <reservationSet>
    <item>
      <reservationId/>
      <ownerId/>
      <groupSet/>
      <instancesSet>
        <item>
          <instanceId>server01</instanceId>
          <instanceUniqueId>i-efba9876</instanceUniqueId>
          <imageId>1</imageId>
          <instanceState>
            <code>16</code>
            <name>running</name>
          </instanceState>
          <privateDnsName>10.0.5.111</privateDnsName>
          <dnsName>111.171.202.1</dnsName>
          <keyName>sshkey01</keyName>
          <amiLaunchIndex/>
          <productCodes>
            <item>
              <productCode/>
            </item>
          </productCodes>
          <instanceType>small4</instanceType>
          <launchTime>2010-05-17T11:22:33.456+09:00</launchTime>
          <placement>
            <availabilityZone>east-11</availabilityZone>
          </placement>
          <kernelId/>
          <ramdiskId/>
          <platform>centos</platform>
          <imageName>CentOS6.3 64bit server</imageName>
          <monitoring>
            <state>disabled</state>
          </monitoring>
          <subnetId/>
          <vpcId/>
          <privateIpAddress>10.0.5.111</privateIpAddress>
          <IpAddress>111.171.202.1</IpAddress>
          <privateIpAddressV6/>
          <IpAddressV6/>
          <stateReason>
            <code/>
            <message/>
          </stateReason>
          <architecture>i386</architecture>
          <rootDeviceType>disk</rootDeviceType>
          <rootDeviceName/>
          <blockDeviceMapping>
            <item>
              <deviceName/>
              <ebs>
                <volumeId>disk01</volumeId>
                <status>attached</status>
                <attachTime>2010-05-17T11:22:33.000+09:00</attachTime>
                <deleteOnTermination>false</deleteOnTermination>
              </ebs>
            </item>
          </blockDeviceMapping>
          <instanceLifecycle/>
          <spotInstanceRequestId/>
          <accountingType>2</accountingType>
          <nextMonthAccountingType>1</nextMonthAccountingType>
          <loadbalancing/>
          <ipType>static</ipType>
          <niftyPrivateIpType>elastic</niftyPrivateIpType>
          <description/>
          <hotAdd>0</hotAdd>
          <niftySnapshotting>
            <item>
              <state>normal</state>
            </item>
          </niftySnapshotting>
          <niftyPrivateNetworkType>STANDARD</niftyPrivateNetworkType>
          <tenancy>default</tenancy>
          <networkInterfaceSet>
            <item>
              <networkInterfaceId/>
              <subnetId/>
              <vpcId/>
              <description/>
              <ownerId/>
              <niftyNetworkId>net-COMMON_GLOBAL</niftyNetworkId>
              <status>available</status>
              <macAddress>07:00:30:1B:92:44</macAddress>
              <privateDnsName/>
              <sourceDestCheck/>
              <groupSet/>
              <attachment>
                <deviceIndex>0</deviceIndex>
                <status>attached</status>
                <deleteOnTermination>true</deleteOnTermination>
              </attachment>
              <association>
                <publicIp>111.171.202.1</publicIp>
                <publicIpV6/>
                <publicDnsName/>
                <ipOwnerId/>
              </association>
              <privateIpAddressesSet/>
            </item>
            <item>
              <networkInterfaceId/>
              <subnetId/>
              <vpcId/>
              <description/>
              <ownerId/>
              <niftyNetworkId>net-COMMON_PRIVATE</niftyNetworkId>
              <niftyNetworkName/>
              <status>in-use</status>
              <macAddress>07:00:30:1B:92:45</macAddress>
              <privateIpAddress>10.0.5.111</privateIpAddress>
              <privateIpAddressV6>2001:0db8:bd05:01d2:288a:1fc0:0001:10ee</privateIpAddressV6>
              <privateDnsName/>
              <sourceDestCheck/>
              <groupSet/>
              <attachment>
                <deviceIndex>0</deviceIndex>
                <status>attaching</status>
                <deleteOnTermination>true</deleteOnTermination>
              </attachment>
            </item>
            <item>
              <networkInterfaceId>ni-3db04f80</networkInterfaceId>
              <subnetId/>
              <vpcId/>
              <description/>
              <ownerId/>
              <niftyNetworkId>net-0v3nmuh8</niftyNetworkId>
              <niftyNetworkName>prilan01</niftyNetworkName>
              <status>in-use</status>
              <macAddress>07:00:30:1B:92:46</macAddress>
              <privateIpAddress>10.0.5.127</privateIpAddress>
              <privateIpAddressV6/>
              <privateDnsName/>
              <sourceDestCheck/>
              <groupSet/>
              <attachment>
                <attachmentId>iniatc-0k87jhqh</attachmentId>
                <deviceIndex>0</deviceIndex>
                <status>attaching</status>
                <attachTime>2017-10-27T22:08:49.000+09:00</attachTime>
                <deleteOnTermination>true</deleteOnTermination>
              </attachment>
            </item>
          </networkInterfaceSet>
          <niftyElasticLoadBalancing/>
          <instanceBackupRule>
            <instanceBackupRuleId>ibr-00000000</instanceBackupRuleId>
            <instanceBackupRuleName>backupRule</instanceBackupRuleName>
          </instanceBackupRule>
          <isoImageSet>
            <item>
              <isoImageId>iso-00000000</isoImageId>
              <isoImageName>isoImage</isoImageName>
            </item>
          </isoImageSet>
        </item>
      </instancesSet>
    </item>
  </reservationSet>
</DescribeInstancesResponse>

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

APIメニュー

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

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

ページの先頭へ