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
Get the list of network interfaces.
Request
Request parameter
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | - Region code You can decide the region to get the network interface list from. You can obtain regionCode 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 you will get the network interface list from. | |
| networkInterfaceNoList.N | No | List | - List of network interface numbers You can search by filtering with a network interface number. You can obtain networkInterfaceNo through the getNetworkInterfaceList action. E.g., networkInterfaceNoList.1=1234&networkInterfaceNoList.2=2345 | |
| networkInterfaceName | No | String | - Network interface name You can search by filtering with a 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 an IP address assigned to the network interface. | |
| secondaryIpList.N | No | List | - List of secondary IPs You can search by filtering with a secondary IP address assigned to the network interface. You can obtain secondaryIp assigned to the network interface through the getNetworkInterfaceList action. E.g., 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. You can obtain instanceNo 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 an 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 a 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 | - Each page size to be displayed when paging The results can be paged using pageNo and pageSize. Entering this info is required when pageNo is entered. | |
| responseFormatType | No | String | - Format type of the response result Options: xml | json Default: xml |
Response
Response body
Examples
Request examples
GET {API_URL}/getNetworkInterfaceList
?regionCode=KR
&subnetName=test-***
&networkInterfaceNoList.1=***87
&networkInterfaceName=test-***
&networkInterfaceStatusCode=USED
&ip=***.***.1.6
&secondaryIpList.1=***.***.1.7
&instanceNo=***4299
&isDefault=true
&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?