本文へジャンプします。

ニフクラ ユーザーガイド

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レスポンス
Ancestor: なし
Children: requestId | instanceId | instanceUniqueId | instanceType | disableApiTermination | blockDeviceMapping | accountingType | nextMonthAccountingType | loadbalancing | copyInfo | autoscaling | ipType | niftyPrivateIpType | groupId | description | networkInterfaceSet | niftyElasticLoadBalancing
requestId string リクエスト識別子
Ancestor: DescribeInstanceAttributeResponse
Children: なし
instanceId string サーバー名
Ancestor: DescribeInstanceAttributeResponse
Children: なし
instanceUniqueId string サーバーユニークID
Ancestor: DescribeInstanceAttributeResponse
Children: なし
instanceType - サーバータイプの情報
Ancestor: DescribeInstanceAttributeResponse
Children: value
value 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: instanceType
Children: なし
disableApiTermination - APIからのサーバー削除可否の情報
Ancestor: DescribeInstanceAttributeResponse
Children: value
value boolean APIからのサーバー削除可否
値: true(削除不可) | false(削除可)
Ancestor: disableApiTermination
Children: なし
blockDeviceMapping - 接続しているディスクの情報セット
Ancestor: DescribeInstanceAttributeResponse
Children: item
item - 接続しているディスクの情報
Ancestor: blockDeviceMapping
Children: deviceName | ebs
deviceName string ディスクの接続デバイス
値: SCSI(xx:xx)
Ancestor: item
Children: なし
ebs - ディスクの詳細情報
Ancestor: item
Children: volumeId | status | attachTime | deleteOnTermination
volumeId string ディスク名
Ancestor: ebs
Children: なし
status string ディスクの接続ステータス
値: attached(接続済み)
Ancestor: ebs
Children: なし
attachTime timestamp ディスク接続日時
値: yyyy-mm-ddThh:mi:ssZ
Ancestor: ebs
Children: なし
deleteOnTermination boolean サーバー削除時のディスク消去
値: true(消去) | false(消去しない)
Ancestor: ebs
Children: なし
accountingType - 利用料金タイプの情報
Ancestor: DescribeInstanceAttributeResponse
Children: value
value string 利用料金タイプ
値: 1(月額課金) | 2(従量課金)
Ancestor: accountingType
Children: なし
nextMonthAccountingType - 次月の利用料金タイプの情報
Ancestor: DescribeInstanceAttributeResponse
Children: value
value string 次月の利用料金タイプ
値: 1(月額課金) | 2(従量課金)
Ancestor: nextMonthAccountingType
Children: なし
loadbalancing - 適用しているロードバランサー情報
Ancestor: DescribeInstanceAttributeResponse
Children: item
item - ロードバランサー情報
Ancestor: loadbalancing
Children: loadBalancerName | loadBalancerPort | instancePort | State
loadBalancerName string ロードバランサー名
Ancestor: item
Children: なし
loadBalancerPort integer 待ち受けポート
Ancestor: item
Children: なし
instancePort integer 宛先ポート
Ancestor: item
Children: なし
State string ヘルスステータス
値: InService(正常) | OutService(応答なし)
Ancestor: item
Children: なし
copyInfo - コピー元サーバーの情報
Ancestor: DescribeInstanceAttributeResponse
Children: value
value string コピー元サーバー名
Ancestor: copyInfo
Children: なし
autoscaling - スケールアウトサーバー情報
Ancestor: DescribeInstanceAttributeResponse
Children: autoScalingGroupName | expireTime
autoScalingGroupName string オートスケール名
Ancestor: autoscaling
Children: なし
expireTime timestamp 有効時間
値: yyyy-mm-ddThh:mi:ssZ
Ancestor: autoscaling
Children: なし
ipType - グローバルIPアドレスの情報
Ancestor: DescribeInstanceAttributeResponse
Children: value
value string グローバルIPアドレスのタイプ
値: static(固定) | elastic(付替) | dynamic(動的) | multiIpAddress(マルチIPアドレス) | none(グローバルIPなし)
Ancestor: ipType
Children: なし
niftyPrivateIpType - プライベートIPアドレスの情報
Ancestor: DescribeInstanceAttributeResponse
Children: value
value string プライベートIPアドレスのタイプ
値: static(固定) | elastic(付替)
Ancestor: niftyPrivateIpType
Children: なし
groupId - ファイアウォールの設定情報
Ancestor: DescribeInstanceAttributeResponse
Children: value
value string ファイアウォールのグループ名
Ancestor: groupId
Children: なし
description - サーバーのメモ情報
Ancestor: DescribeInstanceAttributeResponse
Children: value
value string メモ情報
Ancestor: description
Children: なし
networkInterfaceSet - ネットワークインターフェース情報セット
Ancestor: DescribeInstanceAttributeResponse
Children: item
item - ネットワークインターフェース
Ancestor: networkInterfaceSet
Children: networkInterfaceId | subnetId | vpcId | description | ownerId | niftyNetworkId | niftyNetworkName | status | macAddress | privateIpAddress | privateIpAddressV6 | privateDnsName | sourceDestCheck | groupSet | attachment | association | privateIpAddressesSet | multiIpAddressesSet
networkInterfaceId string ネットワークインターフェース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アドレス or プライベート付替IPアドレス(グローバルで無いときのみ)
Ancestor: item
Children: なし
privateIpAddressV6 string ※空を返却
プライベートIPアドレス(IPv6)
Ancestor: item
Children: なし
privateDnsName string ※空を返却
Ancestor: item
Children: なし
sourceDestCheck string ※空を返却
Ancestor: item
Children: なし
groupSet string ※空を返却
ファイアウォール情報セット
Ancestor: item
Children: なし
attachment - ネットワークインターフェースの接続情報
Ancestor: item
Children: attachmentId | deviceIndex | status | attachTime | deleteOnTermination
attachmentId string アタッチメントID
※ネットワークインターフェースを使用している場合はネットワークインターフェースのアタッチメントIDを返却する
Ancestor: attachment
Children: なし
deviceIndex integer デバイス番号
Ancestor: attachment
Children: なし
status string 接続状態
値: attaching(接続中) | attached(接続済み) | detaching(接続解除中) | detached(未接続)
Ancestor: attachment
Children: なし
attachTime timestamp サーバーへの接続時刻
※ネットワークインターフェースを使用している場合はネットワークインターフェースのサーバーへの接続時刻を返却する
Ancestor: attachment
Children: なし
deleteOnTermination boolean ※インスタンス削除時のネットワークインターフェース削除
値: true(削除)
Ancestor: attachment
Children: なし
association - ネットワークインターフェースに関連付けられているパブリックIP(固定グローバルIPアドレス、付替IPアドレス)の情報
Ancestor: item
Children: publicIp | publicIpV6 | publicDnsName | ipOwnerId
publicIp string グローバルIPアドレス or グローバル付替IPアドレス
Ancestor: association
Children: なし
publicIpV6 string ※空を返却
グローバルIPアドレス(IPv6)
Ancestor: association
Children: なし
publicDnsName string ※空を返却
Ancestor: association
Children: なし
ipOwnerId string ※空を返却
Ancestor: association
Children: なし
privateIpAddressesSet string ※空を返却
Ancestor: item
Children: なし
multiIpAddressesSet - マルチIPアドレス情報セット
Ancestor: item
Children: item
item - マルチIPアドレス情報
Ancestor: multiIpAddressesSet
Children: ipAddress
ipAddress string IPアドレス
Ancestor: item
Children: なし
niftyElasticLoadBalancing - 適用しているマルチロードバランサーの情報
Ancestor: DescribeInstanceAttributeResponse
Children: item
item - 適用しているマルチロードバランサーの情報
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: なし

リクエストサンプル

    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>
        <status>attached</status>
        <attachTime>2010-05-17T11:22:33.456+09:00</attachTime>
        <deleteOnTermination>false</deleteOnTermination>
      </ebs>
    </item>
  </blockDeviceMapping>
</DescribeInstanceAttributeResponse>

  

ニフクラ サイト内検索

APIメニュー

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

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