getCloudRedisBackupList

Available in VPC

Get the list of Cloud DB for Redis system backups.

Request

The following describes the request format for the endpoint. The request format is as follows:

Request headers

For headers common to Cloud DB for Redis APIs, see Cloud DB for Redis request headers.

Request parameter

The following describes the parameters.

Request example

The following is a sample request.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisBackupList
?regionCode=KR'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response body

See CloudRedisBackupList 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 following is a sample response.

• If responseFormatType=json

{
    "getCloudRedisBackupListResponse": {
        "totalRows": 1,
        "cloudRedisBackupList": [
            {
                "cloudRedisInstanceNo": "****511",
                "cloudRedisServiceName": "test-****",
                "backupFileRetentionPeriod": 7,
                "backupTime": "00:15",
                "backupSize": 525,
                "lastBackupDate": "2024-07-02T00:00:00+0900",
                "backupType": {
                    "code": "CLUSTER",
                    "codeName": "CLOUD REDIS(VPC) Cluster Backup Type"
                },
                "shardCount": 3
            }
        ],
        "requestId": "ac8cf68a-****-****-****-8788236f4c26",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

• If responseFormatType=xml (default)

<?xml version="1.0" encoding="UTF-8"?>
<getCloudRedisBackupListResponse>
    <requestId>ac8cf68a-****-****-****-8788236f4c26</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudRedisBackupList>
        <cloudRedisBackup>
            <cloudRedisInstanceNo>****511</cloudRedisInstanceNo>
            <cloudRedisServiceName>test-****</cloudRedisServiceName>
            <backupFileRetentionPeriod>7</backupFileRetentionPeriod>
            <backupTime>00:15</backupTime>
            <backupSize>525</backupSize>
            <backupType>
                <code>CLUSTER</code>
                <codeName>CLOUD REDIS(VPC) Cluster Backup Type</codeName>
            </backupType>
            <shardCount>3</shardCount>
        </cloudRedisBackup>
    </cloudRedisBackupList>
</getCloudRedisBackupListResponse>