getCloudCacheBackupList

Prev Next

VPC 환경에서 이용 가능합니다.

Cloud DB for Cache 시스템 백업 리스트를 조회합니다.

참고

Cloud DB for Cache API는 지원하는 DBMS 범위에 따라 두 가지 버전을 제공합니다.

  • getCloudCacheBackupList API: Valkey, Redis DBMS 이용 가능
  • getCloudRedisBackupList API: Redis DBMS 이용 가능

getCloudCacheBackupList API

getCloudCacheBackupList API의 요청, 응답 형식을 설명합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET | POST /vcache/v2/getCloudCacheBackupList

요청 헤더

Cloud DB for Cache (VPC) API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud DB for Cache (VPC) 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
regionCode String Optional 조회할 Cloud DB for Cache 시스템 백업 리스트의 리전 코드
  • getRegionList 참조
  • getRegionList 조회 결과의 첫 번째 리전(기본값)
responseFormatType String Optional 응답 결과의 형식
  • xml (기본값) | json

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ncloud.apigw.gov-ntruss.com/vcache/v2/getCloudCacheBackupList
?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}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디는 CloudCacheBackupList를 참조해 주십시오.

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

<getCloudCacheBackupListResponse>
    <requestId>94edea29-9c1e-44f5-9e9c-120f22688ca1</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudCacheBackupList>
        <cloudCacheBackup>
            <cloudCacheInstanceNo>****890</cloudCacheInstanceNo>
            <cloudCacheServiceName>test-****</cloudCacheServiceName>
            <backupFileRetentionPeriod>1</backupFileRetentionPeriod>
            <backupTime>00:30</backupTime>
            <backupSize>302</backupSize>
            <lastBackupDate>2021-05-25T00:00:00+0900</lastBackupDate>
            <backupType>
                <code>SIMPLE</code>
                <codeName>CLOUD CACHE(VPC) Cluster Backup Type</codeName>
            </backupType>
            <shardCount>1</shardCount>
        </cloudCacheBackup>
    </cloudCacheBackupList>
</getCloudCacheBackupListResponse>

getCloudRedisBackupList API

getCloudRedisBackupList API의 요청, 응답 형식을 설명합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET | POST /vredis/v2/getCloudRedisBackupList

요청 헤더

Cloud DB for Cache (VPC) API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud DB for Cache (VPC) 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
regionCode String Optional 조회할 Cloud DB for Cache 시스템 백업 리스트의 리전 코드
  • getRegionList 참조
  • getRegionList 조회 결과의 첫 번째 리전(기본값)
responseFormatType String Optional 응답 결과의 형식
  • xml (기본값) | json

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ncloud.apigw.gov-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}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디는 CloudRedisBackupList를 참조해 주십시오.

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

  • 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"
        }
    }
    
  • responseFormatType=xml (기본값) 일 때

    <?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>