本文へジャンプします。

ニフクラ ユーザーガイド

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 string ネットワークインターフェースID
Filter.n.Name string 絞り込み条件の項目名
値: attachment.instance-id (接続しているサーバーID) | availability-zone (ゾーン) | description (ネットワークインターフェースのメモ情報) | network-interface-id (ネットワークインターフェースID) | nifty-network-id (ネットワークユニークID) | nifty-network-name (ネットワーク名)
Default: なし
Filter.n.Value.m string 絞り込み条件の値
Default: なし

応答フィールド

フィールド (項目) 説明
DescribeNetworkInterfacesResponse - DescribeNetworkInterfacesレスポンス
Ancestor: なし
Children: requestId | networkInterfaceSet
requestId string リクエスト識別子
Ancestor: DescribeNetworkInterfacesResponse
Children: なし
networkInterfaceSet - ネットワークインターフェースの情報セット
Ancestor: DescribeNetworkInterfacesResponse
Children: item
item - ネットワークインターフェースの情報
Ancestor: networkInterfaceSet
Children: association | attachment | availabilityZone | description | groupSet | interfaceType | ipv6AddressesSet | macAddress | networkInterfaceId | ownerId | privateDnsName | privateIpAddress | privateIpAddressV6 | privateIpAddressesSet | requesterId | requesterManaged | sourceDestCheck | status | subnetId | tagSet | vpcId | niftyNetworkId | niftyNetworkName
association - 付替IPの関連付け情報
Ancestor: item
Children: allocationId | associationId | ipOwnerId | publicDnsName | publicIp | publicIpV6
allocationId string ※空を返却
Ancestor: association
Children: なし
associationId string ※空を返却
Ancestor: association
Children: なし
ipOwnerId string ※空を返却
Ancestor: association
Children: なし
publicDnsName string ※空を返却
Ancestor: association
Children: なし
publicIp string ※空を返却
Ancestor: association
Children: なし
publicIpV6 string ※空を返却
Ancestor: association
Children: なし
attachment - サーバーへの接続情報
Ancestor: item
Children: attachmentId | attachTime | deleteOnTermination | deviceIndex | instanceId | instanceOwnerId | status
attachmentId string アタッチメントID
Ancestor: attachment
Children: なし
attachTime timestamp サーバーへの接続時刻
Ancestor: attachment
Children: なし
deleteOnTermination boolean サーバー削除時のネットワークインターフェース消去
値: false(消去しない)
Ancestor: attachment
Children: なし
deviceIndex integer デバイス番号
Ancestor: attachment
Children: なし
instanceId string サーバー名
Ancestor: attachment
Children: なし
instanceOwnerId string ※空を返却
Ancestor: attachment
Children: なし
status string ネットワークインターフェースのステータス
値: attached(接続済) | processing(処理中)
Ancestor: attachment
Children: なし
availabilityZone string ゾーン情報
Ancestor: item
Children: なし
description string メモ情報(CDATA付)
Ancestor: item
Children: なし
groupSet - ファイアウォール情報セット
Ancestor: item
Children: item
item - ファイアウォール情報
Ancestor: groupSet
Children: groupId
groupId string ※空を返却
ファイアウォールグループ名
Ancestor: item
Children: なし
interfaceType string ネットワークインターフェースタイプ
Ancestor: item
Children: なし
ipv6AddressesSet - グローバルIPアドレス(IPv6)情報セット
Ancestor: item
Children: item
item - グローバルIPアドレス(IPv6)情報
Ancestor: ipv6AddressesSet
Children: ipv6Address
ipv6Address string ※空を返却
Ancestor: item
Children: なし
macAddress string MACアドレス
Ancestor: item
Children: なし
networkInterfaceId string ネットワークインターフェースID
Ancestor: item
Children: なし
ownerId string ※空を返却
Ancestor: item
Children: なし
privateDnsName string ※空を返却
Ancestor: item
Children: なし
privateIpAddress string プライベートIPアドレス
Ancestor: item
Children: なし
privateIpAddressV6 string ※空を返却
プライベートIPアドレス(IPv6)
Ancestor: item
Children: なし
privateIpAddressesSet - プライベートIPアドレス(IPv4)情報セット
Ancestor: item
Children: item
item - プライベートIPアドレス(IPv4)情報
Ancestor: privateIpAddressesSet
Children: association | primary | privateDnsName | privateIpAddress
association - プライベートIPv4のネットワークインターフェース関連付け情報
Ancestor: item
Children: allocationId | associationId | ipOwnerId | publicDnsName | publicIp | publicIpV6
allocationId string ※空を返却
Ancestor: association
Children: なし
associationId string ※空を返却
Ancestor: association
Children: なし
ipOwnerId string ※空を返却
Ancestor: association
Children: なし
publicDnsName string ※空を返却
Ancestor: association
Children: なし
publicIp string ※空を返却
Ancestor: association
Children: なし
publicIpV6 string ※空を返却
Ancestor: association
Children: なし
primary boolean ※空を返却
Ancestor: item
Children: なし
privateDnsName string ※空を返却
Ancestor: item
Children: なし
privateIpAddress string ※空を返却
Ancestor: item
Children: なし
requesterId string ※空を返却
Ancestor: item
Children: なし
requesterManaged boolean ※空を返却
Ancestor: item
Children: なし
sourceDestCheck string ※空を返却
Ancestor: item
Children: なし
status string ネットワークインターフェースのステータス
値: available(利用可能) | in-use(使用中) | processing(処理中)
Ancestor: item
Children: なし
subnetId string ※空を返却
Ancestor: item
Children: なし
tagSet - リソースに設定されているタグ情報セット
Ancestor: item
Children: item
item - リソースに設定されているタグ情報
Ancestor: tagSet
Children: key | value
key string ※空を返却
Ancestor: item
Children: なし
value string ※空を返却
Ancestor: item
Children: なし
vpcId string ※空を返却
Ancestor: item
Children: なし
niftyNetworkId string ネットワークユニークID
Ancestor: item
Children: なし
niftyNetworkName string ネットワーク名
Ancestor: item
Children: なし

リクエストサンプル

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

  

応答サンプル

    <DescribeNetworkInterfacesResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <networkInterfaceSet>
    <item>
      <association>
        <allocationId/>
        <associationId/>
        <ipOwnerId/>
        <publicDnsName/>
        <publicIp/>
        <publicIpV6/>
      </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>
      <privateIpAddressV6/>
      <privateIpAddressesSet>
        <item>
          <association>
            <allocationId/>
            <associationId/>
            <ipOwnerId/>
            <publicDnsName/>
            <publicIp/>
            <publicIpV6/>
          </association>
          <primary/>
          <privateDnsName/>
          <privateIpAddress/>
        </item>
      </privateIpAddressesSet>
      <requesterId/>
      <requesterManaged/>
      <sourceDestCheck/>
      <status>available</status>
      <subnetId/>
      <tagSet>
        <item>
          <key></key>
          <value></value>
        </item>
      </tagSet>
      <vpcId/>
      <niftyNetworkId>net-0v3nmuh8</niftyNetworkId>
      <niftyNetworkName>prilan1</niftyNetworkName>
    </item>
  </networkInterfaceSet>
</DescribeNetworkInterfacesResponse>

  

ニフクラ サイト内検索

APIメニュー

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

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