createPublicIpInstance

Prev Next

Available in VPC

Create a public IP instance.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET | POST /vserver/v2/createPublicIpInstance
Note

This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.

Request headers

For information about the headers common to all Server APIs, see Server request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
regionCode String Optional Region code
serverInstanceNo String Optional Server instance number
publicIpDescription String Optional Public IP description (byte)
  • 0-1000
responseFormatType String Optional Format of the response data
  • xml (default) | json

Request example

The request example is as follows:

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

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
createPublicIpInstanceResponse Object - Response result
createPublicIpInstanceResponse.requestId String - ID for the request
  • UUID format
createPublicIpInstanceResponse.returnCode String - Response code
createPublicIpInstanceResponse.returnMessage String - Response message

Response status codes

For information about the response status codes common to all Server APIs, see Server response status codes.

Response example

The response example is as follows:

{
  "createPublicIpInstanceResponse": {
    "totalRows": 1,
    "publicIpInstanceList": [
      {
        "publicIpInstanceNo": "10*****54",
        "publicIp": "101.*.*.67",
        "publicIpDescription": "test IP",
        "createDate": "2025-06-20T10:31:23+0900",
        "publicIpInstanceStatusName": "Creating",
        "publicIpInstanceStatus": {
          "code": "INIT",
          "codeName": "Under preparation"
        },
        "serverInstanceNo": "",
        "serverName": "",
        "privateIp": "",
        "publicIpInstanceOperation": {
          "code": "CREAT",
          "codeName": "CREAT OP"
        }
      }
    ],
    "requestId": "844e09f2-****-****-****-843ef9e3c542",
    "returnCode": "0",
    "returnMessage": "success"
  }
}