createServerInstances

Prev Next

개요

서버 인스턴스(VM)를 생성합니다.

요청

요청 파라미터

파라미터 명 필수 여부 타입 제약사항 설명
serverImageProductCode Conditional String Min:1, Max:20 - 생성할 서버 이미지를 결정하기 위한 서버이미지 상품코드
서버 이미지 상품 코드(serverImageProductCode) or 회원 서버 이미지 번호(memberServerImageNo) 두 개의 파라미터 중 하나의 파라미터는 필수 항목
serverImageProductCodes는 getServerImageProductList 액션을 통해 획득 가능
memberServerImageNo Conditional String - 회원 서버이미지 번호
직접 생성한 서버 이미지로부터 서버를 생성 시 필요한 값
서버 이미지 상품 코드(serverImageProductCode) or 회원 서버 이미지 번호(memberServerImageNo) 두 개의 파라미터 중 하나의 파라미터는 필수 항목
memberServerImageNo는 getMemberServerImageList 액션을 통해 획득 가능
serverProductCode No String Min:1, Max:20 - 생성할 서버스펙을 결정하기 위한 서버스펙 상품코드
serverProductCode는 getServerProductList 액션을 통해 획득 가능
Default : 최소 사양으로 선택되며 최소사양 기준은
1. 메모리 2. CPU 3. 기본 블록 스토리지 사이즈 4. 디스크 유형(NET, LOCAL) 순서
serverName No String Min:3, Max:30 - 생성할 서버명
Default : NAVER Cloud Platform 가 자동으로 부여
serverDescription No String Min:1, Max:1000 생성할 서버에 대한 설명
loginKeyName No String Min:3, Max:30 - 공개키로 암호화 시킬 로그인키명
Default : 가장 최근에 생성된 로그인키명 사용
isProtectServerTermination No Boolean - 반납보호여부
생성시 반납 보호 여부 설정 가능
Options : true | false
Default : false
serverCreateCount No Integer Min:1, Max:20 - 서버생성갯수
한번에 생성할 서버 생성 개수이며 최대 20대까지 가능
Default : 1
serverCreateStartNo No Integer - 서버생성 시작번호
한번에 여러대의 서버를 생성할 경우 서버명에 일련번호가 붙으며 일련번호의 시작번호 설정 가능
서버 생성 갯수와 서버 생성 시작 번호의 합이 1000이 넘어갈 수 없음
default : 서버 생성 갯수(serverCreateCount)가 1보다 클 경우이고 해당 파라미터 값이 없는 경우 001 부터 시작
feeSystemTypeCode No String Min:1, Max:5 요금제 구분 코드이며 시간요금제(MTRAT), 정액제(FXSUM)가 존재
Options : MTRAT | FXSUM
default : MTRAT
zoneNo No String 서버가 생성될 ZONE 결정 가능
zoneNo는 getZoneList 액션을 통해 획득 가능
Default : 네이버 클라우드 플랫폼에서 배정
accessControlGroupConfigurationNoList.N No String Min:0, Max:5 - ACG설정번호 리스트
생성시 사용자가 생성한 접근제어그룹 설정 가능
accessControlGroupConfigurationNo는 getAccessControlGroupList 액션을 통해 획득 가능
Default : default ACG
ex) accessControlGroupConfigurationNoList.1=39995
userData No String Min:1, Max:21847 - 사용자 데이터
서버가 최초 부팅시 실행될 데이터 스크립트 설정 가능
userData는 스크립트 문자열을 매개변수로 전달 받음
userData값은 getServerInstanceList 액션을 통해 특정 인스턴스 조회시에만 반환됨
userData값을 넣기전에 base64 Encoding, URL Encoding이 반드시 필요
base64로 Encoding된 결과를 다시 URL Encoding을 하지 않으면 signature invalid 에러 발생
사용자데이터(userData)와 초기화 스크립트번호(initScriptNo) 두 개의 파라미터를 같이 전달하면, 초기화 스크립트만 실행됨
initScriptNo No String - 초기화 스크립트번호
서버가 최초 부팅시 사용자가 설정한 초기화 스크립트를 실행함
초기화 스크립트의 초기화스크립트번호를 매개변수로 전달
사용자데이터(userData)와 초기화 스크립트번호(initScriptNo) 두 개의 파라미터를 같이 전달하면, 초기화 스크립트만 실행됨
initScriptNo는 getInitScriptList 액션을 통해 얻을 수 있음
raidTypeName Conditional String - RAID 구분이름
베어메탈 서버를 생성하기 위해서는 raidTypeName 값을 넣어야 함
raidTypeName은 getRaidList 액션을 통해 얻을 수 있음
instanceTagList.N.tagKey No String 생성할 인스턴스의 태그 키 설정 가능
instanceTagList.1.tagKey=sugar
instanceTagList.N.tagValue No String - 생성할 인스턴스의 태그 값
instanceTagList.1.tagValue=salt
isVaccineInstall No Boolean 백신설치 유무 설정 가능 (베어메탈 윈도우서버 한정)
기본값: true
blockDevicePartitionList.N.mountPoint No String "/" (root) 경로로 시작하는 마운트 포인트 입력
첫 번째 마운트 포인트는 반드시 "/" (root) 파티션
"/" (root) 하위 명칭은 소문자와 숫자만 허용되며, 소문자로 시작
OS 종류에 따라서 /root, /bin, /dev 등의 특정 키워드는 사용 불가능
- 마운트 포인트
Bare Metal 서버를 생성하는 경우에는 파티션 지정.
서버 스펙에 따라서 파티션 기능이 지원되지 않을 수 있음
blockDevicePartitionList.N.partitionSize No String Min : 50 GiB - 파티션 사이즈
마운트 포인트의 파티션 사이즈를 결정
파티션 사이즈의 합은 서버 스펙의 전체 용량을 초과할 수 없음
마지막 파티션의 사이즈는 나머지 용량으로 자동 할당됨
responseFormatType No String - 응답 결과의 포맷 타입
Options : xml | json
Default : xml

