getCloudCacheInstanceList

Prev Next

Available in VPC

Get the Cloud DB for Cache instance list.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET, POST /getCloudRedisInstanceList

Request headers

For information about the headers common to all Cloud DB for Cache APIs, see Cloud DB for Cache request headers.

Request parameters

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code of the Cloud DB for Cache instance to query
  • Check through getRegionList.
  • First Region of the getRegionList query result (default)
zoneCode String Optional Filter by zone code.
vpcNo String Optional Filter by VPC number.
subnetNo String Optional Filter by subnet number.
cloudRedisServiceName String Optional Filter by Cloud DB for Cache service name.
cloudRedisInstanceNoList.N List<String> Optional Cloud DB for Cache instance number list
  • Filter by Cloud DB for Cache instance number.
  • Check through getCloudCacheInstanceList.
  • Example: cloudRedisInstanceNoList.1=1234&cloudRedisInstanceNoList.2=2345
cloudRedisServerName String Optional Filter by Cloud DB for Cache server name.
cloudRedisServerInstanceNoList.N List<String> Optional Cloud DB for Cache server instance number list
  • Filter by Cloud DB for Cache server instance number.
  • Check through getCloudCacheInstanceList.
  • Example: cloudRedisServerInstanceNoList.1=1234&cloudRedisServerInstanceNoList.2=2345
generationCode String Optional Filter by server generation code.
pageNo Integer Optional Page numbers in paged results
  • Page the result values using pageNo and pageSize
  • 0 (minimum).
pageSize Integer Conditional Number of results to display on a page
  • Page the result values using pageNo and pageSize.
  • Required when entering pageNo
  • 1 (minimum)
responseFormatType String Optional Format of the response result
  • xml (default) | json

Request example

The request example is as follows:

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisInstanceList
?regionCode=KR
&zoneCode=KR-1
&vpcNo=****83
&subnetNo=****91
&cloudRedisServiceName=test-****
&cloudRedisInstanceNoList.1=****511
&cloudRedisServerName=test-****
&cloudRedisServerInstanceNoList.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}'

Response

This section describes the response format.

Response body

See CloudRedisInstanceList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The response example is as follows:

  • If responseFormatType=json

    {
    "getCloudRedisInstanceListResponse": {
        "totalRows": 1,
        "cloudRedisInstanceList": [
            {
                "cloudRedisInstanceNo": "****511",
                "cloudRedisServiceName": "test-****",
                "cloudRedisInstanceStatusName": "running",
                "cloudRedisInstanceStatus": {
                    "code": "CREAT",
                    "codeName": "CLOUD DATABASE(VPC) Created State"
                },
                "cloudRedisInstanceOperation": {
                    "code": "NULL",
                    "codeName": "CLOUD DATABASE(VPC) Null OP"
                },
                "isHa": true,
                "generationCode": "G2",
                "role": {
                    "code": "CLUSTER",
                    "codeName": "CLOUD REDIS(VPC) Cluster Role"
                },
                "cloudRedisServerInstanceList": [
                    {
                        "cloudRedisServerInstanceNo": "****613",
                        "cloudRedisServerName": "test-****-001-001-ehs",
                        "cloudRedisServerRole": {
                            "code": "M",
                            "codeName": "Master"
                        },
                        "cloudRedisServerInstanceStatusName": "running",
                        "cloudRedisServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudRedisServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "cpuCount": 4,
                        "memorySize": 1610612736
                    },
                    {
                        "cloudRedisServerInstanceNo": "****616",
                        "cloudRedisServerName": "test-****-002-001-eht",
                        "cloudRedisServerRole": {
                            "code": "M",
                            "codeName": "Master"
                        },
                        "cloudRedisServerInstanceStatusName": "running",
                        "cloudRedisServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudRedisServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "cpuCount": 4,
                        "memorySize": 1610612736
                    },
                    {
                        "cloudRedisServerInstanceNo": "****619",
                        "cloudRedisServerName": "test-****-003-001-ehu",
                        "cloudRedisServerRole": {
                            "code": "M",
                            "codeName": "Master"
                        },
                        "cloudRedisServerInstanceStatusName": "running",
                        "cloudRedisServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudRedisServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "cpuCount": 4,
                        "memorySize": 1610612736
                    },
                    {
                        "cloudRedisServerInstanceNo": "****622",
                        "cloudRedisServerName": "test-****-001-002-ehv",
                        "cloudRedisServerRole": {
                            "code": "S",
                            "codeName": "Slave"
                        },
                        "cloudRedisServerInstanceStatusName": "running",
                        "cloudRedisServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudRedisServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "cpuCount": 4,
                        "memorySize": 1610612736
                    },
                    {
                        "cloudRedisServerInstanceNo": "****625",
                        "cloudRedisServerName": "test-****-002-002-ehw",
                        "cloudRedisServerRole": {
                            "code": "S",
                            "codeName": "Slave"
                        },
                        "cloudRedisServerInstanceStatusName": "running",
                        "cloudRedisServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudRedisServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "cpuCount": 4,
                        "memorySize": 1610612736
                    },
                    {
                        "cloudRedisServerInstanceNo": "****628",
                        "cloudRedisServerName": "test-****-003-002-ehx",
                        "cloudRedisServerRole": {
                            "code": "S",
                            "codeName": "Slave"
                        },
                        "cloudRedisServerInstanceStatusName": "running",
                        "cloudRedisServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudRedisServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "cpuCount": 4,
                        "memorySize": 1610612736
                    }
                ]
            }
        ],
        "requestId": "02c8adab-****-****-****-6d6b37885670",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

  • If responseFormatType=xml (default)

    <?xml version="1.0" encoding="UTF-8"?>
<getCloudRedisInstanceListResponse>
    <requestId>02c8adab-****-****-****-6d6b37885670</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudRedisInstanceList>
        <cloudRedisInstance>
            <cloudRedisInstanceNo>****511</cloudRedisInstanceNo>
            <cloudRedisServiceName>test-****</cloudRedisServiceName>
            <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>true</isHa>
            <generationCode>G2</generationCode>
            <role>
                <code>CLUSTER</code>
                <codeName>CLOUD REDIS(VPC) Cluster Role</codeName>
            </role>
            <cloudRedisServerInstanceList>
                <cloudRedisServerInstance>
                    <cloudRedisServerInstanceNo>****613</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>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <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>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <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>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <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>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <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>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <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>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                </cloudRedisServerInstance>
            </cloudRedisServerInstanceList>
        </cloudRedisInstance>
    </cloudRedisInstanceList>
</getCloudRedisInstanceListResponse>