本文へジャンプします。

ニフクラ APIリファレンス

DescribeNetworkInterfaces

処理概要

追加NICの情報を取得します。1回のリクエストで複数の追加NICの情報を取得できます。
追加NICの情報を指定するためには、追加NICのネットワークインターフェースIDが必要です。指定しない場合は、取得可能なすべての追加NICの情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字(曖昧検索)指定可能です。「∗」は0個以上任意文字、「?」は1個任意文字、「\」はエスケープ変換文字(「¥∗niftycloud¥?¥¥ 」は「∗niftycloud?¥」を検索)となります。
曖昧検索が指定可能な絞り込み条件の項目名は、attachment.instance-id、description、nifty-network-nameになります。

指定するパラメーター

パラメーター 説明 必須 サンプル値
NetworkInterfaceId.n ネットワークインターフェースID
Type : String
  ni-3db04f80
Filter.n.Name 絞り込み条件の項目名
Type : String
値 : attachment.instance-id(接続しているサーバーID)| availability-zone(ゾーン)| description(ネットワークインターフェースのメモ情報)| network-interface-id(ネットワークインターフェースID)| nifty-network-id(ネットワークユニークID)| nifty-network-name(ネットワーク名)
Default : なし
   
Filter.n.Value.m 絞り込み条件の値
Type : String
Default : なし
   

応答フィールド

フィールド(項目) 説明 サンプル値
DescribeNetworkInterfacesResponse DescribeNetworkInterfacesレスポンス
Type : DescribeNetworkInterfacesResponseType
Ancestor : なし
Children : requestId,networkInterfaceSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : DescribeNetworkInterfacesResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
networkInterfaceSet ネットワークインターフェースの情報セット
Type : NetworkInterfaceSetType
Ancestor : DescribeNetworkInterfacesResponse
Children : item
 
item ネットワークインターフェースの情報
Type : NetworkInterfaceItemType
Ancestor : networkInterfaceSet
Children : association, attachment, availabilityZone, description, groupSet, interfaceType, ipv6AddressesSet, macAddress, networkInterfaceId, ownerId, privateDnsName, privateIpAddress, privateIpAddressesSet, requesterId, requesterManaged, sourceDestCheck, status, subnetId, tagSet, vpcId, niftyNetworkId, niftyNetworkName
 
association 付替IPの関連付け情報
Type : AssociationType
Ancestor : item
Children : allocationId, associationId, ipOwnerId, publicDnsName, publicIp
 
allocationId ※返却値なし
Type : xsd:string
Ancestor : association
Children : なし
 
associationId ※返却値なし
Type : xsd:string
Ancestor : association
Children : なし
 
ipOwnerId ※返却値なし
Type : xsd:string
Ancestor : association
Children : なし
 
publicDnsName ※返却値なし
Type : xsd:string
Ancestor : association
Children : なし
 
publicIp ※返却値なし
Type : xsd:string
Ancestor : association
Children : なし
 
attachment サーバーへの接続情報
Type : AttachmentType
Ancestor : item
Children : attachmentId, attachTime, deleteOnTermination, deviceIndex, instanceId, instanceOwnerId, status
 
attachmentId アタッチメントID
Type : xsd:string
Ancestor : attachment
Children : なし
iniatc-2ab04f80
attachTime サーバーへの接続時刻
Type : xsd:string
Ancestor : attachment
Children : なし
2017-09-25T07:45:31.547+09:00
deleteOnTermination サーバー削除時のネットワークインターフェース消去
Type : xsd:boolean
値: true (消去する) | false (消去しない)
Ancestor : attachment
Children : なし
false
deviceIndex デバイス番号
Type : xsd:string
Ancestor : attachment
Children : なし
 
instanceId サーバー名
Type : xsd:string
Ancestor : attachment
Children : なし
server01
instanceOwnerId ※空を返却
Type : xsd:string
Ancestor : attachment
Children : なし
 
status ネットワークインターフェースのステータス
Type : xsd:string
値 : attached(接続済)
Ancestor : attachment
Children : なし
 
availabilityZone ゾーン情報
Type : xsd:string
Ancestor : item
Children : なし
east-12
description メモ情報(CDATA付)
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 : なし
 
interfaceType ネットワークインターフェースタイプ
Type : xsd:string
Ancestor : item
Children : なし
 
ipv6AddressesSet グローバルIPアドレス(IPv6)情報セット
Type : Ipv6AddressesSetType
Ancestor : item
Children : item
 
item グローバルIPアドレス(IPv6)情報
Type : Ipv6AddressesItemType
Ancestor : ipv6AddressesSet
Children : ipv6Address
 
