getPublicIpInstanceList

VPC環境で利用できます。

パブリック IPアドレスリストを照会します。

構文

getPublicIpInstanceList構文は次の通りです。

./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>]

オプション

getPublicIpInstanceListの実行時に指定できるオプションについて説明します。

必須オプション

getPublicIpInstanceListの必須オプションです。

オプション	タイプ	必須の有無	説明
`--pageSize`	Integer	Conditional	ページごとの項目数 `1`~`1000` (デフォルト: `1`) `pageNo`入力時、必ず入力

任意オプション

getPublicIpInstanceListの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション	タイプ	必須の有無	説明
`--vpcNo`	String	Optional	VPC番号 getVpcListを参照
`--serverName`	String	Optional	割り当てサーバ名
`--publicIpInstanceNoList`	List	Optional	パブリック IPアドレスインスタンス番号リストスペースで区切って複数入力可能 (例: `--publicIpInstanceNoList 1234 2345`)
`--publicIp`	String	Optional	パブリック IPアドレス
`--privateIp`	String	Optional	パブリック IPアドレスが割り当てられたサーバの eth0のプライベート IPアドレス
`--isAssociated`	Boolean	Optional	サーバに割り当てられたか `true` \| `false` `true`: 割り当て `false`: 未割り当て
`--publicIpInstanceStatusCode`	String	Optional	パブリック IPアドレスインスタンスの状態コード `INIT` \| `SET` \| `RUN` \| `TERMTING` `INIT`: 作成中 `SET`: 設定中 `RUN`: 運用中 `TERMTING`: 削除中
`--pageNo`	Integer	Optional	ページ番号 `0`~N (デフォルト: `0`) 最初のページ: `0`または`1`を入力

共通オプション

vserverコマンドで共通して使用するオプションについては、Server (VPC)のオプションをご参照ください。

例

パブリック IPアドレスインスタンスリストの照会リクエストが成功すると、各パブリック IPアドレスの識別情報と状態が返されます。

コマンド

コマンドの例は次の通りです。

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

出力

出力の例は次の通りです。

{
  "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": "実行中"
        },
        "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": "実行中"
        },
        "serverInstanceNo": "",
        "serverName": "",
        "privateIp": "",
        "publicIpInstanceOperation": {
          "code": "NULL",
          "codeName": "NULL OP"
        }
      }
    ],
    "requestId": "b2c3d4e5-f678-9012-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index