createCloudRedisInstance

Prev Next

VPC 환경에서 이용 가능

개요

Cloud DB for Redis 인스턴스를 생성합니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String - 리전 코드
Cloud DB for Redis 인스턴스가 생성될 리전(Region) 결정 가능
regionCode는 getRegionList 액션을 통해 획득 가능
Default: getRegionList 조회 결과의 첫 번째 리전을 선택
vpcNo Yes String - VPC 번호
Cloud DB for Redis 인스턴스가 생성될 VPC를 결정함
vpcNo는 getVpcList 액션을 통해 획득 가능
cloudRedisImageProductCode No String - Cloud Redis 이미지 상품 코드
cloudRedisImageProductCode는 getCloudRedisImageProductList 액션의 productCode로 획득 가능
입력하지 않을 경우 Default값으로 생성됨
cloudRedisProductCode No String - Cloud Redis 상품 코드
생성할 Cloud DB for Redis 인스턴스의 서버 스펙 결정 가능
cloudRedisProductCode는 getCloudRedisProductList 액션의 productCode로 획득 가능
Default:최소 사양으로 선택되며 최소 사양의 기준은
1. 메모리 2. CPU
shardCount No Integer Min:3, Max: 10 - 샤드 수
생성할 샤드 수이며 최소 3개이며 최대 10개
Master Node의 개수
CloudRedisModeCode가 CLUSTER일 때에만 입력하며 CloudRedisModeCode가 SIMPLE이면 shardCount가 입력되어도 무시됨
공공 환경에서는 이용이 불가능
default: 3
shardCopyCount No Integer Min: 0, Max: 4 - 샤드 당 복제본
Redis Cluster는 Master node와 Slave node로 구성되어 있음
HA를 위해서는 Slave node가 필요함
복제본 추가 시 모든 Master 노드에 각각 1개씩 Slave node가 할당됨
(ex) 샤드 수 3, 샤드 당 복제본 1 -> Master node: 3대, Slave node: 3대
샤드 당 복제본은 0~4까지 입력 가능
만약 샤드 당 복제본을 0으로 설정한다면 고가용성 지원이 되지 않음
CloudRedisModeCode가 CLUSTER일때에만 입력함
CloudRedisModeCode가 SIMPLE이면 shardCopyCount가 입력되어도 무시됨
공공 환경에서는 이용이 불가능
default: 0
isHa No Boolean - 고가용성 여부
Cloud DB for Redis는 Standby 마스터를 이용한 자동 장애 복구를 지원함
고가용성 지원 시 추가 요금이 발생하며 자동으로 백업이 설정됨
Default: false
configGroupNo Yes String - ConfigGroup 번호
Config Group을 제공하며 하나의 클러스터 군은 모두 같은 config를 사용하게 됨
Config Group이 없을 시 새로 생성해야 하며 생성 후에도 온라인으로 변경 가능
cloudRedisUserName Yes String 영문자, 숫자, 언더바(_), 하이픈(-) 문자만 허용하며 반드시 영어로 시작해야 함 - 접근 유저명
DB 관리자 용도로 사용할 유저명 입력 바람
cloudRedisUserPassword Yes String 영어, 숫자, 특수문자 3개 항목에 대해 1자 이상 포함되어야 함 ` & + \ " ' / ^ > 스페이스는 패스워드로 사용할 수 없습니다.
Min: 9
Max: 20		 - 접근 패스워드
DB 관리자 용도로 사용할 유저의 패스워드 입력 바람
isBackup No Boolean - 백업 여부
고가용성 여부(isHa)가 True이면 백업 설정 여부도 True로 고정됨
default : false
backupFileRetentionPeriod No Integer Min: 1, Max: 7 - 백업 파일 보관 기간
백업은 매일 수행되며, 백업 파일은 별도의 백업 스토리지에 저장됨 요금은 사용하는 공간만큼 과금됨
Default: 1(1일)
backupTime Conditional String - 백업 시간
백업이 수행되는 시간을 설정함
백업 여부(isBackup)가 True이고, 자동 백업 여부(isAutomaticBackup)가 False이면 반드시 입력함
예제
01:15
isAutomaticBackup No Boolean - 백업 시간 자동 여부
자동으로 백업 시간을 설정할지에 대한 여부를 선택함
자동 백업 여부(isAutomaticBackup)가 True이면 backupTime이 입력되어도 무시되고 자동 설정됨
cloudRedisServiceName Yes String 영어, 숫자, -의 특수문자, 한글만 입력 가능
Min: 3, Max: 15		 - Cloud Redis 서비스 이름
Redis Server의 그룹명 입력 (예: 네이버-HOME)
최소 3자, 최대 15자까지 입력 가능
Redis 서비스 이름은 중복으로 사용할 수 없음
cloudRedisServerNamePrefix Yes String 영문자(소문자), 숫자, 하이픈(-)으로만 구성되어야 함
첫 글자는 영문자여야 하고 마지막 글자는 영문자 또는 숫자여야 함
Min: 3, Max: 15		 - Cloud Redis 서버 이름
Redis Server의 이름 Prefix를 입력함
최소 3자리에서 최대 15자리까지 입력 가능
Redis Server 이름에 3자리 숫자가 자동으로 채번되어 생성됨
Redis Server이름은 중복으로 사용할 수 없음
cloudRedisPort No Integer 6379
or
Min: 10000, Max: 20000		 - Cloud Redis 포트
Redis 접근을 위한 TCP 포트 번호 입력 바람
Default: 6379
subnetNo Yes String - Subnet 번호
생성할 Cloud Redis 인스턴스의 Subnet을 결정함
subnetNo는 getSubnetList 액션을 통해 획득 가능
Public 도메인은 Public Subnet에 생성된 DB 서버에서만 이용 신청 가능
Cloud DB for Redis 인스턴스 생성 이후에 Subnet 이전은 불가능
engineVersionCode No String - Engine Version
getCloudRedisImageProductList는 getCloudRedisImageProductList 액션을 통해서 획득 가능
입력하지 않을 경우 현재 제공 중인 최신 버전으로 생성
cloudRedisModeCode Yes String - Cloud DB for Redis 구성
Cloud DB for Redis의 구성을 결정함
CLUSTER 설정 사용시, isHa 설정을 무시함
Options: SIMPLE
output No String - 응답 결과의 포맷 타입
Options: xml | json
Default: json

응답

응답 데이터 타입

  • CloudRedisInstanceList 타입
CloudRedisInstanceList extends CommonResponse
private Integer totalRows;
private List<CloudRedisInstance> cloudRedisInstanceList = new ArrayList<>();
CloudRedisInstance
private String cloudRedisInstanceNo;
private String cloudRedisServiceName;
private String cloudRedisInstanceStatusName;
private CommonCode cloudRedisInstanceStatus;
private CommonCode cloudRedisInstanceOperation;
private String cloudRedisImageProductCode;
private String engineVersion;
private CommonCode licence;
private Integer cloudRedisPort;
private Boolean isHa;
private String cloudRedisServerPrefix;
private Boolean isBackup;
private Integer backupFileRetentionPeriod;
private String backupTime;
private String backupSchedule;
private String generationCode;
private Date createDate;
private Integer shardCount;
private Integer shardCopyCount;
private AccessControlGroupNoList accessControlGroupNoList;
private String configGroupNo;
private String configGroupName;
private CommonCode role;
private List<CloudRedisInstance> cloudRedisServerInstanceList;
AccessControlGroupNoList
private List<String> accessControlGroupNoList = new ArrayList<>();
CloudRedisServerInstance
private String cloudRedisServerInstanceNo;
private String cloudRedisServerName;
private CommonCode cloudRedisServerRole;
private String cloudRedisServerInstanceStatusName;
private CommonCode cloudRedisServerInstanceStatus;
private CommonCode cloudRedisServerInstanceOperation;
private String cloudRedisProductCode;
private String regionCode;
private String zoneCode;
private String vpcNo;
private String subnetNo;
private String privateDomain;
private Integer cpuCount;
private Long memorySize;
private Long osMemorySize;
private Date uptime;
private Date createDate;
private String slotName;

예시

호출

ncloud vredis createCloudRedisInstance --regionCode KR --vpcNo ****83 --cloudRedisImageProductCode SW.VDBAS.VRDS.LNX64.CNTOS.0703.REDIS.4014.B050 --cloudRedisProductCode SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002 --isHa true --configGroupNo **9 --isBackup true --backupFileRetentionPeriod 7 --backupTime 00:15 --isAutomaticBackup true --cloudRedisServiceName test-**** --cloudRedisServerNamePrefix test-**** --cloudRedisUserName test --cloudRedisUserPassword PassW0rd!@ --cloudRedisPort 6379 --subnetNo ****91 --cloudRedisModeCode SIMPLE

응답


<createCloudRedisInstanceResponse>
    <requestId>74429b9f-2ed5-4dc8-8bfa-4e958fcd7d16</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudRedisInstanceList>
        <cloudRedisInstance>
            <cloudRedisInstanceNo>182****</cloudRedisInstanceNo>
            <cloudRedisServiceName>test-****</cloudRedisServiceName>
            <cloudRedisInstanceStatusName>creating</cloudRedisInstanceStatusName>
            <cloudRedisInstanceStatus>
                <code>INIT</code>
                <codeName>CLOUD DATABASE(VPC) Init State</codeName>
            </cloudRedisInstanceStatus>
            <cloudRedisInstanceOperation>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Creat OP</codeName>
            </cloudRedisInstanceOperation>
            <cloudRedisImageProductCode>SW.VDBAS.VRDS.LNX64.CNTOS.0703.REDIS.4014.B050</cloudRedisImageProductCode>
            <engineVersion>REDIS 6.2.4</engineVersion>
            <licence>
                <code>BSD</code>
                <codeName>Berkeley Software Distribution</codeName>
            </licence>
            <cloudRedisPort>6379</cloudRedisPort>
            <isHa>false</isHa>
            <cloudRedisServerPrefix>test-****</cloudRedisServerPrefix>
            <role>
                <code>SIMPLE</code>
                <codeName>CLOUD REDIS(VPC) Cluster Role</codeName>
            </role>
            <createDate>2021-08-04T16:57:54+0900</createDate>
            <accessControlGroupNoList/>
            <masterNodeCount>1</masterNodeCount>
            <slaveNodeCount>1</slaveNodeCount>
            <configGroupNo>3**</configGroupNo>
            <configGroupName>sd***</configGroupName>
            <generationCode>G2</generationCode>
            <cloudRedisServerInstanceList>
                <cloudRedisServerInstance>
                    <cloudRedisServerName>test-fdkxcz-001-j4a</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>A</code>
                        <codeName>Stand Alone</codeName>
                    </cloudRedisServerRole>
                    <cloudRedisServerInstanceStatusName>creating</cloudRedisServerInstanceStatusName>
                    <cloudRedisServerInstanceStatus>
                        <code>PEND</code>
                        <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                    </cloudRedisServerInstanceStatus>
                    <cloudRedisServerInstanceOperation>
                        <code>CREAT</code>
                        <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                    </cloudRedisServerInstanceOperation>
                    <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>1665</vpcNo>
                    <subnetNo>1792</subnetNo>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <createDate>2021-08-04T16:57:54+0900</createDate>
                </cloudRedisServerInstance>
                <cloudRedisServerInstance>
                    <cloudRedisServerName>test-fdkxcz-002-j4a</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>H</code>
                        <codeName>Hidden Master</codeName>
                    </cloudRedisServerRole>
                    <cloudRedisServerInstanceStatusName>creating</cloudRedisServerInstanceStatusName>
                    <cloudRedisServerInstanceStatus>
                        <code>PEND</code>
                        <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                    </cloudRedisServerInstanceStatus>
                    <cloudRedisServerInstanceOperation>
                        <code>CREAT</code>
                        <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                    </cloudRedisServerInstanceOperation>
                    <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>1665</vpcNo>
                    <subnetNo>1792</subnetNo>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <createDate>2021-08-04T16:57:54+0900</createDate>
                </cloudRedisServerInstance>
            </cloudRedisServerInstanceList>
        </cloudRedisInstance>
    </cloudRedisInstanceList>
</createCloudRedisInstanceResponse>