getNetworkInterfaceList

Prev Next

VPC環境で利用できます。

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

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET | POST /vserver/v2/getNetworkInterfaceList
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Server APIで共通して使用されるヘッダの詳細は、Serverのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
subnetName String Optional Subnet名で絞り込み
networkInterfaceNoList.N Array Optional ネットワークインターフェース番号リスト
  • ネットワークインターフェース番号で絞り込み
  • <例> networkInterfaceNoList.1=1234&networkInterfaceNoList.2=2345
networkInterfaceName String Optional ネットワークインターフェース名で絞り込み
networkInterfaceStatusCode String Optional ネットワークインターフェースの状態コードで絞り込み
  • SET | UNSET | USED | NOTUSED
    • SET: 設定中
    • UNSET: 解除中
    • USED: 使用中
    • NOTUSED: 未使用中
ip String Optional IPアドレスで絞り込み
secondaryIpList.N Array Optional Secondary IPアドレスリスト
  • Secondary IPアドレスで絞り込み
  • <例> secondaryIpList.1=192.168.0.1&secondaryIpList.2=192.168.0.2
instanceNo String Optional インスタンス番号で絞り込み
  • デバイスのインスタンス照会 APIを参照
isDefault Boolean Optional デフォルトネットワークインターフェースかどうかで絞り込み
  • true | false
    • true: デフォルトネットワークインターフェース
    • false: デフォルトネットワークインターフェースではない
deviceName String Optional デバイス名で絞り込み
  • eth0 | eth1 | eth2
serverName String Optional 割り当てサーバ名で絞り込み
pageNo Integer Optional ページ番号
  • 0~N (デフォルト: 0)
  • 最初のページ: 0または1を入力
pageSize Integer Conditional ページごとの項目数
  • 1~1000 (デフォルト: 1)
  • pageNo入力時、必ず入力
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getNetworkInterfaceList
?regionCode=KR
&networkInterfaceName=nic
&subnetName=sb1
&deviceName=eth0
&pageNo=1
&pageSize=2
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
getNetworkInterfaceListResponse Object - レスポンス結果
getNetworkInterfaceListResponse.requestId String - リクエスト ID
  • UUID形式
getNetworkInterfaceListResponse.returnCode String - レスポンスコード
getNetworkInterfaceListResponse.returnMessage String - レスポンスメッセージ

レスポンスステータスコード

Server APIで共通して使用されるレスポンスステータスコードの詳細は、Serverのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "getNetworkInterfaceListResponse": {
    "totalRows": 4,
    "networkInterfaceList": [
      {
        "networkInterfaceNo": "70***6",
        "networkInterfaceName": "nic-70***6",
        "subnetNo": "3***4",
        "deleteOnTermination": true,
        "isDefault": true,
        "deviceName": "eth0",
        "networkInterfaceStatus": {
          "code": "USED",
          "codeName": "使用中"
        },
        "instanceType": {
          "code": "VSVR",
          "codeName": "Server (VPC)"
        },
        "instanceNo": "10*****18",
        "ip": "10.0.10.6",
        "macAddress": "F2:**:**:**:**:AC",
        "enableFlowLog": false,
        "accessControlGroupNoList": [
          "1***1"
        ],
        "networkInterfaceDescription": "",
        "secondaryIpList": []
      },
      {
        "networkInterfaceNo": "70***5",
        "networkInterfaceName": "nic-70***5",
        "subnetNo": "3***4",
        "deleteOnTermination": true,
        "isDefault": true,
        "deviceName": "eth0",
        "networkInterfaceStatus": {
          "code": "USED",
          "codeName": "使用中"
        },
        "instanceType": {
          "code": "VSVR",
          "codeName": "Server (VPC)"
        },
        "instanceNo": "10*****61",
        "ip": "10.0.10.7",
        "macAddress": "F2:**:**:**:**:1E",
        "enableFlowLog": false,
        "accessControlGroupNoList": [
          "1***1"
        ],
        "networkInterfaceDescription": "",
        "secondaryIpList": []
      }
    ],
    "requestId": "85b22651-****-****-****-45a5ed2bc52b",
    "returnCode": "0",
    "returnMessage": "success"
  }
}