---
title: "getCloudMongoDbBackupDetailList"
slug: "database-vmongodb-getcloudmongodbbackupdetaillist"
updated: 2026-09-17T09:57:51Z
published: 2026-09-17T09:57:51Z
canonical: "api.ncloud-docs.com/database-vmongodb-getcloudmongodbbackupdetaillist"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# getCloudMongoDbBackupDetailList

VPC環境で利用できます。

Cloud DB for MongoDBインスタンスのバックアップの詳細情報をリストで照会します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET \| POST | /vmongodb/v2/getCloudMongoDbBackupDetailList |

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

### リクエストヘッダ

Cloud DB for MongoDB (VPC) APIで共通して使用されるヘッダの詳細は、[Cloud DB for MongoDB (VPC)のリクエストヘッダ](/docs/ja/database-vmongodb#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | 照会対象の Cloud DB for MongoDBインスタンスのリージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を参照 - `getRegionList`照会結果の最初のリージョン(デフォルト) |
| `cloudMongoDbInstanceNo` | String | Required | Cloud DB for MongoDBサーバインスタンス番号 - [getCloudMongoDbInstanceList](/docs/ja/database-vmongodb-getcloudmongodbinstancelist)を参照 |
| `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.ntruss.com/vmongodb/v2/getCloudMongoDbBackupDetailList
?regionCode=KR
&cloudMongoDbInstanceNo=2512****
&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}'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの詳細は、[CloudMongoDbBackupDetailList](/docs/ja/common-vapidatatype-cloudmongodbbackupdetaillist)をご参照ください。

### レスポンスステータスコード

Cloud DB for MongoDB (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、[Cloud DB for MongoDB (VPC)のレスポンスステータスコード](/docs/ja/database-vmongodb#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

- `responseFormatType=json`の場合

```
{
    "getCloudMongoDbBackupDetailListResponse": {
        "totalRows": 4,
        "cloudMongoDbBackupDetailList": [
            {
                "startTime": "2024-07-03T02:00:01+0900",
                "endTime": "2024-07-03T02:00:06+0900",
                "backupSize": 4096,
                "dataStorageSize": 10737418240,
                "shard": "mongo00****",
                "objectName": "668432166ff724904059****",
                "backupParallel": 1
            }
        ],
        "requestId": "632b0424-****-****-****-138a722d02cc",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
```
- `responseFormatType=xml`(デフォルト)の場合

```
<?xml version="1.0" encoding="UTF-8"?>
<getCloudMongoDbBackupDetailListResponse>
    <requestId>632b0424-****-****-****-138a722d02cc</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>4</totalRows>
    <cloudMongoDbBackupDetailList>
        <cloudMongoDbBackupDetail>
            <startTime>2024-07-03T02:00:01+0900</startTime>
            <endTime>2024-07-03T02:00:06+0900</endTime>
            <backupSize>4096</backupSize>
            <dataStorageSize>10737418240</dataStorageSize>
            <shard>mongo00****</shard>
            <objectName>668432166ff724904059****</objectName>
            <backupParallel>1</backupParallel>
        </cloudMongoDbBackupDetail>
    </cloudMongoDbBackupDetailList>
</getCloudMongoDbBackupDetailListResponse>
```