getCloudCacheInstanceList

VPC環境で利用できます。

Cloud DB for Cacheインスタンスリストを照会します。

参考

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

getCloudCacheInstanceList API: Valkey、Redis DBMSを利用可能
getCloudRedisInstanceList API: Redis DBMSを利用可能

getCloudCacheInstanceList API

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

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET, POST	/getCloudCacheInstanceList

リクエストヘッダ

Cloud DB for Cache (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for Cache (VPC)のリクエストヘッダをご参照ください。

リクエストパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	照会対象 Cloud DB for Cacheインスタンスのリージョンコード getRegionListを通じて確認 `getRegionList`照会結果の最初のリージョン(デフォルト)
`zoneCode`	String	Optional	ゾーンコードで絞り込み getZoneListを通じて確認
`vpcNo`	String	Optional	VPC番号で絞り込み getCloudCacheTargetVpcListを通じて確認
`subnetNo`	String	Optional	Subnet番号で絞り込み getCloudCacheTargetSubnetListを通じて確認
`cloudCacheServiceName`	String	Optional	Cloud DB for Cacheサービス名で絞り込み
`cloudCacheInstanceNoList.N`	List<String>	Optional	Cloud DB for Cacheインスタンス番号リスト Cloud DB for Cacheインスタンス番号で絞り込み getCloudCacheInstanceListを通じて確認 <例> `cloudCacheInstanceNoList.1=1234&cloudCacheInstanceNoList.2=2345`
`cloudCacheServerName`	String	Optional	Cloud DB for Cacheサーバ名で絞り込み getCloudCacheInstanceListを通じて確認
`cloudCacheServerInstanceNoList.N`	List<String>	Optional	Cloud DB for Cacheサーバインスタンス番号リスト Cloud DB for Cacheサーバインスタンス番号で絞り込み getCloudCacheInstanceListを通じて確認 <例> `cloudCacheServerInstanceNoList.1=1234&cloudCacheServerInstanceNoList.2=2345`
`generationCode`	String	Optional	サーバの世代コードで絞り込み `G2` \| `G3`
`pageNo`	Integer	Optional	ページングされた結果のページ番号 `pageNo`、`pageSize`を利用してページング処理 0 (最小)
`pageSize`	Integer	Conditional	ページごとに表示する結果数 `pageNo`、`pageSize`を利用してページング処理 `pageNo`入力時、必須 1 (最小)
`cloudCacheDbmsCode`	String	Optional	Cloud DB for Cacheインスタンスの DBMSコード `Redis` \| `Valkey`
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vcache/v2/getCloudCacheInstanceList
?regionCode=KR
&zoneCode=KR-1
&vpcNo=****83
&subnetNo=****91
&cloudCacheServiceName=test-****
&cloudCacheInstanceNoList.1=****511
&cloudCacheServerName=test-****
&cloudCacheServerInstanceNoList.1=****613
&generationCode=G2
&pageNo=0
&pageSize=10'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、CloudCacheInstanceListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

responseFormatType=jsonの場合

{
    "getCloudCacheInstanceListResponse": {
        "totalRows": 1,
        "cloudCacheInstanceList": [
            {
                "cloudCacheInstanceNo": "****511",
                "cloudCacheServiceName": "test-****",
                "cloudCacheInstanceStatusName": "running",
                "cloudCacheInstanceStatus": {
                    "code": "CREAT",
                    "codeName": "CLOUD DATABASE(VPC) Created状態"
                },
                "cloudCacheInstanceOperation": {
                    "code": "NULL",
                    "codeName": "CLOUD DATABASE(VPC) Null OP"
                },
                "isHa": true,
                "generationCode": "G2",
                "role": {
                    "code": "SIMPLE",
                    "codeName": "CLOUD CACHE(VPC) Cluster Role"
                },
                "cloudCacheServerInstanceList": [
                    {
                        "cloudCacheServerInstanceNo": "****613",
                        "cloudCacheServerName": "test-****-001-001-ehs",
                        "cloudCacheServerRole": {
                            "code": "M",
                            "codeName": "Master"
                        },
                        "cloudCacheServerInstanceStatusName": "running",
                        "cloudCacheServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Running状態"
                        },
                        "cloudCacheServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "cpuCount": 4,
                        "memorySize": 1610612736
                    },
                    {
                        "cloudCacheServerInstanceNo": "****616",
                        "cloudCacheServerName": "test-****-002-001-eht",
                        "cloudCacheServerRole": {
                            "code": "M",
                            "codeName": "Master"
                        },
                        "cloudCacheServerInstanceStatusName": "running",
                        "cloudCacheServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Running状態"
                        },
                        "cloudCacheServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "cpuCount": 4,
                        "memorySize": 1610612736
                    },
                    {
                        "cloudCacheServerInstanceNo": "****619",
                        "cloudCacheServerName": "test-****-003-001-ehu",
                        "cloudCacheServerRole": {
                            "code": "M",
                            "codeName": "Master"
                        },
                        "cloudCacheServerInstanceStatusName": "running",
                        "cloudCacheServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Running状態"
                        },
                        "cloudCacheServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "cpuCount": 4,
                        "memorySize": 1610612736
                    },
                    {
                        "cloudCacheServerInstanceNo": "****622",
                        "cloudCacheServerName": "test-****-001-002-ehv",
                        "cloudCacheServerRole": {
                            "code": "S",
                            "codeName": "Slave"
                        },
                        "cloudCacheServerInstanceStatusName": "running",
                        "cloudCacheServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Running状態"
                        },
                        "cloudCacheServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "cpuCount": 4,
                        "memorySize": 1610612736
                    },
                    {
                        "cloudCacheServerInstanceNo": "****625",
                        "cloudCacheServerName": "test-****-002-002-ehw",
                        "cloudCacheServerRole": {
                            "code": "S",
                            "codeName": "Slave"
                        },
                        "cloudCacheServerInstanceStatusName": "running",
                        "cloudCacheServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Running状態"
                        },
                        "cloudCacheServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "cpuCount": 4,
                        "memorySize": 1610612736
                    },
                    {
                        "cloudCacheServerInstanceNo": "****628",
                        "cloudCacheServerName": "test-****-003-002-ehx",
                        "cloudCacheServerRole": {
                            "code": "S",
                            "codeName": "Slave"
                        },
                        "cloudCacheServerInstanceStatusName": "running",
                        "cloudCacheServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Running状態"
                        },
                        "cloudCacheServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "cpuCount": 4,
                        "memorySize": 1610612736
                    }
                ]
            }
        ],
        "requestId": "02c8adab-****-****-****-6d6b37885670",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

