getCloudCacheInstanceList

VPC 환경에서 이용 가능

개요

Cloud DB for Cache 인스턴스 리스트를 조회합니다.

참고

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

getCloudCacheInstanceList CLI: Valkey, Redis DBMS 이용 가능
getCloudRedisInstanceList CLI: Redis DBMS 이용 가능

getCloudCacheInstanceList CLI

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

요청

요청 파라미터

파라미터명	필수 여부	타입	제약 사항	설명
regionCode	No	String		- 리전 코드 Cloud DB for Cache 인스턴스 리스트가 조회될 리전(Region) 결정 가능 regionCode는 getRegionList 액션을 통해 획득 가능 Default : getRegionList 조회 결과의 첫 번째 리전을 선택
zoneCode	No	String		- ZONE 코드 Cloud DB for Cache 인스턴스 리스트가 조회될 Zone 결정 가능 zoneCode는 getZoneList 액션을 통해 획득 가능
vpcNo	No	String		- VPC 번호 Cloud DB for Cache 인스턴스 리스트가 조회될 VPC 결정 가능 vpcNo는 getVpcList 액션을 통해 획득 가능
subnetNo	No	String		- Subnet 번호 Cloud DB for Cache 인스턴스 리스트가 조회될 Subnet 결정 가능 SubnetNo는 getSubnetList 액션을 통해 획득 가능
cloudCacheServiceName	No	String		- Cloud DB for Cache 서비스 이름 Cloud DB for Cache 서비스 이름으로 필터링하여 검색 가능 cloudCacheServiceName은 getCloudCacheInstanceList 액션을 통해 획득 가능
cloudCacheInstanceNoList	No	List<String>		- Cloud DB for Cache 인스턴스 번호 리스트 Cloud DB for Cache 인스턴스 번호로 필터링하여 검색 가능 cloudCacheInstanceNoList는 getCloudCacheInstanceList 액션을 통해 획득 가능 ex) cloudCacheInstanceNoList 1234 2345
cloudCacheServerName	No	String		- Cloud DB for Cache 서버 이름 Cloud DB for Cache 서버 이름으로 필터링하여 검색 가능 cloudCacheServerName은 getCloudCacheInstanceList 액션을 통해 획득 가능
cloudCacheServerInstanceNoList	No	List<String>		- Cloud DB for Cache 서버 인스턴스 번호 리스트 Cloud DB for Cache 서버 인스턴스 번호로 필터링하여 검색 가능 cloudCacheServerInstanceNoList getCloudCacheInstanceList 액션을 통해 획득 가능 ex) cloudCacheServerInstanceNoList 1234 2345
generationCode	No	String		- 서버 세대 코드 options: G2 \| G3
pageNo	No	Integer	Min: 0	- 페이징된 결과의 페이지 번호 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageSize	Conditional	Integer	Min: 1	- 페이징 시 보여줄 각 페이지 사이즈 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능 pageNo 입력시 반드시 입력 바람
cloudCacheDbmsCode	No	String		Cloud DB for Cache 인스턴스의 DBMS 코드 Options: Redis \| Valkey
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 getCloudCacheInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ****65  --subnetNo ****92 --cloudCacheServiceName test-**** --cloudCacheInstanceNoList ****890 --cloudCacheServerName test--**** --cloudCacheServerInstanceNoList ****518 --pageNo 0 --pageSize 10 --generationCode G2 --cloudCacheDbmsCode Redis

응답 예시


<getCloudCacheInstanceListResponse>
    <requestId>61afef97-c2fa-492e-98ad-a04125d46f9c</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudCacheInstanceList>
        <cloudCacheInstance>
            <cloudCacheInstanceNo>182****</cloudCacheInstanceNo>
            <cloudCacheDbmsCode>Redis</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>
            <isHa>false</isHa>
            <role>
                <code>SIMPLE</code>
                <codeName>CLOUD CACHE(VPC) Cluster Role</codeName>
            </role>
            <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>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>1665</vpcNo>
                    <subnetNo>1792</subnetNo>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </cloudCacheServerInstance>
            </cloudCacheServerInstanceList>
        </cloudCacheInstance>
    </cloudCacheInstanceList>
