getNetworkInterfaceDetail

Prev Next

VPC環境で利用できます。

ネットワークインターフェースの詳細情報を照会します。

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
networkInterfaceNo String Required ネットワークインターフェース番号
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getNetworkInterfaceDetail
?regionCode=KR
&networkInterfaceNo=70***0
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "getNetworkInterfaceDetailResponse": {
    "totalRows": 1,
    "networkInterfaceList": [
      {
        "networkInterfaceNo": "70***0",
        "networkInterfaceName": "mynic",
        "subnetNo": "3***5",
        "deleteOnTermination": false,
        "isDefault": false,
        "deviceName": "",
        "networkInterfaceStatus": {
          "code": "NOTUSED",
          "codeName": "未使用中"
        },
        "ip": "10.0.20.6",
        "macAddress": "F2:**:**:**:**:A3",
        "enableFlowLog": false,
        "accessControlGroupNoList": [
          "1***1"
        ],
        "networkInterfaceDescription": "",
        "secondaryIpList": []
      }
    ],
    "requestId": "d170f24b-****-****-****-a9dcb933fd12",
    "returnCode": "0",
    "returnMessage": "success"
  }
}