responseFormatType=xml(デフォルト)の場合

<?xml version="1.0" encoding="UTF-8"?>
<getCloudCacheInstanceListResponse>
    <requestId>02c8adab-****-****-****-6d6b37885670</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudCacheInstanceList>
        <cloudCacheInstance>
            <cloudCacheInstanceNo>****511</cloudCacheInstanceNo>
            <cloudCacheServiceName>test-****</cloudCacheServiceName>
            <cloudCacheInstanceStatusName>running</cloudCacheInstanceStatusName>
            <cloudCacheInstanceStatus>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Created状態</codeName>
            </cloudCacheInstanceStatus>
            <cloudCacheInstanceOperation>
                <code>NULL</code>
                <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
            </cloudCacheInstanceOperation>
            <isHa>true</isHa>
            <generationCode>G2</generationCode>
            <role>
                <code>SIMPLE</code>
                <codeName>CLOUD CACHE(VPC) Cluster Role</codeName>
            </role>
            <cloudCacheServerInstanceList>
                <cloudCacheServerInstance>
                    <cloudCacheServerInstanceNo>****613</cloudCacheServerInstanceNo>
                    <cloudCacheServerName>test-****-001-001-ehs</cloudCacheServerName>
                    <cloudCacheServerRole>
                        <code>M</code>
                        <codeName>Master</codeName>
                    </cloudCacheServerRole>
                    <cloudCacheServerInstanceStatusName>running</cloudCacheServerInstanceStatusName>
                    <cloudCacheServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC)サーバ Running状態</codeName>
                    </cloudCacheServerInstanceStatus>
                    <cloudCacheServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC)サーバ Null OP</codeName>
                    </cloudCacheServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </cloudCacheServerInstance>
                <cloudCacheServerInstance>
                    <cloudCacheServerInstanceNo>****616</cloudCacheServerInstanceNo>
                    <cloudCacheServerName>test-****-002-001-eht</cloudCacheServerName>
                    <cloudCacheServerRole>
                        <code>M</code>
                        <codeName>Master</codeName>
                    </cloudCacheServerRole>
                    <cloudCacheServerInstanceStatusName>running</cloudCacheServerInstanceStatusName>
                    <cloudCacheServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC)サーバ Running状態</codeName>
                    </cloudCacheServerInstanceStatus>
                    <cloudCacheServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC)サーバ Null OP</codeName>
                    </cloudCacheServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </cloudCacheServerInstance>
                <cloudCacheServerInstance>
                    <cloudCacheServerInstanceNo>****619</cloudCacheServerInstanceNo>
                    <cloudCacheServerName>test-****-003-001-ehu</cloudCacheServerName>
                    <cloudCacheServerRole>
                        <code>M</code>
                        <codeName>Master</codeName>
                    </cloudCacheServerRole>
                    <cloudCacheServerInstanceStatusName>running</cloudCacheServerInstanceStatusName>
                    <cloudCacheServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC)サーバ Running状態</codeName>
                    </cloudCacheServerInstanceStatus>
                    <cloudCacheServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC)サーバ Null OP</codeName>
                    </cloudCacheServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </cloudCacheServerInstance>
                <cloudCacheServerInstance>
                    <cloudCacheServerInstanceNo>****622</cloudCacheServerInstanceNo>
                    <cloudCacheServerName>test-****-001-002-ehv</cloudCacheServerName>
                    <cloudCacheServerRole>
                        <code>S</code>
                        <codeName>Slave</codeName>
                    </cloudCacheServerRole>
                    <cloudCacheServerInstanceStatusName>running</cloudCacheServerInstanceStatusName>
                    <cloudCacheServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC)サーバ Running状態</codeName>
                    </cloudCacheServerInstanceStatus>
                    <cloudCacheServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC)サーバ Null OP</codeName>
                    </cloudCacheServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </cloudCacheServerInstance>
                <cloudCacheServerInstance>
                    <cloudCacheServerInstanceNo>****625</cloudCacheServerInstanceNo>
                    <cloudCacheServerName>test-****-002-002-ehw</cloudCacheServerName>
                    <cloudCacheServerRole>
                        <code>S</code>
                        <codeName>Slave</codeName>
                    </cloudCacheServerRole>
                    <cloudCacheServerInstanceStatusName>running</cloudCacheServerInstanceStatusName>
                    <cloudCacheServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC)サーバ Running状態</codeName>
                    </cloudCacheServerInstanceStatus>
                    <cloudCacheServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC)サーバ Null OP</codeName>
                    </cloudCacheServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </cloudCacheServerInstance>
                <cloudCacheServerInstance>
                    <cloudCacheServerInstanceNo>****628</cloudCacheServerInstanceNo>
                    <cloudCacheServerName>test-****-003-002-ehx</cloudCacheServerName>
                    <cloudCacheServerRole>
                        <code>S</code>
                        <codeName>Slave</codeName>
                    </cloudCacheServerRole>
                    <cloudCacheServerInstanceStatusName>running</cloudCacheServerInstanceStatusName>
                    <cloudCacheServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC)サーバ Running状態</codeName>
                    </cloudCacheServerInstanceStatus>
                    <cloudCacheServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC)サーバ Null OP</codeName>
                    </cloudCacheServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </cloudCacheServerInstance>
            </cloudCacheServerInstanceList>
        </cloudCacheInstance>
    </cloudCacheInstanceList>
</getCloudCacheInstanceListResponse>

getCloudRedisInstanceList API

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