</getCloudCacheInstanceListResponse>

getCloudRedisInstanceList CLI

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

요청

요청 파라미터

파라미터명	필수 여부	타입	제약 사항	설명
regionCode	No	String		- 리전 코드 Cloud DB for Cache 인스턴스 리스트가 조회될 리전(Region) 결정 가능 regionCode는 getRegionList 액션을 통해 획득 가능 Default : getRegionList 조회 결과의 첫 번째 리전을 선택
zoneCode	No	String		- ZONE 코드 Cloud DB for Cache 인스턴스 리스트가 조회될 Zone 결정 가능 zoneCode는 getZoneList 액션을 통해 획득 가능
vpcNo	No	String		- VPC 번호 Cloud DB for Cache 인스턴스 리스트가 조회될 VPC 결정 가능 vpcNo는 getVpcList 액션을 통해 획득 가능
subnetNo	No	String		- Subnet 번호 Cloud DB for Cache 인스턴스 리스트가 조회될 Subnet 결정 가능 SubnetNo는 getSubnetList 액션을 통해 획득 가능
cloudRedisServiceName	No	String		- Cloud DB for Cache 서비스 이름 Cloud DB for Cache 서비스 이름으로 필터링하여 검색 가능 cloudRedisServiceName은 getCloudCacheInstanceList 액션을 통해 획득 가능
cloudRedisInstanceNoList	No	List<String>		- Cloud DB for Cache 인스턴스 번호 리스트 Cloud DB for Cache 인스턴스 번호로 필터링하여 검색 가능 cloudRedisInstanceNoList는 getCloudCacheInstanceList 액션을 통해 획득 가능 ex) cloudRedisInstanceNoList 1234 2345
cloudRedisServerName	No	String		- Cloud DB for Cache 서버 이름 Cloud DB for Cache 서버 이름으로 필터링하여 검색 가능 cloudRedisServerName은 getCloudCacheInstanceList 액션을 통해 획득 가능
cloudRedisServerInstanceNoList	No	List<String>		- Cloud DB for Cache 서버 인스턴스 번호 리스트 Cloud DB for Cache 서버 인스턴스 번호로 필터링하여 검색 가능 cloudRedisServerInstanceNoList getCloudCacheInstanceList 액션을 통해 획득 가능 ex) cloudRedisServerInstanceNoList 1234 2345
generationCode	No	String		- 서버 세대 코드 options: G2 \| G3
pageNo	No	Integer	Min: 0	- 페이징된 결과의 페이지 번호 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageSize	Conditional	Integer	Min: 1	- 페이징 시 보여줄 각 페이지 사이즈 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능 pageNo 입력시 반드시 입력 바람
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 getCloudRedisInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ****65  --subnetNo ****92 --cloudRedisServiceName test-**** --cloudRedisInstanceNoList ****890 --cloudRedisServerName test--**** --cloudRedisServerInstanceNoList ****518 --pageNo 0 --pageSize 10

응답 예시


<getCloudRedisInstanceListResponse>
    <requestId>61afef97-c2fa-492e-98ad-a04125d46f9c</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudRedisInstanceList>
        <cloudRedisInstance>
            <cloudRedisInstanceNo>182****</cloudRedisInstanceNo>
            <cloudRedisServiceName>test-****</cloudRedisServiceName>
            <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>
            <isHa>false</isHa>
            <role>
                <code>SIMPLE</code>
                <codeName>CLOUD REDIS(VPC) Cluster Role</codeName>
            </role>
            <generationCode>G2</generationCode>
            <cloudRedisServerInstanceList>
                <cloudRedisServerInstance>
                    <cloudRedisServerInstanceNo>182****</cloudRedisServerInstanceNo>
                    <cloudRedisServerName>test-******-001-j4a</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>A</code>
                        <codeName>Stand Alone</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>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>1665</vpcNo>
                    <subnetNo>1792</subnetNo>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </cloudRedisServerInstance>
            </cloudRedisServerInstanceList>
        </cloudRedisInstance>
    </cloudRedisInstanceList>
</getCloudRedisInstanceListResponse>