getPublicIpInstanceList

VPC環境で利用できます。

グローバル IPアドレスリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET \| POST	/vserver/v2/getPublicIpInstanceList

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Server APIで共通して使用されるヘッダの詳細は、Serverのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`publicIpInstanceNoList.N`	Array	Optional	グローバル IPアドレスインスタンス番号リストグローバル IPアドレスインスタンス番号で絞り込み getPublicIpInstanceListを参照 <例> `publicIpInstanceNoList.1=1234&publicIpInstanceNoList.2=2345`
`publicIp`	String	Optional	グローバル IPアドレスで絞り込み
`privateIp`	String	Optional	グローバル IPアドレスが割り当てられたサーバの eth0プライベート IPアドレスで絞り込み
`isAssociated`	Boolean	Optional	サーバに割り当てられたかで絞り込み `true` \| `false` `true`: 割り当て `false`: 未割り当て
`serverName`	String	Optional	割り当てサーバ名で絞り込み
`publicIpInstanceStatusCode`	String	Optional	グローバル IPアドレスインスタンスの状態コードで絞り込み `INIT` \| `SET` \| `RUN` \| `TERMTING` `INIT`: 作成中 `SET`: 設定中 `RUN`: 運用中 `TERMTING`: 削除中
`pageNo`	Integer	Optional	ページ番号 0~N (デフォルト: 0) 最初のページ: `0`または`1`を入力
`pageSize`	Integer	Conditional	ページごとの項目数 1~1000 (デフォルト: 1) `pageNo`入力時、必ず入力
`vpcNo`	String	Optional	VPC番号 getVpcListを参照
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getPublicIpInstanceList
?regionCode=KR
&publicIpInstanceStatusCode=RUN
&pageNo=1
&pageSize=5
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`getPublicIpInstanceListResponse`	Object	-	レスポンス結果 PublicIpInstanceListを参照
`getPublicIpInstanceListResponse.requestId`	String	-	リクエスト ID UUID形式
`getPublicIpInstanceListResponse.returnCode`	String	-	レスポンスコード
`getPublicIpInstanceListResponse.returnMessage`	String	-	レスポンスメッセージ

レスポンスステータスコード

Server APIで共通して使用されるレスポンスステータスコードの詳細は、Serverのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "getPublicIpInstanceListResponse": {
    "totalRows": 1,
    "publicIpInstanceList": [
      {
        "publicIpInstanceNo": "10*****54",
        "publicIp": "101.*.*.67",
        "publicIpDescription": "test IP",
        "createDate": "2025-06-20T10:31:23+0900",
        "publicIpInstanceStatusName": "Running",
        "publicIpInstanceStatus": {
          "code": "RUN",
          "codeName": "運用中"
        },
        "serverInstanceNo": "",
        "serverName": "",
        "privateIp": "",
        "publicIpInstanceOperation": {
          "code": "NULL",
          "codeName": "NULL OP"
        }
      }
    ],
    "requestId": "75f48775-****-****-****-6f8e3d525a17",
    "returnCode": "0",
    "returnMessage": "success"
  }
}