Cloud DB for Cache 백업 파일을 Object Storage로 전송합니다.
백업 파일을 Object Storage로 전송하기 전에 백업 파일을 저장하고, 검색하기 위한 Object Storage 버킷이 생성되어 있어야 합니다. 자세한 내용은 Object Storage 가이드를 참조해 주십시오.
exportBackupToObjectStorage API
exportBackupToObjectStorage API의 요청, 응답 형식을 설명합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET, POST | /exportBackupToObjectStorage |
요청 헤더
Cloud DB for Cache (VPC) API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Cloud DB for Cache (VPC) 요청 헤더를 참조해 주십시오.
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| regionCode | No | String | - 리전 코드 regionCode는 getRegionList 액션을 통해서 획득 가능 Default : getRegionList 조회 결과의 첫 번째 리전을 선택 |
|
| fileName | Yes | String | - 백업 파일 이름 fileName은 getCloudCacheBackupDetailList, getCloudCacheManualBackupDetailList 액션을 통해서 획득 가능 |
|
| bucketName | Yes | String | - Object Storage 버킷 이름 bucketName은 getCloudCacheBucketList 액션을 통해서 획득 가능 |
|
| cloudCacheInstanceNo | Yes | String | - Cloud DB for Cache 인스턴스 번호 cloudCacheInstanceNo는 getCloudCacheInstanceList 액션을 통해서 획득 가능 |
|
| backupTypeMode | Yes | String | - Cloud DB for Cache 백업 유형 Cloud DB for Cache의 백업 유형 결정 Options: SYSTEM, MANUAL |
|
| responseFormatType | No | String | - 응답 결과의 포맷 타입 Options: xml | json Default: xml |
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://ncloud.apigw.fin-ntruss.com/vcache/v2/exportBackupToObjectStorage
?regionCode=FKR
&fileName=2021****
&bucketName=cache-******
&cloudCacheInstanceNo=****821
&backupTypeMode=SYSTEM'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 상태 코드
네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
responseFormatType=json일 때
{
"exportBackupToObjectStorageResponse": {
"requestId": "18fe5b24-2663-4cc7-8a2a-aa0f44c0c46c",
"returnCode": "0",
"returnMessage": "success"
}
}
responseFormatType=xml(기본값) 일 때
<exportBackupToObjectStorageResponse>
<requestId>fb01982a-8107-4a13-ac0d-1720f551cc61</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
</exportBackupToObjectStorageResponse>
exportBackupToObjectStorage API
exportBackupToObjectStorage API의 요청, 응답 형식을 설명합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | POST | /vredis/v2/exportBackupToObjectStorage |
요청 헤더
Cloud DB for Cache API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud DB for Cache 요청 헤더를 참조해 주십시오.
요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
regionCode |
String | Optional | 백업 파일을 Object Storage로 전송할 Cloud DB for Cache 인스턴스의 리전 코드
|
fileName |
String | Required | 백업 파일 이름 |
bucketName |
String | Required | 백업 파일이 전송될 Object Storage 버킷 이름 |
cloudRedisInstanceNo |
String | Required | Cloud DB for Cache 인스턴스 번호 |
backupTypeMode |
String | Required | Cloud DB for Cache 백업 유형
|
responseFormatType |
String | Optional | 응답 결과의 형식
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://fin-ncloud.apigw.fin-ntruss.com/vredis/v2/exportBackupToObjectStorage
?regionCode=FKR
&fileName=20240702
&bucketName=redis-backup
&cloudRedisInstanceNo=****511
&backupTypeMode=SYSTEM' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 상태 코드
Cloud DB for Cache API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud DB for Cache 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
responseFormatType=json일 때
{
"exportBackupToObjectStorageResponse": {
"requestId": "afee84ad-****-****-****-d4b359e85dca",
"returnCode": "0",
"returnMessage": "success"
}
}
responseFormatType=xml(기본값) 일 때
<?xml version="1.0" encoding="UTF-8"?>
<exportBackupToObjectStorageResponse>
<requestId>afee84ad-****-****-****-d4b359e85dca</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
</exportBackupToObjectStorageResponse>