Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getCloudCacheInstanceDetail

Prev Next

VPC 환경에서 이용 가능

개요

Cloud DB for Cache 인스턴스 상세 정보를 조회합니다.

참고

Cloud DB for Cache CLI는 지원하는 DBMS 범위에 따라 두 가지 버전을 제공합니다.

  • getCloudCacheInstanceDetail CLI: Valkey, Redis DBMS 이용 가능
  • getCloudRedisInstanceDetail CLI: Redis DBMS 이용 가능

getCloudCacheInstanceDetail CLI

getCloudCacheInstanceDetail CLI의 요청, 응답 형식을 설명합니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String - 리전 코드
조회할 Cloud DB for Cache 인스턴스의 리전(Region) 결정 가능
regionCode는 getRegionList 액션을 통해 획득 가능
Default : getRegionList 조회 결과의 첫 번째 리전을 선택
cloudCacheInstanceNo Yes String - Cloud DB for Cache 인스턴스 번호
상세 정보를 조회할 Cloud DB for Cache 인스턴스 번호를 입력함
cloudCacheInstanceNo는 getCloudCacheInstanceList 액션을 통해 획득 가능
output No String - 응답 결과의 포맷 타입
Options : xml | json
Default : json

응답

응답 데이터 타입

  • CloudCacheInstanceList 타입
CloudCacheInstanceList extends CommonResponse
private Integer totalRows;
private List<CloudCacheInstance> cloudCacheInstanceList = new ArrayList<>();
CloudCacheInstance
private String cloudCacheInstanceNo;
private String cloudCacheDbmsCode;
private String cloudCacheServiceName;
private String cloudCacheInstanceStatusName;
private CommonCode cloudCacheInstanceStatus;
private CommonCode cloudCacheInstanceOperation;
private String cloudCacheImageProductCode;
private String engineVersion;
private CommonCode licence;
private Integer cloudCachePort;
private Boolean isHa;
private String cloudCacheServerPrefix;
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<CloudCacheInstance> cloudCacheServerInstanceList;
AccessControlGroupNoList
private List<String> accessControlGroupNoList = new ArrayList<>();
CloudCacheServerInstance
private String cloudCacheServerInstanceNo;
private String cloudCacheServerName;
private CommonCode cloudCacheServerRole;
private String cloudCacheServerInstanceStatusName;
private CommonCode cloudCacheServerInstanceStatus;
private CommonCode cloudCacheServerInstanceOperation;
private String cloudCacheProductCode;
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 vcache getCloudCacheInstanceDetail --regionCode KR --cloudCacheInstanceNo ****890

응답


<getCloudCacheInstanceDetailResponse>
    <requestId>95c6806d-ff8b-4a9b-9023-948e74360776</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudCacheInstanceList>
        <cloudCacheInstance>
            <cloudCacheInstanceNo>182****</cloudCacheInstanceNo>
            <cloudCacheDbmsCode>Valkey</cloudCacheDbmsCode>
            <cloudCacheServiceName>test-****</cloudCacheServiceName>
            <cloudCacheInstanceStatusName>running</cloudCacheInstanceStatusName>
            <cloudCacheInstanceStatus>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Created State</codeName>
            </cloudCacheInstanceStatus>
            <cloudCacheInstanceOperation>
                <code>NULL</code>
                <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
            </cloudCacheInstanceOperation>
            <cloudCacheImageProductCode>SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050</cloudCacheImageProductCode>
            <engineVersion>VALKEY 7.2.11</engineVersion>
            <licence>
                <code>BSD</code>
                <codeName>Berkeley Software Distribution</codeName>
            </licence>
            <cloudCachePort>6379</cloudCachePort>
            <isHa>false</isHa>
            <isBackup>true</isBackup>
            <backupTime>00:15</backupTime>
            <backupFileRetentionPeriod>7</backupFileRetentionPeriod>
            <backupSchedule>USER</backupSchedule>
            <cloudCacheServerPrefix>test-****</cloudCacheServerPrefix>
            <role>
                <code>SIMPLE</code>
                <codeName>CLOUD CACHE(VPC) Cluster Role</codeName>
            </role>
            <createDate>2021-08-04T16:57:54+0900</createDate>
            <accessControlGroupNoList>
                <accessControlGroupNo>10020</accessControlGroupNo>
            </accessControlGroupNoList>
            <masterNodeCount>1</masterNodeCount>
            <slaveNodeCount>1</slaveNodeCount>
            <configGroupNo>3**</configGroupNo>
            <configGroupName>sd***</configGroupName>
            <generationCode>G2</generationCode>
            <cloudCacheServerInstanceList>
                <cloudCacheServerInstance>
                    <cloudCacheServerInstanceNo>182****</cloudCacheServerInstanceNo>
                    <cloudCacheServerName>test-******-001-j4a</cloudCacheServerName>
                    <cloudCacheServerRole>
                        <code>A</code>
                        <codeName>Stand Alone</codeName>
                    </cloudCacheServerRole>
                    <cloudCacheServerInstanceStatusName>running</cloudCacheServerInstanceStatusName>
                    <cloudCacheServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudCacheServerInstanceStatus>
                    <cloudCacheServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudCacheServerInstanceOperation>
                    <cloudCacheProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudCacheProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>1665</vpcNo>
                    <subnetNo>1792</subnetNo>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <uptime>2021-08-04T17:10:51+0900</uptime>
                    <createDate>2021-08-04T16:57:54+0900</createDate>
                </cloudCacheServerInstance>
                <cloudCacheServerInstance>
                    <cloudCacheServerName>test-fdkxcz-002-j4a</cloudCacheServerName>
                    <cloudCacheServerRole>
                        <code>H</code>
                        <codeName>Hidden Master</codeName>
                    </cloudCacheServerRole>
                    <cloudCacheServerInstanceStatusName>running</cloudCacheServerInstanceStatusName>
                    <cloudCacheServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudCacheServerInstanceStatus>
                    <cloudCacheServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudCacheServerInstanceOperation>
                    <cloudCacheProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudCacheProductCode>
                    <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>
                </cloudCacheServerInstance>
            </cloudCacheServerInstanceList>
        </cloudCacheInstance>
    </cloudCacheInstanceList>
