getCloudMongoDbBackupList

Available in VPC

Get the backup list of a Cloud DB for MongoDB instance.

Request

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

Method	URI
GET, POST	/getCloudMongoDbBackupList

Request headers

For headers common to all Cloud DB for MongoDB (VPC) APIs, see Cloud DB for MongoDB (VPC) request headers.

Request parameter

The following describes the parameters.

Field	Type	Required	Description
`regionCode`	String	Optional	Region code of the Cloud DB for MongoDB instance to view Check through getRegionList First Region of the `getRegionList` query result (default)
`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 - 1000
`responseFormatType`	String	Optional	Format of the response result `xml` (default) \| `json`

Request example

The following is a sample request.

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

Response

The following describes the response format.

Response body

See CloudMongoDbBackupList 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 responseFormetType=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"
    }
}

If responseFormetType=xml (default)

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