本文へジャンプします。

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

DescribeInstanceAttribute

処理概要

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

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

指定するパラメーター

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

応答フィールド

フィールド(項目) 説明 サンプル値
DescribeInstanceAttributeResponse DescribeInstanceAttributeレスポンス
Type : DescribeInstanceAttributeResponseType
Ancestor : なし
Children : requestId, instanceId, instanceUniqueId, instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, accountingType, NextMonthAccountingType, loadbalancing, copyInfo, autoscaling, ipType, niftyPrivateIpType, groupId, description, networkInterfaceSet, niftyElasticLoadBalancing
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : DescribeInstanceAttributeResponse
Children : なし
3ed4d3d6-656e-45b5-bd60-e38b5b94f62c
instanceId サーバー名
Type : xsd:string
Ancestor : DescribeInstanceAttributeResponse
Children : なし
server01
instanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : DescribeInstanceAttributeResponse
Children : なし
i-efba9876
instanceType サーバータイプの情報
Type : NullableAttributeValueType
Ancestor : DescribeInstanceAttributeResponse
Children : value
 
value サーバータイプ
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
Type : xsd:string
Ancestor : instanceType
Children : なし
 
kernel ※返却値なし
Type : NullableAttributeValueType
Ancestor : DescribeInstanceAttributeResponse
Children : value
 
value ※返却値なし
Type : xsd:string
Ancestor : kernel
Children : なし
 
ramdisk ※返却値なし
Type : NullableAttributeValueType
Ancestor : DescribeInstanceAttributeResponse
Children : value
 
value ※返却値なし
Type : xsd:string
Ancestor : ramdisk
Children : なし
 
userData ※返却値なし
Type : NullableAttributeValueType
Ancestor : DescribeInstanceAttributeResponse
Children : value
 
value ※返却値なし
Type : xsd:string
Ancestor : userData
Children : なし
 
disableApiTermination APIからのサーバー削除可否の情報
Type : NullableAttributeValueType
Ancestor : DescribeInstanceAttributeResponse
Children : value
 
value APIからのサーバー削除可否
Type : xsd:boolean
値 : true (削除不可) | false (削除可)
Ancestor : disableApiTermination
Children : なし
 
instanceInitiatedShutdownBehavior ※返却値なし
Type : NullableAttributeValueType
Ancestor : DescribeInstanceAttributeResponse
Children : value
 
value ※返却値なし
Type : xsd:string
Ancestor : instanceInitiatedShutdownBehavior
Children : なし
 
rootDeviceName ※返却値なし
Type : NullableAttributeValueType
Ancestor : DescribeInstanceAttributeResponse
Children : value
 
value ※返却値なし
Type : xsd:string
Ancestor : rootDeviceName
Children : なし
 
blockDeviceMapping 接続しているディスクの情報セット
Type : InstanceBlockDeviceMappingResponseType
Ancestor : DescribeInstanceAttributeResponse
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
値 : attached (接続済み)
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
accountingType 利用料金タイプの情報
Type : NullableAttributeValueType
Ancestor : DescribeInstanceAttributeResponse
Children : value
 
value 利用料金タイプ
Type : xsd:string
値 : 1 (月額課金) | 2 (従量課金)
Ancestor : accountingType
Children : なし
 
NextMonthAccountingType 次月の利用料金タイプの情報
Type : NullableAttributeValueType
Ancestor : DescribeInstanceAttributeResponse
Children : value
 
value 次月の利用料金タイプ
Type : xsd:string
値 : 1 (月額課金) | 2 (従量課金)
Ancestor : NextMonthAccountingType
Children : なし
 
loadbalancing 適用しているロードバランサー情報
Type : InstanceLoadBalancerMappingResponseType
Ancestor : DescribeInstanceAttributeResponse
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 : NullableAttributeValueType
Ancestor : DescribeInstanceAttributeResponse
Children : value
 
value コピー元サーバー名
Type : xsd:string
Ancestor : copyInfo
Children : なし
 
autoscaling スケールアウトサーバー情報
Type : InstanceAutoScaleMappingResponseType
Ancestor : DescribeInstanceAttributeResponse
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 : NullableAttributeValueType
Ancestor : DescribeInstanceAttributeResponse
Children : value
 
value グローバルIPアドレスのタイプ Type : xsd:string
値 : static(固定)| elastic(付替)| dynamic(動的)| none(グローバルIPなし)
Ancestor : ipType
Children : なし
 
niftyPrivateIpType プライベートIPアドレスの情報
Type : NullableAttributeValueType
Ancestor : DescribeInstanceAttributeResponse
Children : value
 
value プライベートIPアドレスのタイプ
Type : xsd:string
値 : static (固定) | elastic (付替)
Ancestor : niftyPrivateIpType
Children : なし
 
groupId ファイアウォールの設定情報
Type : NullableAttributeValueType
Ancestor : DescribeInstanceAttributeResponse
Children : value
 