</getCloudCacheInstanceDetailResponse>

getCloudRedisInstanceDetail CLI

getCloudRedisInstanceDetail CLI의 요청, 응답 형식을 설명합니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String - 리전 코드
조회할 Cloud DB for Cache 인스턴스의 리전(Region) 결정 가능
regionCode는 getRegionList 액션을 통해서 획득 가능
Default : getRegionList 조회 결과의 첫 번째 리전을 선택
cloudRedisInstanceNo Yes String - Cloud DB for Cache 인스턴스 번호
상세 정보를 조회할 Cloud DB for Cache 인스턴스 번호를 입력
cloudRedisInstanceNo는 getCloudCacheInstanceList 액션을 통해서 획득 가능
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 getCloudRedisInstanceDetail --regionCode KR --cloudRedisInstanceNo ****890

응답


<getCloudRedisInstanceDetailResponse>
    <requestId>0a3318fc-7176-4e2d-8c55-925209e53115</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudRedisInstanceList>
        <cloudRedisInstance>
            <cloudRedisInstanceNo>****890</cloudRedisInstanceNo>
            <cloudRedisInstanceName>test-****</cloudRedisInstanceName>
            <cloudRedisInstanceStatusName>running</cloudRedisInstanceStatusName>
            <cloudRedisInstanceStatus>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Created State</codeName>
            </cloudRedisInstanceStatus>
            <cloudRedisInstanceOperation>
                <code>NULL</code>
                <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
            </cloudRedisInstanceOperation>
            <cloudRedisImageProductCode>SW.VDBAS.VRDS.LNX64.CNTOS.0703.REDIS.4014.B050</cloudRedisImageProductCode>
            <engineVersion>REDIS 4.0.14</engineVersion>
            <licence>
                <code>BSD</code>
                <codeName>Berkeley Software Distribution</codeName>
            </licence>
            <cloudRedisPort>6379</cloudRedisPort>
            <isHa>false</isHa>
            <isBackup>true</isBackup>
            <backupTime>00:30</backupTime>
            <generationCode>G2</generationCode>
            <backupFileRetentionPeriod>1</backupFileRetentionPeriod>
            <backupSchedule>AUTO</backupSchedule>
            <cloudRedisServerPrefix>test-****</cloudRedisServerPrefix>
            <role>
                <code>CLUSTER</code>
                <codeName>CLOUD REDIS(VPC) Cluster Role</codeName>
            </role>
            <createDate>2021-04-21T16:23:57+0900</createDate>
            <accessControlGroupNoList>
                <accessControlGroupNo>**50</accessControlGroupNo>
            </accessControlGroupNoList>
            <masterNodeCount>3</masterNodeCount>
            <slaveNodeCount>3</slaveNodeCount>
            <configGroupNo>**9</configGroupNo>
            <configGroupName>exercise</configGroupName>
            <generationCode>G2</generationCode>
            <cloudRedisServerInstanceList>
                <cloudRedisServerInstance>
                    <cloudRedisServerInstanceNo>****613</cloudRedisServerInstanceNo>
                    <cloudRedisServerName>test-****-001-001-ehs</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>M</code>
                        <codeName>Master</codeName>
                    </cloudRedisServerRole>
                    <cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
                    <cloudRedisServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudRedisServerInstanceStatus>
                    <cloudRedisServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudRedisServerInstanceOperation>
                    <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****65</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <uptime>2021-04-21T16:37:13+0900</uptime>
                    <createDate>2021-04-21T16:23:57+0900</createDate>
                    <slotName>0-5460</slotName>
                </cloudRedisServerInstance>
                <cloudRedisServerInstance>
                    <cloudRedisServerInstanceNo>****616</cloudRedisServerInstanceNo>
                    <cloudRedisServerName>test-****-002-001-eht</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>M</code>
                        <codeName>Master</codeName>
                    </cloudRedisServerRole>
                    <cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
                    <cloudRedisServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudRedisServerInstanceStatus>
                    <cloudRedisServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudRedisServerInstanceOperation>
                    <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****65</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <uptime>2021-04-21T16:37:26+0900</uptime>
                    <createDate>2021-04-21T16:23:57+0900</createDate>
                    <slotName>5461-10922</slotName>
                </cloudRedisServerInstance>
                <cloudRedisServerInstance>
                    <cloudRedisServerInstanceNo>****619</cloudRedisServerInstanceNo>
                    <cloudRedisServerName>test-****-003-001-ehu</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>M</code>
                        <codeName>Master</codeName>
                    </cloudRedisServerRole>
                    <cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
                    <cloudRedisServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudRedisServerInstanceStatus>
                    <cloudRedisServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudRedisServerInstanceOperation>
                    <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****65</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <uptime>2021-04-21T16:37:16+0900</uptime>
                    <createDate>2021-04-21T16:23:57+0900</createDate>
                    <slotName>10923-16383</slotName>
                </cloudRedisServerInstance>
                <cloudRedisServerInstance>
                    <cloudRedisServerInstanceNo>****622</cloudRedisServerInstanceNo>
                    <cloudRedisServerName>test-****-001-002-ehv</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>S</code>
                        <codeName>Slave</codeName>
                    </cloudRedisServerRole>
                    <cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
                    <cloudRedisServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudRedisServerInstanceStatus>
                    <cloudRedisServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudRedisServerInstanceOperation>
                    <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****65</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <uptime>2021-04-21T16:37:56+0900</uptime>
                    <createDate>2021-04-21T16:23:57+0900</createDate>
                    <slotName>0-5460</slotName>
                </cloudRedisServerInstance>
                <cloudRedisServerInstance>
                    <cloudRedisServerInstanceNo>****625</cloudRedisServerInstanceNo>
                    <cloudRedisServerName>test-****-002-002-ehw</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>S</code>
                        <codeName>Slave</codeName>
                    </cloudRedisServerRole>
                    <cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
                    <cloudRedisServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudRedisServerInstanceStatus>
                    <cloudRedisServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudRedisServerInstanceOperation>
                    <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****65</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <uptime>2021-04-21T16:37:53+0900</uptime>
                    <createDate>2021-04-21T16:23:57+0900</createDate>
                    <slotName>5461-10922</slotName>
                </cloudRedisServerInstance>
                <cloudRedisServerInstance>
                    <cloudRedisServerInstanceNo>****628</cloudRedisServerInstanceNo>
                    <cloudRedisServerName>test-****-003-002-ehx</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>S</code>
                        <codeName>Slave</codeName>
                    </cloudRedisServerRole>
                    <cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
                    <cloudRedisServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudRedisServerInstanceStatus>
                    <cloudRedisServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudRedisServerInstanceOperation>
                    <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****65</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <uptime>2021-04-21T16:38:13+0900</uptime>
                    <createDate>2021-04-21T16:23:57+0900</createDate>
                    <slotName>10923-16383</slotName>
                </cloudRedisServerInstance>
            </cloudRedisServerInstanceList>
        </cloudRedisInstance>
    </cloudRedisInstanceList>
</getCloudRedisInstanceDetailResponse>