attachNetworkInterface

Prev Next

VPC環境で利用できます。

ネットワークインターフェースをサーバインスタンスに割り当てます。

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
serverInstanceNo String Required サーバインスタンス番号
networkInterfaceNo String Required ネットワークインターフェース番号
  • デフォルトのネットワークインターフェースを含め、最大3個まで割り当て可能
  • getNetworkInterfaceListを参照
subnetNo String Required Subnet番号
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "attachNetworkInterfaceResponse": {
    "totalRows": 1,
    "networkInterfaceList": [
      {
        "networkInterfaceNo": "70***0",
        "networkInterfaceName": "mynic",
        "subnetNo": "3***5",
        "deleteOnTermination": false,
        "isDefault": false,
        "deviceName": "eth1",
        "networkInterfaceStatus": {
          "code": "SET",
          "codeName": "設定中"
        },
        "instanceType": {
          "code": "VSVR",
          "codeName": "Server (VPC)"
        },
        "instanceNo": "10*****61",
        "ip": "10.0.20.6",
        "macAddress": "F2:**:**:**:**:A3",
        "enableFlowLog": false,
        "accessControlGroupNoList": [],
        "networkInterfaceDescription": "",
        "secondaryIpList": []
      }
    ],
    "requestId": "cff6f287-****-****-****-742c290d0811",
    "returnCode": "0",
    "returnMessage": "success"
  }
}