getCloudRedisInstanceList
- Print
- PDF
getCloudRedisInstanceList
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Can be used in a VPC environment.
Overview
Search a list of Cloud DB for Redis instances.
Request
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Explanation |
|---|---|---|---|---|
| regionCode | No | String | You 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 | |
| zoneCode | No | String | You 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. | |
| vpcNo | No | String | You 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. | |
| subnetNo | No | String | You 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. | |
| cloudRedisServiceName | No | String | You 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. | |
| cloudRedisInstanceNoList | No | List<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.1=1234&cloudRedisInstanceNoList.2=2345 | |
| cloudRedisServerName | No | String | You can search by filtering with a Cloud DB for Redis server name. You can obtain the cloudRedisServerName through the getCloudRedisInstanceList action. | |
| cloudRedisServerInstanceNoList | No | List<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.1=1234&cloudRedisServerInstanceNoList.2=2345. | |
| pageNo | No | Integer | Min: 0 | The paged result's page number results can be paged using pageNo and pageSize. |
| pageSize | Conditional | Integer | Each page size result that will be shown when paging can be paged using pageNo and pageSize. Make sure to enter the pageNo. | |
| responseFormatType | No | String | Respond result's format type. Options: xml | json Default: xml |
Response
Response body
Example
Request example
GET {API_URL}/getCloudRedisInstanceList
?regionCode=KR
&zoneCode=KR-1
&vpcNo=****65
&subnetNo=****92
&cloudRedisServiceName=test-****
&cloudRedisInstanceNoList.1=****890
&cloudRedisServerName=test--****
&cloudRedisServerInstanceNoList.1=****518
&pageNo=0
&pageSize=10
Response example
<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?