createNetworkInterface

VPC環境で利用できます。

ネットワークインターフェースを作成します。

リクエスト

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

メソッド	URI
GET \| POST	/vserver/v2/createNetworkInterface

参考

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`vpcNo`	String	Required	VPC番号 getVpcListを参照
`subnetNo`	String	Required	Subnet番号 getSubnetListを参照
`networkInterfaceName`	String	Optional	ネットワークインターフェース名英字の小文字、数字、記号の「-」を組み合わせて3~30文字以内で入力文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用入力しないと自動作成 (デフォルト)
`accessControlGroupNoList.N`	Array	Required	ACG番号リスト getAccessControlGroupListを参照 1~3個以内で入力可能 <例> `accessControlGroupNoList.1=1234&accessControlGroupNoList.2=2345`
`serverInstanceNo`	String	Optional	サーバインスタンス番号 getServerInstanceListを参照 Private Subnetのネットワークインターフェースの場合にのみサーバに割り当て可能
`ip`	String	Optional	Primary IPアドレス Subnetの IPアドレス範囲内で入力 Subnetの 0~5番目、最後の IPアドレスは使用不可 Subnetの範囲内で IPアドレスは重複不可入力しないと自動割り当て (デフォルト) <例> `192.168.0.6`
`isBareMetal`	Boolean	Optional	ベアメタルサーバ用ネットワークインターフェースかどうか `true` \| `false` (デフォルト) `true`: ベアメタルサーバ用 (`serverInstanceNo`は必ず入力) `false`: 一般一般の Subnetでは、ベアメタルサーバ用ネットワークインターフェースは作成不可
`secondaryIpList.N`	Array	Optional	Secondary IPアドレスリスト Subnetの IPアドレス範囲内で入力 `secondaryIpCount`を含めて最大5個まで入力可能 Subnetの範囲内で IPアドレスは重複不可明示的な再割り当てはassignSecondaryIpsを通じて可能 <例> `secondaryIpList.1=192.168.0.1&secondaryIpList.2=192.168.0.2`
`secondaryIpCount`	Integer	Optional	Secondary IPアドレスの自動割り当て数 0~5 Private IPアドレスを順次自動割り当て `secondaryIpList`を含めて最大5個まで入力可能
`networkInterfaceDescription`	String	Optional	ネットワークインターフェースの説明(Byte) 0~1000
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/createNetworkInterface
?regionCode=KR
&vpcNo=4**5
&subnetNo=3***5
&networkInterfaceName=mynic
&accessControlGroupNoList.1=1***1
&isBareMetal=false
&secondaryIpCount=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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "createNetworkInterfaceResponse": {
    "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": "b201fd9f-****-****-****-7610442de046",
    "returnCode": "0",
    "returnMessage": "success"
  }
}