getNetworkInterfaceList

VPC環境で利用できます。

ネットワークインターフェースリストを照会します。

構文

getNetworkInterfaceList構文は次の通りです。

./ncloud vserver getNetworkInterfaceList \
    [--subnetName <subnet-name>] \
    [--networkInterfaceNoList <nic-no-list>] \
    [--networkInterfaceName <nic-name>] \
    [--networkInterfaceStatusCode <SET|UNSET|USED|NOTUSED>] \
    [--ip <ip>] \
    [--secondaryIpList <secondary-ip-list>] \
    [--isDefault <true|false>] \
    [--deviceName <eth0|eth1|eth2>] \
    [--instanceNo <instance-no>] \
    [--serverName <server-name>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

getNetworkInterfaceListの実行時に指定できるオプションについて説明します。

必須オプション

getNetworkInterfaceListの必須オプションです。

オプション	タイプ	必須の有無	説明
`--pageSize`	Integer	Conditional	ページごとの項目数 `1`~`1000` (デフォルト: `1`) `pageNo`入力時、必ず入力

任意オプション

getNetworkInterfaceListの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション	タイプ	必須の有無	説明
`--subnetName`	String	Optional	Subnet名 getSubnetListを参照
`--networkInterfaceNoList`	List	Optional	ネットワークインターフェース番号リストスペースで区切って複数入力可能 (例: `--networkInterfaceNoList 1234 2345`)
`--networkInterfaceName`	String	Optional	ネットワークインターフェースの名前
`--networkInterfaceStatusCode`	String	Optional	ネットワークインターフェースの状態コード `SET` \| `UNSET` \| `USED` \| `NOTUSED` `SET`: 設定中 `UNSET`: 解除中 `USED`: 使用中 `NOTUSED`: 未使用中
`--ip`	String	Optional	IPアドレス
`--secondaryIpList`	List	Optional	Secondary IPアドレスリストスペースで区切って複数入力可能 (例: `--secondaryIpList 192.168.0.1 192.168.0.2`)
`--isDefault`	Boolean	Optional	デフォルトネットワークインターフェースかどうか `true` \| `false` `true`: デフォルトネットワークインターフェース `false`: デフォルトネットワークインターフェースではない
`--deviceName`	String	Optional	デバイスの名前 `eth0` \| `eth1` \| `eth2`
`--instanceNo`	String	Optional	インスタンス番号
`--serverName`	String	Optional	割り当てサーバ名
`--pageNo`	Integer	Optional	ページ番号 `0`~N (デフォルト: `0`) 最初のページ: `0`または`1`を入力

共通オプション

vserverコマンドで共通して使用するオプションについては、Server (VPC)のオプションをご参照ください。

例

ネットワークインターフェースリストの照会リクエストが成功すると、各ネットワークインターフェースの識別情報とネットワーク構成が返されます。

コマンド

コマンドの例は次の通りです。

./ncloud vserver getNetworkInterfaceList \
    --subnetName private-subnet \
    --networkInterfaceNoList 56789013 56789014 \
    --networkInterfaceStatusCode USED \
    --isDefault true \
    --deviceName eth0 \
    --pageNo 1 \
    --pageSize 10 \
    --regionCode KR \
    --output json

出力

出力の例は次の通りです。

{
  "getNetworkInterfaceListResponse": {
    "totalRows": 2,
    "networkInterfaceList": [
      {
        "networkInterfaceNo": "56789013",
        "networkInterfaceName": "nic-56789013",
        "subnetNo": "23456789",
        "deleteOnTermination": true,
        "isDefault": true,
        "deviceName": "eth0",
        "networkInterfaceStatus": {
          "code": "USED",
          "codeName": "使用中"
        },
        "instanceType": {
          "code": "VSVR",
          "codeName": "Server (VPC)"
        },
        "instanceNo": "34567891",
        "ip": "192.0.2.12",
        "macAddress": "F2:20:AF:00:00:02",
        "enableFlowLog": false,
        "accessControlGroupNoList": [
          "67890123"
        ],
        "networkInterfaceDescription": "",
        "secondaryIpList": []
      },
      {
        "networkInterfaceNo": "56789014",
        "networkInterfaceName": "nic-56789014",
        "subnetNo": "23456789",
        "deleteOnTermination": true,
        "isDefault": true,
        "deviceName": "eth0",
        "networkInterfaceStatus": {
          "code": "USED",
          "codeName": "使用中"
        },
        "instanceType": {
          "code": "VSVR",
          "codeName": "Server (VPC)"
        },
        "instanceNo": "34567890",
        "ip": "192.0.2.6",
        "macAddress": "F2:20:AF:00:00:03",
        "enableFlowLog": false,
        "accessControlGroupNoList": [
          "67890123"
        ],
        "networkInterfaceDescription": "",
        "secondaryIpList": []
      }
    ],
    "requestId": "c2d3e4f5-6789-0123-cdef-234567890123",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index