getPublicIpInstanceList

Available in VPC

Get the list of public IP instances.

Syntax

The getPublicIpInstanceList syntax is as follows:

./ncloud vserver getPublicIpInstanceList \
    [--vpcNo <vpc-no>] \
    [--serverName <server-name>] \    
    [--publicIpInstanceNoList <public-ip-no-list>] \
    [--publicIp <public-ip>] \
    [--privateIp <private-ip>] \
    [--isAssociated <true|false>] \
    [--publicIpInstanceStatusCode <INIT|SET|RUN|TERMTING>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getPublicIpInstanceList.

Required options

The following options are required for getPublicIpInstanceList.

Options	Type	Required	Description
`--pageSize`	Integer	Conditional	Number of items per page `1`-`1000` (default: `1`) Required when entering `pageNo`

Optional options

These are the optional options for getPublicIpInstanceList. Options that are not specified will use their default values.

Options	Type	Required	Description
`--vpcNo`	String	Optional	VPC number See getVpcList.
`--serverName`	String	Optional	Assigned server name
`--publicIpInstanceNoList`	List	Optional	Public IP instance number list You can enter multiple items separated by spaces. (e.g., `--publicIpInstanceNoList 1234 2345`)
`--publicIp`	String	Optional	Public IP address
`--privateIp`	String	Optional	eth0 private IP address of server instance to which the public IP instance is assigned
`--isAssociated`	Boolean	Optional	Server assignment status. `true` \| `false` `true`: Assigned `false`: Unassigned
`--publicIpInstanceStatusCode`	String	Optional	Public IP instance status code `INIT` \| `SET` \| `RUN` \| `TERMTING` `INIT`: Creating `SET`: Configuring `RUN`: Running `TERMTING`: Deleting
`--pageNo`	Integer	Optional	Page number `0`-N (default: `0`) First page: Enter `0` or `1`.

Common options

For information about the options common to all vserver subcommands, see Server (VPC) options.

Examples

If the request to retrieve the list of public IP instances is successful, the identification information and status of each public IP are returned.

Command

The command example is as follows:

./ncloud vserver getPublicIpInstanceList \
    --publicIpInstanceNoList 78901234 78901235 \
    --isAssociated false \
    --publicIpInstanceStatusCode RUN \
    --pageNo 1 \
    --pageSize 10 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getPublicIpInstanceListResponse": {
    "totalRows": 2,
    "publicIpInstanceList": [
      {
        "publicIpInstanceNo": "78901235",
        "publicIp": "203.0.113.11",
        "publicIpDescription": "Second test public IP",
        "createDate": "2026-05-14T19:55:37+0900",
        "publicIpInstanceStatusName": "Running",
        "publicIpInstanceStatus": {
          "code": "RUN",
          "codeName": "In operation"
        },
        "serverInstanceNo": "",
        "serverName": "",
        "privateIp": "",
        "publicIpInstanceOperation": {
          "code": "NULL",
          "codeName": "NULL OP"
        }
      },
      {
        "publicIpInstanceNo": "78901234",
        "publicIp": "203.0.113.10",
        "publicIpDescription": "Test public IP",
        "createDate": "2026-05-14T19:53:38+0900",
        "publicIpInstanceStatusName": "Running",
        "publicIpInstanceStatus": {
          "code": "RUN",
          "codeName": "In operation"
        },
        "serverInstanceNo": "",
        "serverName": "",
        "privateIp": "",
        "publicIpInstanceOperation": {
          "code": "NULL",
          "codeName": "NULL OP"
        }
      }
    ],
    "requestId": "b2c3d4e5-f678-9012-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index