getCloudRedisInstanceList
    • PDF

    getCloudRedisInstanceList

    • PDF

    Article Summary

    Can be used in a VPC environment.

    Overview

    Search a list of Cloud DB for Redis instances.

    Request

    Request parameters

    Parameter NameRequiredTypeRestrictionsDescription
    regionCodeNoStringYou can determine the region where a list of a region code's Cloud DB for Redis instances will be searched. You can obtain the regionCode through the getRegionList action. Default: Select the first region of the getRegionList search results
    zoneCodeNoStringYou can determine the zone where a list of a ZONE code's Cloud DB for Redis instances will be searched. You can obtain the zoneCode through the getZoneList action.
    vpcNoNoStringYou can determine the VPC where a VPC number's Cloud DB for Redis instance list will be searched. You can obtain the vpcNo through the getCloudRedisTargetVpcList action.
    subnetNoNoStringYou can determine the subnet where a list of a subnet number's Cloud DB for Redis instances will be searched. You can obtain the SubnetNo through the getCloudRedisTargetSubnetList action.
    cloudRedisServiceNameNoStringYou can search by filtering with Cloud DB for Redis service name and Cloud DB for Redis service name. You can obtain the cloudRedisServiceName through getCloudRedisInstanceList action.
    cloudRedisInstanceNoListNoList<String>You can search by filtering with a list of Cloud DB for Redis instance numbers and Cloud DB for Redis instance numbers. You can obtain the cloudRedisInstanceNo list through the getCloudRedisInstanceList action. e.g., cloudRedisInstanceNoList 1234 2345
    cloudRedisServerNameNoStringYou can search by filtering with a Cloud DB for Redis server name. You can obtain the cloudRedisServerName through the getCloudRedisInstanceList action.
    cloudRedisServerInstanceNoListNoList<String>You can search by filtering with a list of Cloud DB for Redis server instance numbers and Cloud DB for Redis server instance numbers. You can obtain the cloudRedisServerInstanceNoList through the getCloudRedisInstanceList action, e.g., cloudRedisServerInstanceNoList 1234 2345.
    pageNoNoIntegerMin: 0The paged result's page number results can be paged using pageNo and pageSize.
    pageSizeConditionalIntegerMin: 1Each page size result that will be shown when paging can be paged using pageNo and pageSize. Make sure to enter the pageNo.
    outputNoStringRespond result's format type. 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 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;

    Example

    Examples of requests

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

    Examples of responses

    
    <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>
                <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>
    

    Was this article helpful?

    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.