응답

응답 바디

예시

요청 예시

GET {SERVER_API_URL}/createServerInstances
?serverImageProductCode=SPSW0LINUX000032
&serverProductCode=SPSVRSTAND000004

응답 예시

<createServerInstancesResponse>
  <requestId>3c48425e-ace0-4556-a793-33e91029c06c</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <serverInstanceList>
    <serverInstance>
      <serverInstanceNo>1088217</serverInstanceNo>
      <serverName>s167545541a3</serverName>
      <serverDescription></serverDescription>
      <cpuCount>2</cpuCount>
      <memorySize>4294967296</memorySize>
      <baseBlockStorageSize>53687091200</baseBlockStorageSize>
      <platformType>
        <code>LNX32</code>
        <codeName>Linux 32 Bit</codeName>
      </platformType>
      <loginKeyName>test-key</loginKeyName>
      <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
      <publicIp></publicIp>
      <privateIp>10.41.83.168</privateIp>
      <serverImageName>centos-6.3-32</serverImageName>
      <serverInstanceStatus>
        <code>INIT</code>
        <codeName>Server init state</codeName>
      </serverInstanceStatus>
      <serverInstanceOperation>
        <code>NULL</code>
        <codeName>Server NULL OP</codeName>
      </serverInstanceOperation>
      <serverInstanceStatusName>init</serverInstanceStatusName>
      <createDate>2018-11-27T17:42:13+0900</createDate>
      <uptime>2018-11-27T17:42:13+0900</uptime>
      <serverImageProductCode>SPSW0LINUX000032</serverImageProductCode>
      <serverProductCode>SPSVRSTAND000004</serverProductCode>
      <isProtectServerTermination>false</isProtectServerTermination>
      <portForwardingPublicIp>106.10.51.90</portForwardingPublicIp>
      <zone>
        <zoneNo>3</zoneNo>
        <zoneName>KR-2</zoneName>
        <zoneCode>KR-2</zoneCode>
        <zoneDescription>평촌 zone</zoneDescription>
        <regionNo>1</regionNo>
      </zone>
      <region>
        <regionNo>1</regionNo>
        <regionCode>KR</regionCode>
        <regionName>Korea</regionName>
      </region>
      <baseBlockStorageDiskType>
        <code>NET</code>
        <codeName>Network Storage</codeName>
      </baseBlockStorageDiskType>
      <baseBlockStorageDiskDetailType>
        <code>HDD</code>
        <codeName>HDD</codeName>
      </baseBlockStorageDiskDetailType>
      <serverInstanceType>
        <code>STAND</code>
        <codeName>Standard</codeName>
      </serverInstanceType>
      <userData></userData>
      <initScriptNo></initScriptNo>
      <accessControlGroupList/>
      <instanceTagList/>
    </serverInstance>
  </serverInstanceList>
</createServerInstancesResponse>

에러 코드

아래 에러 코드는 이 액션(Action)에서 특징적으로 발생하는 에러입니다. 공통적으로 발생하는 에러에 대한 상세한 설명은 NAVER Cloud Platform API를 참고해주세요

HTTP Response Code 리턴 코드 리턴 메시지
400 10300 Instance name is already in use. please use other name.
400 10702 You are not allowed to create server of spec with selected image.
400 10706 The starting number or the number of servers cannot be entered because the combination makes more than 3 digits.
400 10707 More than 20 servers are unable to be created at a time.
400 10710 Not found login key.
400 10711 Invalid fee system.
400 10712 Not found product. Please check your input product.
400 10714 Paid license software products can be purchased for a fee only server.
400 10715 MSSQL software product not be able to create a contract of hourly rate.
400 10716 Cannot create VDS(Virtual Dedicated Server) with specific price plan.
400 10724 The server image contains additional storage so you can't create a server. Additional storage is not available for Micro Server.
400 10800 This name is already in use.
400 23003 Since entire return of previous server has yet to be completed, new server cannot be created. Please try again after completing returning process.
400 23006 You cannot request for server return and creation at the same time. Please make one request at a time.
400 24110 The input parameter server image number is invalid.
400 24111 The input parameter zone number is invalid.
400 24124 The input parameter ACG configuration number is invalid.
400 24300 The length constraints of the parameter description (memo) were violated. The minimum length is 0 byte, the maximum, 1,000 bytes.
400 24301 The length constraints of the parameter userData were violated. The minimum length is 0 byte, the maximum, 21,847 bytes.
400 24302 UserData is not base64-encoded.
400 25038 Currently the server image is not existing normally.
400 25040 Unable to create server since server image is being manipulated or the server is being created from.