getCloudMongoDbBackupList

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

Cloud DB for MongoDB 인스턴스의 백업 목록을 조회합니다.

요청

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

메서드	URI
GET \| POST	/vmongodb/v2/getCloudMongoDbBackupList

참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`regionCode`	String	Optional	조회할 Cloud DB for MongoDB 인스턴스의 리전 코드 getRegionList 참조 `getRegionList` 조회 결과의 첫 번째 리전(기본값)
`pageNo`	Integer	Optional	페이징 처리된 결과의 페이지 번호 `pageNo`, `pageSize`를 이용하여 페이징 처리 0 (최소)
`pageSize`	Integer	Conditional	한 페이지에 보여줄 결과 개수 `pageNo`, `pageSize`를 이용하여 페이징 처리 `pageNo` 입력 시 필수 입력 1~1000
`responseFormatType`	String	Optional	응답 결과의 형식 `xml` (기본값) \| `json`

요청 예시

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

curl --location --request GET 'https://ncloud.apigw.gov-ntruss.com/vmongodb/v2/getCloudMongoDbBackupList
?regionCode=KR
&pageNo=0
&pageSize=1
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

응답 상태 코드

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

응답 예시

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

responseFormatType=json 일 때

{
    "getCloudMongoDbBackupListResponse": {
        "totalRows": 2,
        "cloudMongoDbBackupList": [
            {
                "cloudMongoDbInstanceNo": "2512****",
                "cloudMongoDbServiceName": "mongo002",
                "backupFileRetentionPeriod": 1,
                "backupTime": "02:00",
                "backupSize": 16384,
                "lastBackupDate": "2024-07-03T02:00:02+0900"
            }
        ],
        "requestId": "c5afd2a2-****-****-****-87f172c022de",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

responseFormatType=xml (기본값) 일 때

<?xml version="1.0" encoding="UTF-8"?>
<getCloudMongoDbBackupListResponse>
    <requestId>c5afd2a2-****-****-****-87f172c022de</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <cloudMongoDbBackupList>
        <cloudMongoDbBackup>
            <cloudMongoDbInstanceNo>2512****</cloudMongoDbInstanceNo>
            <cloudMongoDbServiceName>mongo002</cloudMongoDbServiceName>
            <backupFileRetentionPeriod>1</backupFileRetentionPeriod>
            <backupTime>02:00</backupTime>
            <backupSize>16384</backupSize>
            <lastBackupDate>2024-07-03T02:00:02+0900</lastBackupDate>
        </cloudMongoDbBackup>
    </cloudMongoDbBackupList>
</getCloudMongoDbBackupListResponse>