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

DescribeInstanceAttribute

処理概要

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

サーバーを指定するためには、サーバー名が必要です。

指定するパラメーター

パラメーター	型	説明	必須
InstanceId	string	サーバー名	○
Attribute	string	取得する情報の項目名 値: instanceType (サーバータイプを取得) disableApiTermination (APIからのサーバー削除可否を取得) blockDeviceMapping (接続しているディスクの情報を取得) accountingType (利用料金タイプを取得) nextMonthAccountingType (次月の利用料金タイプを取得) loadbalancing (適用しているロードバランサー情報を取得) copyInfo (コピー元サーバーの情報を取得) autoscaling (オートスケール情報を取得) ipType (グローバルIPアドレスの情報を取得) niftyPrivateIpType (プライベートIPアドレス情報を取得) groupId (ファイアウォール情報を取得) description (メモ情報を取得) networkInterfaceSet (ネットワークインターフェース情報を取得) elasticloadbalancing (適用しているマルチロードバランサー情報を取得)

応答フィールド

フィールド (項目)	型	説明
DescribeInstanceAttributeResponse	-	DescribeInstanceAttributeレスポンス
␣requestId	string	リクエスト識別子
␣instanceId	string	サーバー名
␣instanceUniqueId	string	サーバーユニークID
␣instanceType	-	サーバータイプの情報
␣␣value	string	サーバータイプ 値: e2-mini e-mini h2-mini mini c2-small c2r-small c-small e2-small e2r-small e-small h2-small h2r-small small c2-small2 c2r-small2 c-small2 e2-small2 e2r-small2 e-small2 h2-small2 h2r-small2 small2 c2-small4 c-small4 e2-small4 e-small4 h2-small4 h2r-small4 small4 e2-small8 e-small8 h2-small8 small8 e2-small16 e-small16 h2-small16 small16 c2-medium c2r-medium c-medium e2-medium e2r-medium e-medium h2-medium h2r-medium medium c2-medium4 c2r-medium4 c-medium4 e2-medium4 e2r-medium4 e-medium4 h2-medium4 h2r-medium4 medium4 c2-medium8 c-medium8 e2-medium8 e-medium8 h2-medium8 h2r-medium8 medium8 e2-medium16 e-medium16 h2-medium16 medium16 e2-medium24 e-medium24 h2-medium24 medium24 c2-large c2r-large c-large e2-large e2r-large e-large h2-large h2r-large large c2-large8 c-large8 e2-large8 e2r-large8 e-large8 h2-large8 h2r-large8 large8 e2-large16 e-large16 h2-large16 h2r-large16 large16 e2-large24 e-large24 h2-large24 large24 e2-large32 e-large32 h2-large32 large32 e2-extra-large8 e2r-extra-large8 e-extra-large8 h2-extra-large8 h2r-extra-large8 extra-large8 e2-extra-large16 e-extra-large16 h2-extra-large16 h2r-extra-large16 extra-large16 e2-extra-large24 e-extra-large24 h2-extra-large24 h2r-extra-large24 extra-large24 e2-extra-large32 e-extra-large32 h2-extra-large32 extra-large32 e2-extra-large48 e-extra-large48 h2-extra-large48 extra-large48 e2-double-large16 e2r-double-large16 e-double-large16 h2-double-large16 h2r-double-large16 double-large16 e2-double-large24 e-double-large24 h2-double-large24 h2r-double-large24 double-large24 e2-double-large32 e-double-large32 h2-double-large32 h2r-double-large32 double-large32 e2-double-large48 e-double-large48 h2-double-large48 double-large48 e2-double-large64 e-double-large64 h2-double-large64 double-large64 e2-double-large96 e-double-large96 h2-double-large96 double-large96 h2-triple-large32 h2r-triple-large32 triple-large32 h2-triple-large48 h2r-triple-large48 triple-large48 h2-triple-large64 triple-large64 h2-triple-large96 triple-large96 h2-triple-large128 triple-large128 h2-quad-large64 h2r-quad-large64 quad-large64 h2-quad-large96 quad-large96 h2-quad-large128 quad-large128 h2-quad-large256 quad-large256 h2-septa-large128 septa-large128 h2-septa-large256 septa-large256 h2-octa-large256 octa-large256 h2-octa-large384 octa-large384 h2-octa-large512 octa-large512
␣disableApiTermination	-	APIからのサーバー削除可否の情報
␣␣value	boolean	APIからのサーバー削除可否 値: true (削除不可) false (削除可)
␣blockDeviceMapping	-	接続しているディスクの情報セット
␣␣item	-	接続しているディスクの情報
␣␣␣deviceName	string	ディスクの接続デバイス 値: SCSI (xx:xx)
␣␣␣ebs	-	ディスクの詳細情報
␣␣␣␣volumeId	string	ディスク名
␣␣␣␣volumeUniqueId	string	ディスクユニークID
␣␣␣␣status	string	ディスクの接続ステータス 値: attached (接続済み)
␣␣␣␣attachTime	string	ディスク接続日時 値: yyyy-mm-ddThh:mi:ssZ
␣␣␣␣deleteOnTermination	string	サーバー削除時のディスク消去 値: true (消去) false (消去しない)
␣accountingType	-	利用料金タイプの情報
␣␣value	string	利用料金タイプ 値: 1 (月額課金) 2 (従量課金)
␣nextMonthAccountingType	-	次月の利用料金タイプの情報
␣␣value	string	次月の利用料金タイプ 値: 1 (月額課金) 2 (従量課金)
␣loadbalancing	-	適用しているロードバランサー情報
␣␣item	-	ロードバランサー情報
␣␣␣loadBalancerName	string	ロードバランサー名
␣␣␣loadBalancerPort	integer	待ち受けポート
␣␣␣instancePort	integer	宛先ポート
␣␣␣State	string	ヘルスステータス 値: InService (正常) OutService (応答なし)
␣copyInfo	-	コピー元サーバーの情報
␣␣value	string	コピー元サーバー名
␣autoscaling	-	スケールアウトサーバー情報
␣␣autoScalingGroupName	string	オートスケール名
␣␣expireTime	timestamp	有効時間 値: yyyy-mm-ddThh:mi:ssZ
␣ipType	-	グローバルIPアドレスの情報
␣␣value	string	グローバルIPアドレスのタイプ 値: static (固定) elastic (付替) dynamic (動的) multiIpAddress (マルチIPアドレス) none (グローバルIPなし)
␣niftyPrivateIpType	-	プライベートIPアドレスの情報
␣␣value	string	プライベートIPアドレスのタイプ 値: static (固定) elastic (付替)
␣groupId	-	ファイアウォールの設定情報
␣␣value	string	ファイアウォールのグループ名
␣description	-	サーバーのメモ情報
␣␣value	string	メモ情報
␣networkInterfaceSet	-	ネットワークインターフェース情報セット
␣␣item	-	ネットワークインターフェース
␣␣␣networkInterfaceId	string	ネットワークインターフェースID
␣␣␣subnetId	string	※空を返却
␣␣␣vpcId	string	※空を返却
␣␣␣description	string	※空を返却
␣␣␣ownerId	string	※空を返却
␣␣␣niftyNetworkId	string	ネットワークユニークID
␣␣␣niftyNetworkName	string	ネットワーク名
␣␣␣status	string	ネットワークインターフェースのステータス 値: available (利用可能) in-use (使用中) processing (処理中)
␣␣␣macAddress	string	ネットワークインターフェースのMACアドレス
␣␣␣privateIpAddress	string	プライベートIPアドレス or プライベート付替IPアドレス（グローバルで無いときのみ）
␣␣␣privateIpAddressV6	string	※空を返却 プライベートIPアドレス（IPv6）
␣␣␣privateDnsName	string	※空を返却
␣␣␣sourceDestCheck	string	※空を返却
␣␣␣groupSet	string	※空を返却 ファイアウォール情報セット
␣␣␣attachment	-	ネットワークインターフェースの接続情報
␣␣␣␣attachmentId	string	アタッチメントID ※ネットワークインターフェースを使用している場合はネットワークインターフェースのアタッチメントIDを返却する
␣␣␣␣deviceIndex	string	デバイス番号
␣␣␣␣status	string	接続状態 値: attaching (接続中) attached (接続済み) detaching (接続解除中) detached (未接続)
␣␣␣␣attachTime	string	サーバーへの接続時刻 ※ネットワークインターフェースを使用している場合はネットワークインターフェースのサーバーへの接続時刻を返却する
␣␣␣␣deleteOnTermination	string	※インスタンス削除時のネットワークインターフェース削除 値: true (削除)
␣␣␣association	-	ネットワークインターフェースに関連付けられているパブリックIP（固定グローバルIPアドレス、付替IPアドレス）の情報
␣␣␣␣publicIp	string	グローバルIPアドレス or グローバル付替IPアドレス
␣␣␣␣publicIpV6	string	※空を返却 グローバルIPアドレス（IPv6）
␣␣␣␣publicDnsName	string	※空を返却
␣␣␣␣ipOwnerId	string	※空を返却
␣␣␣privateIpAddressesSet	string	※空を返却
␣␣␣multiIpAddressesSet	-	マルチIPアドレス情報セット
␣␣␣␣item	-	マルチIPアドレス情報
␣␣␣␣␣ipAddress	string	IPアドレス
␣niftyElasticLoadBalancing	-	適用しているマルチロードバランサーの情報
␣␣item	-	適用しているマルチロードバランサーの情報
␣␣␣elasticLoadBalancerId	string	適用しているマルチロードバランサーユニークID
␣␣␣elasticLoadBalancerName	string	適用しているマルチロードバランサー名
␣␣␣protocol	string	適用しているマルチロードバランサーのプロトコル
␣␣␣elasticLoadBalancerPort	integer	適用しているマルチロードバランサーの待ち受けポート
␣␣␣instancePort	integer	適用しているマルチロードバランサーの宛先ポート

リクエストサンプル

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

  

応答サンプル

    <DescribeInstanceAttributeResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <instanceId>server01</instanceId>
  <instanceUniqueId>i-efba9876</instanceUniqueId>
  <blockDeviceMapping>
    <item>
      <deviceName>SCSI (0:0)</deviceName>
      <ebs>
        <volumeId>disk01</volumeId>
        <volumeUniqueId>vol-abfd1234</volumeUniqueId>
        <status>attached</status>
        <attachTime>2010-05-17T11:22:33.456+09:00</attachTime>
        <deleteOnTermination>false</deleteOnTermination>
      </ebs>
    </item>
  </blockDeviceMapping>
</DescribeInstanceAttributeResponse>