本文へジャンプします。

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

DescribeInstances

処理概要

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

指定するパラメーター

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

応答フィールド

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

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=DescribeInstances&InstanceId.1=server01&CommonParams

応答サンプル

<DescribeInstancesResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>7da9662b-578a-41fd-b455-c12bac4bc09d</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.456Z</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>SCSI(0:1)</deviceName>
              <ebs>
               <volumeId>disk01</volumeId>
               <status>attached</status>
               <attachTime>2010-05-17T11:22:33.456Z</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>
          <niftyNetworkName/>
          <status>in-use</status>
          <macAddress>00-00-00-00-00-00</macAddress>
          <privateDnsName/>
          <sourceDestCheck/>
          <groupSet/>
          <attachment>
            <attachmentID/>
            <deviceIndex>0</deviceIndex>
            <status>attached</status>
            <attachTime/>
            <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>00-00-00-00-00-00</macAddress>
          <privateIpAddress>10.0.5.111</privateIpAddress>
          <privateIpAddressV6>2001:0db8:bd05:01d2:288a:1fc0:0001:10ee</privateIpAddressV6>
          <privateDnsName/>
          <sourceDestCheck/>
          <groupSet/>
          <attachment>
            <attachmentID/>
            <deviceIndex>0</deviceIndex>
            <status>attaching</status>
            <attachTime/>
            <deleteOnTermination>true</deleteOnTermination>
           <attachment/>
           <association/>
          </item>
         </networkInterfaceSet>
         </niftyElasticLoadBalancing>
        </item>
      </instancesSet>
    </item>
  </reservationSet>
</DescribeInstancesResponse>

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

APIメニュー

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

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