getNetworkInterfaceList
- Print
- PDF
getNetworkInterfaceList
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Can be used in a VPC environment.
Overview
Searches the list of network interfaces.
Request
Request parameter
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | - Region code Determines the region to get the network interface list from. regionCode can be obtained through the getRegionList action. Default: Selects the first region of the getRegionList search results. | |
| subnetName | No | String | - Subnet number You can search by filtering with the subnet name to get the network interface list from. | |
| networkInterfaceNoList.N | No | List | - List of network interface numbers You can search by filtering with network interface number. networkInterfaceNo can be obtained through the getNetworkInterfaceList action. ex) --networkInterfaceNoList 1234 2345 | |
| networkInterfaceName | No | String | - Network interface name You can search by filtering with network interface name. | |
| networkInterfaceStatusCode | No | String | Network interface status code Options : SET | UNSET | USED | NOTUSED | |
| ip | No | String | - IP address You can search by filtering with the IP address assigned to the network interface. | |
| secondaryIpList.N | No | List | - List of secondary IPs You can search by filtering with the secondary IP address assigned to the network interface. secondaryIp assigned to the network interface can be obtained through the getNetworkInterfaceList action. ex) secondaryIpList.1=192.168.0.1&secondaryIpList.2=192.168.0.2 | |
| instanceNo | No | String | - Instance number You can search by filtering with the instance number of the device to which the network device is assigned. instanceNo can be obtained through the get action corresponding to instanceType. | |
| isDefault | No | Boolean | - Default status You can search by filtering with the network interface's default status. Options : true | false | |
| deviceName | No | String | - Device name You can search by filtering with the Ethernet name on the device to which the network device is assigned. Options : eth0 | eth1 | eth2 | |
| serverName | No | String | - Server name You can search by filtering with the server name to which the network interface is assigned. | |
| pageNo | No | Integer | - Page number of the paged results The results can be paged using pageNo and pageSize. | |
| pageSize | Conditional | Integer | - Size of each page to be displayed when paging The results can be paged using pageNo and pageSize. Entering this information is required when pageNo is entered. |
Response
Response data type
- NetworkInterfaceList type
| 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<>(); |
Examples
Request examples
ncloud vserver getNetworkInterfaceList --regionCode KR --subnetName test-*** --networkInterfaceNoList ***87 ***88 --networkInterfaceName test-*** --networkInterfaceStatusCode USED --ip ***.***.1.6 --secondaryIpList ***.***.1.7 --instanceNo ***4299 --isDefault ture --deviceName eth0 --serverName test-***
Response examples
<getNetworkInterfaceListResponse>
<requestId>73caedc4-073d-4001-a363-efedd90831be</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<networkInterfaceList>
<networkInterface>
<networkInterfaceNo>***87</networkInterfaceNo>
<networkInterfaceName>test-***</networkInterfaceName>
<subnetNo>***43</subnetNo>
<deleteOnTermination>true</deleteOnTermination>
<isDefault>true</isDefault>
<deviceName>eth0</deviceName>
<networkInterfaceStatus>
<code>USED</code>
<codeName>used </codeName>
</networkInterfaceStatus>
<instanceType>
<code>VSVR</code>
<codeName>Server (VPC)</codeName>
</instanceType>
<instanceNo>***4299</instanceNo>
<ip>***.***.1.6</ip>
<macAddress>F2:20:***:***:8A:F5</macAddress>
<accessControlGroupNoList>
<accessControlGroupNo>***63</accessControlGroupNo>
</accessControlGroupNoList>
<networkInterfaceDescription></networkInterfaceDescription>
<secondaryIpList>
<secondaryIp>***.***.1.7</secondaryIp>
</secondaryIpList>
</networkInterface>
</networkInterfaceList>
</getNetworkInterfaceListResponse>
Was this article helpful?