createNetworkInterface

Prev Next

VPC環境で利用できます。

概要

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

リクエスト

リクエストパラメータ

パラメータ名 要否 タイプ 制約事項 説明
regionCode No String - リージョンコード
ネットワークインターフェースが作成されるリージョン(Region)を決定可能
regionCodeは、getRegionListアクションを通じて取得可能
Default: getRegionList照会結果の最初のリージョンを選択
vpcNo Yes String - VPC番号
ネットワークインターフェースが作成される VPCを決定
vpcNoは、getVpcListアクションを通じて取得可能
subnetNo Yes String - Subnet番号
ネットワークインターフェースが作成される Subnetを決定
subnetNoは、getSubnetListアクションを通じて取得可能
networkInterfaceName No String Min : 3, Max : 30
アルファベットの小文字、数字、特殊文字の「-」のみ入力許可し、先頭文字はアルファベットにすること
末尾文字はアルファベットまたは数字にする
- 作成するネットワークインターフェースの名前
Default: NAVER CLOUD PLATFORMが自動で付与
accessControlGroupNoList.N Yes List<String> 最小: 1、最大: 3個 - ネットワークインターフェースに適用する ACG番号リスト
最大3個の ACGを適用可能
accessControlGroupNoは、getAccessControlGroupListアクションを通じて取得可能
ex) --accessControlGroupNoList 1234 2345
serverInstanceNo No String - ネットワークインターフェースを割り当てるサーバインスタンス番号
作成するネットワークインターフェースが、Private Subnetのネットワークインターフェースである場合にのみサーバに割り当て可能
serverInstanceNoは、getServerInstanceListアクションを通じて取得可能
ip No String - IPアドレス
ネットワークインターフェースに割り当てる IPアドレスを直接入力可能
ネットワークインターフェースが作成される Subnetの IPアドレスの範囲に必ず含むこと
Subnetの0~5番目、最後の IPアドレスは使用できず、Subnetの範囲で重複した IPアドレスは使用不可
Default: 条件を満たす IPアドレスが順次割り当てられる
ex) 192.168.0.6
isBareMetal No Boolean - ベアメタル用ネットワークインターフェースの有無
trueに設定時、ベアメタル用ネットワークインターフェースを作成する際、サーバを明示をする場合のみ作成が可能(serverInstanceNoパラメータ必須)
falseに設定時、一般ネットワークインターフェースを作成
一般サブネットでは、ベアメタル用ネットワークインターフェースの作成不可
Default: 一般ネットワークインターフェースを作成
secondaryIpList.N No List<String> 最小: 0、最大: 5個 -セカンダリ IPアドレスリスト
選択した Subnetの IPアドレスの範囲に含まれるプライベート IPアドレスをセカンダリ IPアドレスとして追加可能
secondaryIpCountの数と合わせて最大5個までセカンダリ IPアドレスが追加可能
選択した Subnetで既に使用中の IPアドレスは使用不可
明示的な再割り当て機能を利用するには、ネットワークインターフェースの作成後に assignSecondaryIpsアクションを通じて利用可能
ex) secondaryIpList.1=192.168.0.1&secondaryIpList.2=192.168.0.2
secondaryIpCount No Integer Min : 0, Max : 5 - セカンダリ IPアドレスの自動割り当て数
指定した数だけセカンダリ IPアドレスの自動割り当てが可能
選択した Subnetで使用中ではない Private IPアドレスが順次割り当てられる
secondaryIpListの数を含めて最大5個のセカンダリ IPアドレスの追加が可能
networkInterfaceDescription No String Min : 0, Max : 1000 Bytes 作成するネットワークインターフェースについての説明

レスポンス

レスポンスデータのタイプ

  • NetworkInterfaceListタイプ
NetworkInterfaceList extends CommonResponse
private Integer totalRows;
private List<NetworkInterface> networkInterfaceList = new ArrayList<>();
NetworkInterface
private String networkInterfaceNo;
private String networkInterfaceName;
private String subnetNo;
private Boolean deleteOnTermination;
private Boolean isDefault;
private String deviceName;
private CommonCode networkInterfaceStatus;
private CommonCode instanceType;
private String instanceNo;
private String ip;
private String macAddress;
private AccessControlGroupNoList accessControlGroupNoList;
private String networkInterfaceDescription;
private SecondaryIpList secondaryIpList;
SecondaryIpList
private List<String> secondaryIpList = new ArrayList<>();

リクエスト例

ncloud vserver createNetworkInterface --regionCode KR --vpcNo ***04 --subnetNo ***43 --networkInterfaceName test-*** --accessControlGroupNoList ***63 ***64 --serverInstanceNo ***4299 --ip ***.***.1.7 --secondaryIpList ***.***.1.8 --secondaryIpCount 1

レスポンス例

<createNetworkInterfaceResponse>
  <requestId>18e8b085-c6bc-4953-9ec7-9cdf43236c59</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <networkInterfaceList>
    <networkInterface>
      <networkInterfaceNo>***87</networkInterfaceNo>
      <networkInterfaceName>test-***</networkInterfaceName>
      <subnetNo>***43</subnetNo>
      <deleteOnTermination>false</deleteOnTermination>
      <isDefault>false</isDefault>
      <deviceName>eth1</deviceName>
      <networkInterfaceStatus>
        <code>USED</code>
        <codeName>used </codeName>
      </networkInterfaceStatus>
      <instanceType>
        <code>VSVR</code>
        <codeName>Server (VPC)</codeName>
      </instanceType>
      <instanceNo>***4299</instanceNo>
      <ip>***.***.1.7</ip>
      <macAddress>F2:20:***:***:8A:F5</macAddress>
      <accessControlGroupNoList>
        <accessControlGroupNo>***63</accessControlGroupNo>
      </accessControlGroupNoList>
      <networkInterfaceDescription></networkInterfaceDescription>
      <secondaryIpList>
        <secondaryIp>***.***.1.8</secondaryIp>
        <secondaryIp>***.***.1.9</secondaryIp>
      </secondaryIpList>
    </networkInterface>
  </networkInterfaceList>
</createNetworkInterfaceResponse>