getCloudRedisConfigGroupList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Can be used in a VPC environment.

Overview

Search a list of available Cloud DB for Redis config groups.

Request

Request parameters

Parameter Name	Required	Type	Description
regionCode	No	String	You can determine the region where a region code's Cloud DB for Redis product code list will be searched. You can obtain the regionCode through the getRegionList action. Default: Select the first region of the getRegionList search results
cloudRedisInstanceNo	No	String	You can obtain the Cloud DB for Redis instance number where the ConfigGroup to search is applied, cloudRedisInstanceNo, through the getCloudRedisInstanceList action.
cloudRedisInstanceName	No	String	You can obtain the Cloud DB for Redis instance name where the ConfigGroup to search is applied, cloudRedisInstanceName, through the getCloudRedisInstanceList action.
configGroupNo	No	String	You can obtain the ConfigGroup number to search, configGroupNo, through the getCloudRedisConfigGroupList action.
configGroupName	No	String	You can obtain the ConfigGroup name to search, configGroupName, through the getCloudRedisConfigGroupList action.
cloudRedisImageProductCode	No	String	Cloud Redis Image Product Code corresponding to the version of ConfigGroup to query You can obtain the cloudRedisImageProductCode through the productCode of the getCloudRedisImageProductList action.
cloudRedisModeCode	No	String	You can obtain the Cloud DB for Redis's mode codes (CLUSTER and SIMPLE) where the ConfigGroup to search is applied, cloudRedisModeCode, through the getCloudRedisInstanceList action.
output	No	String	Respond result's format type. Options: xml \| json Default: json

Response

Response Data Type

CloudRedisConfigGroupList type

CloudRedisConfigGroupList extends CommonResponse
private Integer totalRows;
private List<CloudRedisConfigGroup> cloudRedisConfigGroupList = new ArrayList<>();

CloudRedisConfigGroup
private String configGroupNo;
private String configGroupName;
private String configGroupDescription;
private String configGroupStatusName;
private CommonCode configGroupStatus;
private String cloudRedisVersion;
private Date createDate;
private Date modifyDate;
private CloudRedisInstanceNoList cloudRedisInstanceNoList;

CloudRedisInstanceNoList
private List<String> cloudRedisInstanceNoList = new ArrayList<>();

Example

Examples of requests

ncloud vredis getCloudRedisConfigGroupList --regionCode KR --cloudRedisInstanceNo ****821 --cloudRedisServiceName***test --configGroupNo ***9 --configGroupNametest-****-config --cloudRedisImageProductCode SW.VDBAS.VRDS.LNX64.CNTOS.0703.REDIS.4014.B050 --cloudRedisModeCode CLUSTER

Examples of responses

<getCloudRedisConfigGroupListResponse>
  <requestId>06a7bbf2-a576-4521-bdf4-392711e31560</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cloudRedisConfigGroupList>
    <cloudRedisConfigGroup>
      <configGroupNo>**9</configGroupNo>
      <configGroupName>exercise</configGroupName>
      <configGroupDescription>description</configGroupDescription>
      <configGroupStatusName>running</configGroupStatusName>
      <configGroupStatus>
        <code>RUN</code>
        <codeName>CONFIG GROUP Running State</codeName>
      </configGroupStatus>
      <cloudRedisVersion>4.0.14-cluster</cloudRedisVersion>
      <createDate>2020-11-26T13:47:27+0900</createDate>
      <modifyDate>2020-11-26T13:47:27+0900</modifyDate>
      <cloudRedisInstanceNoList>
        <cloudRedisInstanceNo>****821</cloudRedisInstanceNo>
      </cloudRedisInstanceNoList>
    </cloudRedisConfigGroup>
  </cloudRedisConfigGroupList>
</getCloudRedisConfigGroupListResponse>

Was this article helpful?

What's Next

getCloudRedisInstanceDetail

Table of contents

Overview
Request
Response
Example