value ファイアウォールのグループ名
Type : xsd:string
Ancestor : groupId
Children : なし
 
description サーバーのメモ情報
Type : NullableAttributeValueType
Ancestor : DescribeInstanceAttributeResponse
Children : value
 
value メモ情報
Type : xsd:string
Ancestor :description
Children : なし
 
networkInterfaceSet NetworkInterface情報セット
Type : NetworkInterfaceSetType
Ancestor : DescribeInstanceAttributeResponse
Children : item
 
item NetworkInterface情報
Type : InstanceNetworkInterfaceSetItemType
Ancestor : networkInterfaceSet
Children : networkInterfaceId,subnetId,vpcId,description,ownerId, niftyNetworkId,niftyNetworkName,status,macAddress,privateIpAddress,privateIpAddressV6, privateDnsName,sourceDestCheck,groupSet.,attachment,association,privateIpAddressesSet
 
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
Valid values : available | in-use | processing
Ancestor : item
Children : なし
 
macAddress ネットワークインタフェースのMACアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
privateIpAddress プライベートIPアドレス or プライベートEIP(グローバルで無いときのみ)
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 ファイアウォール情報セット ※空を返却(NSX対応の時に使用予定)
Type : GroupSetType
Ancestor : item
Children : item
 
item ファイアウォール情報
Type : GroupItemType
Ancestor : groupSet
Children : groupId
 
groupId NICに対するファイアウォールグループ名
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:short
Ancestor : attachment
Children : なし
 
attachmentID ※空を返却
Type : xsd:string
Ancestor : attachment
Children : なし
 
status 接続状態
Type : xsd:string
Valid values : attaching | attached | detaching | detached
Ancestor : attachment
Children : なし
 
attachTime ※空を返却
Type : xsd: calendar
Ancestor : attachment
Children : なし
 
deleteOnTermination ※インスタンス削除時に、ネットワークインターフェイスが削除されるかどうか(※必ずtrueを返す)
Type : xsd: boolean
Ancestor : attachment
Children : なし
 
association ネットワークインタフェースに関連付けられているパブリックIP(固定Glo、EIP)の情報
Type : InstanceNetworkInterfaceAssociationType
Ancestor : item
Children : publicIp,publicIpV6,publicDnsName,ipOwnerId
 
publicIp グローバルIPアドレス or グローバルEIP
Type : xsd:string
Ancestor : association
Children : なし
 
publicIpV6 グローバルIPアドレス(IPv6)
Type : xsd:string
Ancestor : association
Children : なし
 
publicDnsName ※空を返却
Type : xsd:string
Valid values : attaching | attached | detaching | detached
Ancestor : association
Children : なし
 
ipOwnerId ※空を返却
Type : xsd:string
Ancestor : association
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:string
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.clound.nifty.com/api/?Action=DescribeInstanceAttribute&InstanceId=server01&Attribute=blockDeviceMapping&CommonParams

応答サンプル

<DescribeInstanceAttributeResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>3ed4d3d6-656e-45b5-bd60-e38b5b94f62c</requestId>
  <instanceId>server01</instanceId>
  <instanceUniqueId>i-efba9876</instanceUniqueId>
  <instanceType>
     <value>mini</value>
  </instanceType>
  <networkInterfaceSet>
    <item>
      <networkInterfaceId/>
      <subnetId/>
      <vpcId/>
      <description/>
      <ownerId/>
      <niftyNetworkId>net-COMMON_GLOBAL</niftyNetworkId>
      <status>available</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>172.16.13.10</publicIp>
        <publicIpV6/>
        <publicDnsName/>
        <ipOwnerId/>
      </association>
      <privateIpAddressesSet/>
    </item>
    <item>
      <networkInterfaceId/>
      <subnetId/>
      <vpcId/>
      <description/>
      <ownerId/>
      <niftyNetworkId>net-COMMON_PRIVATE</niftyNetworkId>
      <niftyNetworkName/>
      <status>available</status>
      <macAddress>00-00-00-00-00-00</macAddress>
      <privateIpAddress>10.10.10.10</privateIpAddress>
      <privateIpAddressV6>2001:0db8:bd05:01d2:288a:1fc0:0001:10ee</privateIpAddressV6>
      <privateDnsName/>
      <sourceDestCheck/>
      <groupSet/>
        <item>
          <groupId>fw001</groupId>
        </item>
      </groupSet>
      <attachment>
         <attachmentID/>
        <deviceIndex>0</deviceIndex>
        <status>attaching</status>
        <attachTime/>
        <deleteOnTermination>true</deleteOnTermination>
      </attachment>
      <association/>
      <privateIpAddressesSet/>
    </item>
  </networkInterfaceSet>
  </niftyElasticLoadBalancing>
</DescribeInstanceAttributeResponse>

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

APIメニュー

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

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