本文へジャンプします。

ニフクラ ユーザーガイド

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

リクエストサンプル

    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メニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年9月17日時点の情報です。

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