createServerInstances
    • PDF

    createServerInstances

    • PDF

    Article Summary

    개요

    서버 인스턴스 생성

    설명

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

    요청 파라미터

    파라미터 명필수 여부타입제약사항설명
    serverImageProductCodeConditionalStringMin:1, Max:20- 생성할 서버 이미지를 결정하기 위한 서버 이미지 상품 코드
    getServerImageProductList 액션을 통해 획득 가능
    서버 이미지 상품 코드(serverImageProductCode) or 회원 서버 이미지 번호(memberServerImageNo) 두 개의 파라미터 중 하나의 파라미터는 필수 항목
    serverProductCodeNoStringMin:1, Max:20- 생성할 서버 스펙을 결정하기 위한 서버 상품 코드
    getServerProductList 액션을 통해 획득 가능
    Default : 최소 사양으로 선택됨
    최소 사양 기준은 1. 메모리 2. CPU 3. 기본 블록 스토리지 사이즈 4. 디스크 유형(NET, LOCAL)
    memberServerImageNoConditionalString- 직접 생성한 서버 이미지로부터 서버를 생성시 필요한 값
    getMemberServerImageList 액션을 통해 획득 가능
    serverNameNoStringMin:3, Max:30- 생성할 서버 명
    Default : Ncloud가 알아서 배정
    serverDescriptionNoStringMin:1, Max:1000생성할 서버 설명
    loginKeyNameNoStringMin:3, Max:30- 공개키로 암호화 시킬 로그인키 명
    Default: 가장 최근에 생성된 로그인 키 명 사용
    isProtectServerTerminationNoBoolean생성 시 반납 보호 여부 설정 가능
    Default: false
    serverCreateCountNoIntegerMin:1, Max:20- 한번에 생성할 서버 생성 개수
    한번에 20대 이상 생성 불가
    Default: 1
    serverCreateStartNoNoInteger한번에 여러대의 서버를 생성할 경우 서버명에 일련번호가 붙음
    일련번호의 시작 번호 설정 가능
    서버 생성 갯수와 서버 생성 시작 번호의 합이 1000이 넘어갈 수 없음
    Default: 서버 생성 갯수(serverCreateCount)가 1보다 클 경우이고 해당 파라미터 값이 없는 경우 001부터 시작
    feeSystemTypeCodeNoStringMin:1, Max:5- 요금제 구분 코드
    시간 요금제(MTRAT), 정액제(FXSUM)가 존재
    Default: 시간요금제(MTRAT)
    zoneNoNoString서버가 생성될 ZONE 결정 가능
    getZoneList 액션을 통해 획득 가능
    Default: 네이버 클라우드 플랫폼에서 알아서 배정
    accessControlGroupConfigurationNoListNoListMin:0, Max:5생성 시 사용자가 생성한 ACG를 설정 가능
    getAccessControlGroupList 액션을 통해 ACG 설정 번호 획득 가능
    Default: default ACG 번호
    raidTypeNameConditionalString베어메탈 서버를 생성하기 위해서는 raidTypeName 값을 넣어야 함
    raidTypeName은 getRaidList 액션을 통해 획득 가능
    userDataNoStringMin:1, Max:21847- 사용자데이터
    서버가 최초 부팅시 실행될 데이터 스크립트 설정 가능
    userData는 스크립트 문자열을 매개변수로 전달받음
    userData값은 getServerInstanceList 액션을 통해 특정 인스턴스 조회시에만 반환됨
    userData값을 넣기전에 base64 Encoding, URL Encoding이 반드시 필요함
    base64로 Encoding된 결과를 다시 URL Encoding을 하지 않으면 signature invalid 에러가 발생
    사용자데이터(userData)와 초기화스크립트번호(initScriptNo) 두 개의 파라미터를 같이 전달하면, 초기화 스크립트만 실행됨
    스크립트 문자열을 직접 수행시키는 것 외에 스크립트가 저장된 파일경로를 매개변수로 받을 수도 있음
    ex) file://directory1/directory2/*.sh
    ex) https://{OBJECT_STORAGE_URL}/.sh
    initScriptNoNoString- 초기화스크립트번호
    서버가 최초 부팅시 사용자가 설정한 초기화 스크립트를 실행함
    초기화 스크립트의 초기화스크립트번호를 매개변수로 전달
    사용자데이터(userData)와 초기화스크립트번호(initScriptNo) 두 개의 파라미터를 같이 전달하면, 초기화 스크립트만 실행됨
    initScriptNo는 getInitScriptList 액션을 통해 획득 가능
    instanceTagList.tagKeyNoString생성할 인스턴스 태그 리스트 (태그 키)
    instanceTagList.tagValueNoString생성할 인스턴스 태그 리스트 (태그 값)
    isVaccineInstallNoBoolean백신설치유무 설정 가능 (베어메탈 윈도우서버 한정) 기본값은 true
    blockDevicePartitionList.N.mountPointNoString"/" (root) 경로로 시작하는 마운트 포인트를 입력함
    첫 번째 마운트 포인트는 반드시 "/" (root) 파티션이어야 함
    "/" (root) 하위 명칭은 소문자와 숫자만 허용되며, 소문자로 시작해야 함
    OS 종류에 따라서 /root, /bin, /dev 등의 특정 키워드는 사용 불가능 할 수 있음
    - 마운트 포인트
    Bare Metal 서버를 생성하는 경우에 파티션 지정 가능
    서버 스펙에 따라서 파티션 기능이 지원되지 않을 수 있음
    blockDevicePartitionList.N.partitionSizeNoStringMin : 50 GiB- 파티션 사이즈
    마운트 포인트의 파티션 사이즈 결정
    파티션 사이즈의 합은 서버 스펙의 전체 용량을 초과할 수 없음
    마지막 파티션의 사이즈는 나머지 용량으로 자동 할당됨

    응답 데이터 타입

    • ServerInstanceList 타입
    ServerInstanceList extends CommonResponse
    private Integer totalRows;
    private List serverInstanceList = new ArrayList();
    ServerInstance
    private String serverInstanceNo;
    private String serverName;
    private String serverDescription;
    private Integer cpuCount;
    private Long memorySize;
    private Long baseBlockStorageSize;
    private CommonCode platformType;
    private String loginKeyName;
    private Boolean isFeeChargingMonitoring;
    private String publicIp;
    private String privateIp;
    private String serverImageName;
    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 portForwardingPublicIp;
    private Integer portForwardingExternalPort;
    private Integer portForwardingInternalPort;
    private Zone zone;
    private Region region;
    private CommonCode baseBlockStorageDiskType;
    private CommonCode baseBlockStorageDiskDetailType;
    private CommonCode serverInstanceType
    private String userData;
    private List accessControlGroupList;
    private List instanceTagList;
    private List blockDevicePartitionList;

    예시

    호출

    ncloud server createServerInstances --serverImageProductCode SPSW0LINUX000046 --serverProductCode SPSVRSTAND000003 --serverName ncloud-mktest
    

    응답

    {
      "createServerInstancesResponse": {
        "requestId": "2ea6a22a-5ad0-4848-acae-308c817b4789",
        "returnCode": "0",
        "returnMessage": "success",
        "totalRows": 1,
        "serverInstanceList": [
          {
            "serverInstanceNo": "397255",
            "serverName": "ncloud-mktest",
            "serverDescription": "",
            "cpuCount": 1,
            "memorySize": 2147483648,
            "baseBlockStorageSize": 53687091200,
            "platformType": {
              "code": "LNX64",
              "codeName": "Linux 64 Bit"
            },
            "loginKeyName": "ysw",
            "isFeeChargingMonitoring": false,
            "publicIp": "",
            "privateIp": "10.113.245.112",
            "serverImageName": "centos-7.3-64",
            "serverInstanceStatus": {
              "code": "INIT",
              "codeName": "Server INIT State"
            },
            "serverInstanceOperation": {
              "code": "NULL",
              "codeName": "Server NULL OP"
            },
            "serverInstanceStatusName": "init",
            "createDate": "2018-02-23T13:55:34+0900",
            "uptime": "2018-02-23T13:55:34+0900",
            "serverImageProductCode": "SPSW0LINUX000046",
            "serverProductCode": "SPSVRSTAND000003",
            "isProtectServerTermination": false,
            "portForwardingPublicIp": "192.168.120.111",
            "zone": {
              "zoneNo": "2",
              "zoneName": "KR-1",
              "zoneCode": "KR-1",
              "zoneDescription": "KR-1 zone",
              "regionNo": "1"
            },
            "region": {
              "regionNo": "1",
              "regionCode": "KR",
              "regionName": "Korea"
            },
            "baseBlockStorageDiskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "baseBlockStroageDiskDetailType": {
              "code": "HDD",
              "codeName": "HDD"
            },
            "serverInstanceType": {
              "code": "STAND",
              "codeName": "Standard"
            },
            "userData": "",
            "initScriptNo": "",
            "accessControlGroupList": []
          }
        ]
      }
    }
    
    <?xml version="1.0" encoding="UTF-8" ?>
    <createServerInstancesResponse>
      <requestId>2ea6a22a-5ad0-4848-acae-308c817b4789</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <serverInstanceList>
        <serverInstanceNo>397255</serverInstanceNo>
        <serverName>ncloud-mktest</serverName>
        <serverDescription></serverDescription>
        <cpuCount>1</cpuCount>
        <memorySize>2147483648</memorySize>
        <baseBlockStorageSize>53687091200</baseBlockStorageSize>
        <platformType>
          <code>LNX64</code>
          <codeName>Linux 64 Bit</codeName>
        </platformType>
        <loginKeyName>ysw</loginKeyName>
        <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
        <publicIp></publicIp>
        <privateIp>10.113.245.112</privateIp>
        <serverImageName>centos-7.3-64</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-02-23T13:55:34+0900</createDate>
        <uptime>2018-02-23T13:55:34+0900</uptime>
        <serverImageProductCode>SPSW0LINUX000046</serverImageProductCode>
        <serverProductCode>SPSVRSTAND000003</serverProductCode>
        <isProtectServerTermination>false</isProtectServerTermination>
        <portForwardingPublicIp>192.168.120.111</portForwardingPublicIp>
        <zone>
          <zoneNo>2</zoneNo>
          <zoneName>KR-1</zoneName>
          <zoneCode>KR-1</zoneCode>
          <zoneDescription>KR-1 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>
        <baseBlockStroageDiskDetailType>
          <code>HDD</code>
          <codeName>HDD</codeName>
        </baseBlockStroageDiskDetailType>
        <serverInstanceType>
          <code>STAND</code>
          <codeName>Standard</codeName>
        </serverInstanceType>
        <userData></userData>
        <initScriptNo></initScriptNo>
        <accessControlGroupList/>
      </serverInstanceList>
    </createServerInstancesResponse>
    

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.