getPublicIpTargetServerInstanceList

Prev Next

VPC環境で利用できます。

グローバル IPアドレスインスタンスが割り当て可能なサーバリストを照会します。

リクエスト

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

メソッド URI
GET | POST /vserver/v2/getPublicIpTargetServerInstanceList
参考

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getPublicIpTargetServerInstanceList
?regionCode=KR
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "getPublicIpTargetServerInstanceListResponse": {
    "totalRows": 1,
    "serverInstanceList": [
      {
        "serverInstanceNo": "10*****61",
        "serverName": "s-1ygu1mlm056k1",
        "serverDescription": "",
        "cpuCount": 2,
        "memorySize": 8589934592,
        "platformType": {
          "code": "UBD64",
          "codeName": "Ubuntu Desktop 64 Bit"
        },
        "loginKeyName": "ncp-loginkey",
        "publicIpInstanceNo": "",
        "publicIp": "",
        "serverInstanceStatus": {
          "code": "RUN",
          "codeName": "サーバ RUN状態"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "サーバ NULL OP"
        },
        "serverInstanceStatusName": "running",
        "createDate": "2025-06-12T14:01:17+0900",
        "uptime": "2025-06-12T14:06:33+0900",
        "serverImageProductCode": "SW.VSVR.OS.LNX64.UBNTU.SVR2204.B050",
        "serverProductCode": "SVR.VSVR.STAND.C002.M008.NET.SSD.B050.G002",
        "isProtectServerTermination": false,
        "zoneCode": "KR-2",
        "regionCode": "KR",
        "vpcNo": "4**5",
        "subnetNo": "3***4",
        "networkInterfaceNoList": [
          "7***55"
        ],
        "initScriptNo": "",
        "serverInstanceType": {
          "code": "STAND",
          "codeName": "Standard"
        },
        "baseBlockStorageDiskType": {
          "code": "NET",
          "codeName": "ネットワークストレージ"
        },
        "baseBlockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "placementGroupNo": "",
        "placementGroupName": "",
        "memberServerImageInstanceNo": "",
        "hypervisorType": {
          "code": "XEN",
          "codeName": "XEN"
        },
        "serverImageNo": "3182409",
        "serverSpecCode": "s2-g2-s50",
        "eventList": [],
        "fabricClusterPoolNo": "",
        "fabricClusterPoolName": "",
        "fabricClusterMode": "",
        "fabricClusterNo": "",
        "fabricClusterName": ""
      }
    ],
    "requestId": "f22e5d98-****-****-****-7d0005327d82",
    "returnCode": "0",
    "returnMessage": "success"
  }
}