ipv6Address ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
macAddress MACアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
networkInterfaceId ネットワークインターフェースID
Type : xsd:string
Ancestor : item
Children : なし
ni-3db04f80
ownerId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
privateDnsName ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
privateIpAddress プライベートIPアドレス
Type : xsd:string
Ancestor : item
Children : なし
10.0.5.111
privateIpAddressesSet プライベートIPアドレス(IPv4)情報セット
Type : PrivateIpAddressesSetType
Ancestor : item
Children : item
 
item プライベートIPアドレス(IPv4)情報
Type : PrivateIpAddressesItemType
Ancestor : privateIpAddressesSet
Children : association, primary, privateDnsName, privateIpAddress
 
association プライベートIPv4のネットワークインターフェース関連付け情報
Type : AssociationType
Ancestor : item
Children : allocationId, associationId, ipOwnerId, publicDnsName, publicIp
 
allocationId ※返却値なし
Type : xsd:string
Ancestor : association
Children : なし
 
associationId ※返却値なし
Type : xsd:string
Ancestor : association
Children : なし
 
isOwnerId ※返却値なし
Type : xsd:string
Ancestor : association
Children : なし
 
publicDnsName ※返却値なし
Type : xsd:string
Ancestor : association
Children : なし
 
publicIp ※返却値なし
Type : xsd:string
Ancestor : association
Children : なし
 
primary ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
privateDnsName ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
privateIpAddress ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
requesterId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
requesterManaged ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
sourceDestCheck ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
status ネットワークインターフェースのステータス
Type : xsd:string
値 : available(利用可能) | in-use(使用中) | processing (処理中)
Ancestor : item
Children : なし
 
subnetId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
tagSet リソースに設定されているタグ情報セット
Type : ResourceTagSetType
Ancestor : item
Children : item
 
item リソースに設定されているタグ情報
Type : ResourceTagSetItemType
Ancestor : tagSet
Children : key,value
 
key ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
value ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
vpcId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
niftyNetworkId ネットワークユニークID
Type : xsd:string
Ancestor : item
Children : なし
net-0v3nmuh8
niftyNetworkName ネットワーク名
Type : xsd:string
Ancestor : item
Children : なし
 

リクエストサンプル

https://computing.jp-east-1.api.cloud.nifty.com/api/?Action=DescribeNetworkInterfaces&NetworkInterfaceId.1=ni-3db04f80&Filter.1.Name=nifty-network-id&Filter.1.Value.1=net-0v3nmuh8&CommonParams

応答サンプル

<DescribeNetworkInterfacesResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <networkInterfaceSet>
  <item>
   <association>
    <allocationId/>
    <associationId/>
    <ipOwnerId/>
    <publicDnsName/>
    <publicIp/>
   </association>
   <attachment>
    <attachmentId>iniatc-2ab04f80</attachmentId>
    <attachTime>2017-09-25T07:45:31.547+09:00</attachTime>
    <deleteOnTermination>false</deleteOnTermination>
    <deviceIndex>0</deviceIndex>
    <instanceId>server01</instanceId>
    <instanceOwnerId/>
    <status>attached</status>
   </attachment>
   <availabilityZone>east-12</availabilityZone>
   <description><![CDATA[memo]]></description>
   <groupSet>
    <item>
     <groupId/>
    </item>
   </groupSet>
   <interfaceType>interface</interfaceType>
   <ipv6AddressesSet>
    <item>
     <ipv6Address/>
    </item>
   </ipv6AddressesSet>
   <macAddress>07:00:30:1B:92:44</macAddress>
   <networkInterfaceId>ni-3db04f80</networkInterfaceId>
   <ownerId/>
   <privateDnsName/>
   <privateIpAddress>10.0.5.111</privateIpAddress>
   <privateIpAddressesSet>
    <item>
     <association>
      <allocationId/>
      <associationId/>
      <ipOwnerId/>
      <publicDnsName/>
      <publicIp/>
     </association>
     <primary/>
     <privateDnsName/>
     <privateIpAddress/>
    </item>
   </privateIpAddressesSet>
   <requesterId/>
   <requesterManaged/>
   <sourceDestCheck/>
   <status>available</status>
   <subnetId/>
   <tagSet/>
   <vpcId/>
   <niftyNetworkId>net-0v3nmuh8</niftyNetworkId>
   <niftyNetworkName>prilan1</niftyNetworkName>
  </item>
 </networkInterfaceSet>
</DescribeNetworkInterfacesResponse>

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

APIメニュー

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

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