associatePublicIpWithServerInstance

Prev Next

VPC環境で利用できます。

グローバル IPインスタンスをサーバインスタンスに割り当てます。

リクエスト

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

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/associatePublicIpWithServerInstance
?regionCode=KR
&publicIpInstanceNo=10*****54
&serverInstanceNo=10*****18
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "associatePublicIpWithServerInstanceResponse": {
    "totalRows": 1,
    "publicIpInstanceList": [
      {
        "publicIpInstanceNo": "10*****54",
        "publicIp": "101.*.*.67",
        "publicIpDescription": "test IP",
        "createDate": "2025-06-20T10:31:23+0900",
        "publicIpInstanceStatusName": "Configuring",
        "publicIpInstanceStatus": {
          "code": "RUN",
          "codeName": "運用中"
        },
        "serverInstanceNo": "10*****18",
        "serverName": "s-65gu4d2is312u",
        "privateIp": "10.0.10.6",
        "publicIpInstanceOperation": {
          "code": "SET",
          "codeName": "SETTING OP"
        }
      }
    ],
    "requestId": "dbfe4f39-****-****-****-3bbb2b62a284",
    "returnCode": "0",
    "returnMessage": "success"
  }
}