getCloudCacheConfigGroupList

Prev Next

VPCVPC環境で利用できます。

概要

Cloud DB for Cache Config groupリストを照会します。

参考

Cloud DB for Cache CLIは、対応する DBMSの範囲に応じて2つのバージョンを提供しています。

  • getCloudCacheConfigGroupList CLI: Valkey、Redis DBMSを利用可能
  • getCloudRedisConfigGroupList CLI: Redis DBMSを利用可能

getCloudCacheConfigGroupList CLI

getCloudCacheConfigGroupList CLIのリクエストおよびレスポンス形式を説明します。

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制限事項 説明
regionCode No String - リージョンコード
Cloud DB for Cache Config Groupリストが照会されるリージョン(Region)を決定可能
regionCodeはgetRegionListアクションを通じて取得可能
デフォルト: getRegionList照会結果の最初のリージョンを選択
cloudCacheInstanceNo No String - 照会対象の ConfigGroupが適用された Cloud DB for Cacheインスタンス番号
cloudCacheInstanceNoはgetCloudCacheInstanceListアクションを通じて取得可能
cloudCacheServiceName No String - 照会対象の ConfigGroupが適用された Cloud DB for Cacheサービス名
cloudCacheServiceNameはgetCloudCacheInstanceListアクションを通じて取得可能
configGroupNo No String - 照会対象の ConfigGroup番号
configGroupNoはgetCloudCacheConfigGroupListアクションを通じて取得可能
configGroupName No String - 照会対象の ConfigGroup名
configGroupNameはgetCloudCacheConfigGroupListアクションを通じて取得可能
cloudCacheModeCode No String - Cloud DB for Cacheの構成
照会対象の ConfigGroupが適用された Cloud DB for Cacheの構成。
cloudCacheModeCodeはgetCloudCacheInstanceListアクションを通じて取得可能
オプション: SIMPLE | CLUSTER
cloudCacheDbmsCode String Optional Cloud DB for Cacheインスタンスの DBMSコード
オプション: Redis | Valkey
output No String - レスポンス結果の形式タイプ
オプション: xml | json
デフォルト: json

レスポンス

レスポンスデータタイプ

  • CloudCacheConfigGroupListタイプ
CloudCacheConfigGroupList extends CommonResponse
private Integer totalRows;
private List<CloudCacheConfigGroup> cloudCacheConfigGroupList = new ArrayList<>();
CloudCacheConfigGroup
private String configGroupNo;
private String configGroupName;
private String configGroupDescription;
private String configGroupStatusName;
private CommonCode configGroupStatus;
private String cloudCacheVersion;
private String cloudCacheDbmsCode;
private Date createDate;
private Date modifyDate;
private CloudCacheInstanceNoList cloudCacheInstanceNoList;
CloudCacheInstanceNoList
private List<String> cloudCacheInstanceNoList = new ArrayList<>();

例

呼び出し

ncloud vcache getCloudCacheConfigGroupList --regionCode KR --cloudCacheInstanceNo ****821 --cloudCacheServiceName ***test --configGroupNo ***9 --configGroupName test-****-config --cloudCacheModeCode SIMPLE

レスポンス


<getCloudCacheConfigGroupListResponse>
    <requestId>06a7bbf2-a576-4521-bdf4-392711e31560</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudCacheConfigGroupList>
        <cloudCacheConfigGroup>
            <configGroupNo>**9</configGroupNo>
            <configGroupName>exercise</configGroupName>
            <configGroupDescription>description</configGroupDescription>
            <configGroupStatusName>running</configGroupStatusName>
            <configGroupStatus>
                <code>RUN</code>
                <codeName>CONFIG GROUP Running State</codeName>
            </configGroupStatus>
            <cloudCacheVersion>7.2.11-simple</cloudCacheVersion>
            <cloudCacheDbmsCode>Valkey</cloudCacheDbmsCode>
            <createDate>2020-11-26T13:47:27+0900</createDate>
            <modifyDate>2020-11-26T13:47:27+0900</modifyDate>
            <cloudCacheInstanceNoList>
                <cloudCacheInstanceNo>****821</cloudCacheInstanceNo>
            </cloudCacheInstanceNoList>
        </cloudCacheConfigGroup>
    </cloudCacheConfigGroupList>
</getCloudCacheConfigGroupListResponse>

getCloudRedisConfigGroupList CLI

getCloudRedisConfigGroupList CLIのリクエストおよびレスポンス形式を説明します。

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制限事項 説明
regionCode No String - リージョンコード
Cloud DB for Cache Config Groupリストが照会されるリージョン(Region)を決定可能
regionCodeはgetRegionListアクションを通じて取得可能
デフォルト: getRegionList照会結果の最初のリージョンを選択
cloudRedisInstanceNo No String - 照会対象の ConfigGroupが適用された Cloud DB for Cacheインスタンス番号
cloudRedisInstanceNoはgetCloudCacheInstanceListアクションを通じて取得可能
cloudRedisServiceName No String - 照会対象の ConfigGroupが適用された Cloud DB for Cacheインスタンス名
cloudRedisServiceNameはgetCloudCacheInstanceListアクションを通じて取得可能
configGroupNo No String - 照会対象の ConfigGroup番号
configGroupNoはgetCloudCacheConfigGroupListアクションを通じて取得可能
configGroupName No String - 照会対象の ConfigGroup名
configGroupNameはgetCloudCacheConfigGroupListアクションを通じて取得可能
cloudRedisModeCode No String - Cloud DB for Cacheの構成
照会対象の ConfigGroupが適用された Cloud DB for Cacheの構成
CLUSTER, SIMPLE
cloudRedisModeCodeはgetCloudCacheInstanceListアクションを通じて取得可能
output No String - レスポンス結果の形式タイプ
オプション: xml | json
デフォルト: json

レスポンス

レスポンスデータタイプ

  • CloudRedisConfigGroupListタイプ
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<>();

例

呼び出し

ncloud vredis getCloudRedisConfigGroupList --regionCode KR --cloudRedisInstanceNo ****821 --cloudRedisServiceName ***test --configGroupNo ***9 --configGroupName test-****-config --cloudRedisModeCode CLUSTER

レスポンス



<getCloudRedisConfigGroupListResponse>
    <requestId>96bceb85-b1b8-4c6c-bacb-7207a1890af8</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudRedisConfigGroupList>
        <cloudRedisConfigGroup>
            <configGroupNo>**9</configGroupNo>
            <configGroupName>exercise</configGroupName>
            <configGroupDescription>practice</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>