changeServerInstanceName

Prev Next

Available in VPC

Overview

Change the server instance name. The host name won't be changed.

Request

Request parameters

Parameter name Required Type Restrictions Description
regionCode No String - Region code
regionCode can be obtained through the getRegionList action.
Default: Select the first Region of the getRegionList search result.
serverInstanceNo Yes String - Server instance number
serverInstanceNo can be obtained through the getServerInstanceList action.
serverName Yes String - Name of server to change to
Enter 3 to 30 characters using a combination of lowercase English letters, numbers, and the special character "-".
The string must start with a lowercase English letter and end with a lowercase English letter or a number.
output No String Response result's format type
  • Options: xml | json
  • Default: json

Response

Response data type

  • ServerInstanceList type
ServerInstanceList extends CommonResponse
private Integer totalRows;
private List<ServerInstance> serverInstanceList = new ArrayList<>();
ServerInstance
private String serverInstanceNo;
private String serverName;
private String serverDescription;
private Integer cpuCount;
private Long memorySize;
private CommonCode platformType;
private String loginKeyName;
private String publicIpInstanceNo;
private String publicIp;
private CommonCode serverInstanceStatus;
private CommonCode serverInstanceOperation;
private String serverInstanceStatusName;
private Date createDate;
private Date uptime;
private String serverImageProductCode;
private String serverProductCode;
private Boolean isProtectServerTermination;
private String zoneCode;
private String regionCode;
private String vpcNo;
private String subnetNo;
private NetworkInterfaceNoList networkInterfaceNoList;
private String initScriptNo;
private CommonCode serverInstanceType;
private CommonCode baseBlockStorageDiskType;
private CommonCode baseBlockStorageDiskDetailType;
private String placementGroupNo;
private String placementGroupName;
private String memberServerImageInstanceNo;

Examples

Request example

ncloud vserver changeServerInstanceName --regionCode KR --serverInstanceNo ***4299 --serverName ncp-test-****

Response example

{
  "changeServerInstanceNameResponse": {
    "totalRows": 1,
    "serverInstanceList": [
      {
        "serverInstanceNo": "*****8773",
        "serverName": "test-***",
        "cpuCount": 2,
        "memorySize": 4294967296,
        "platformType": {
          "code": "UBD64",
          "codeName": "Ubuntu Desktop 64 Bit"
        },
        "loginKeyName": "test-***",
        "publicIpInstanceNo": "*****8824",
        "publicIp": "211.188.***.***",
        "serverInstanceStatus": {
          "code": "RUN",
          "codeName": "Server RUN status"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "running",
        "createDate": "2025-06-11T17:00:14+0900",
        "uptime": "2025-06-19T16:49:07+0900",
        "serverImageProductCode": "SW.VSVR.OS.LNX64.UBNTU.SVR24.G003",
        "serverProductCode": "SVR.VSVR.CPU.C002.M004.G003",
        "isProtectServerTermination": true,
        "zoneCode": "KR-1",
        "regionCode": "KR",
        "vpcNo": "***75",
        "subnetNo": "****36",
        "networkInterfaceNoList": [
          "*****30"
        ],
        "serverInstanceType": {
          "code": "CPU",
          "codeName": "CPU-Intensive"
        },
        "baseBlockStorageDiskType": {
          "code": "NET",
          "codeName": "Network storage"
        },
        "baseBlockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "serverImageNo": "104630229",
        "serverSpecCode": "ci2-g3"
      }
    ],
    "requestId": "5efaee89-c118-4797-b759-b99bb117f245",
    "returnCode": "0",
    "returnMessage": "success"
  }
}