getCloudCacheInstanceList

Prev Next

Available in VPC

Overview

Get the Cloud DB for Cache instance list.

Note

Cloud DB for Cache CLI offers two versions based on the supported DBMS range.

  • getCloudCacheInstanceList CLI: Support for Valkey and Redis DBMS
  • getCloudRedisInstanceList CLI: Support for Redis DBMS

getCloudCacheInstanceList CLI

This section describes the request and response formats for the getCloudCacheInstanceList CLI.

Request

Request parameters

Parameter name Required Type Restrictions Description
regionCode No String - Region code
Determine the Region in which the Cloud DB for Cache instance list will be queried.
regionCode can be obtained through the getRegionList action.
Default: Select the first Region of the getRegionList search results.
zoneCode No String - Zone code
Determine the zone in which the Cloud DB for Cache instance list will be queried.
zoneCode can be obtained through the getZoneList action.
vpcNo No String - VPC number
Determine the VPC in which the Cloud DB for Cache instance list will be queried.
vpcNo can be obtained through the getVpcList action.
subnetNo No String - Subnet number
Determine the subnet in which the Cloud DB for Cache instance list will be queried.
You can obtain SubnetNo through the getSubnetList action.
cloudCacheServiceName No String - Cloud DB for Cache service name
Search by filtering with Cloud DB for Cache service name.
cloudCacheServiceName can be obtained through the getCloudCacheInstanceList action.
cloudCacheInstanceNoList No List<String> - Cloud DB for Cache instance number list
Search by filtering with Cloud DB for Cache instance number.
cloudCacheInstanceNoList can be obtained through the getCloudCacheInstanceList action.
e.g., cloudCacheInstanceNoList 1234 2345
cloudCacheServerName No String - Cloud DB for Cache server name
Search by filtering with Cloud DB for Cache server name.
cloudCacheServerName can be obtained through the getCloudCacheInstanceList action.
cloudCacheServerInstanceNoList No List<String> - Cloud DB for Cache server instance number list
Search by filtering with Cloud DB for Cache server instance number.
cloudCacheServerInstanceNoList can be obtained through the getCloudCacheInstanceList action.
e.g., cloudCacheServerInstanceNoList 1234 2345
generationCode No String - Server generation code
options: G2 | G3
pageNo No Integer Min: 0 - Page number of the paged results
The results can be paged using pageNo and pageSize.
pageSize Conditional Integer Min: 1 - Size of each page to be displayed when paging
The results can be paged using pageNo and pageSize.
It must be entered when pageNo is entered.
cloudCacheDbmsCode No String Cloud DB for Cache instance's DBMS code
Options: Redis | Valkey
output No String - Format type of the response result
Options : xml | json
Default : json

Response

Response data type

  • CloudCacheInstanceList type
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;

Examples

Call

ncloud vcache getCloudCacheInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ****65  --subnetNo ****92 --cloudCacheServiceName test-**** --cloudCacheInstanceNoList ****890 --cloudCacheServerName test--**** --cloudCacheServerInstanceNoList ****518 --pageNo 0 --pageSize 10

Response


<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

This section describes the request and response formats for the getCloudRedisInstanceList CLI.

Request

Request parameters

Parameter name Required Type Restrictions Description
regionCode No String - Region code
Determine the Region in which the Cloud DB for Cache instance list will be queried.
regionCode can be obtained through the getRegionList action.
Default: Select the first Region of the getRegionList search results.
zoneCode No String - Zone code
Determine the zone in which the Cloud DB for Cache instance list will be queried.
zoneCode can be obtained through the getZoneList action.
vpcNo No String - VPC number
Determine the VPC in which the Cloud DB for Cache instance list will be queried.
vpcNo can be obtained through the getCloudCacheTargetVpcList action.
subnetNo No String - Subnet number
Determine the subnet in which the Cloud DB for Cache instance list will be queried.
SubnetNo can be obtained through the getCloudCacheTargetSubnetList action.
cloudRedisServiceName No String - Cloud DB for Cache service name
Search by filtering with Cloud DB for Cache service name.
cloudRedisServiceName can be obtained through the getCloudCacheInstanceList action.
cloudRedisInstanceNoList No List<String> - Cloud DB for Cache instance number list
Search by filtering with Cloud DB for Cache instance number.
cloudRedisInstanceNoList can be obtained through the getCloudCacheInstanceList action.
e.g., cloudRedisInstanceNoList 1234 2345
cloudRedisServerName No String - Cloud DB for Cache server name
Search by filtering with Cloud DB for Cache server name.
cloudRedisServerName can be obtained through the getCloudCacheInstanceList action.
cloudRedisServerInstanceNoList No List<String> - Cloud DB for Cache server instance number list
Search by filtering with Cloud DB for Cache server instance number.
cloudRedisServerInstanceNoList can be obtained through the getCloudRedisInstanceList action.
e.g., cloudRedisServerInstanceNoList 1234 2345
generationCode No String - Server generation code
options: G2 | G3
pageNo No Integer Min: 0 - Page number of the paged results
The results can be paged using pageNo and pageSize.
pageSize Conditional Integer Min: 1 - Size of each page to be displayed when paging
The results can be paged using pageNo and pageSize.
This field must be entered when pageNo is entered.
output No String - Format type of the response result
Options : xml | json
Default : json

Response

Response data type

  • CloudRedisInstanceList type
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;

Examples

Call

ncloud vredis getCloudRedisInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ****65  --subnetNo ****92 --cloudRedisServiceName test-**** --cloudRedisInstanceNoList ****890 --cloudRedisServerName test--**** --cloudRedisServerInstanceNoList ****518 --pageNo 0 --pageSize 10

Response


<getCloudRedisInstanceListResponse>
    <requestId>722951df-d6d8-45a5-b3e1-7a16df4670f8</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>
            <isHa>false</isHa>
            <role>
                <code>CLUSTER</code>
                <codeName>CLOUD REDIS(VPC) Cluster Role</codeName>
            </role>
            <generationCode>G2</generationCode>
            <cloudRedisServerInstanceList>
                <cloudRedisServerInstance>
                    <cloudRedisServerInstanceNo>****518</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>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****65</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </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>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****65</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </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>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****65</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </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>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****65</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </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>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****65</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </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>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****65</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </cloudRedisServerInstance>
            </cloudRedisServerInstanceList>
        </cloudRedisInstance>
    </cloudRedisInstanceList>
</getCloudRedisInstanceListResponse>