getCloudMongoDbBackupDetailList

VPC環境で利用できます。

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

リクエスト

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

リクエストヘッダ

Cloud DB for MongoDB (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MongoDB (VPC)のリクエストヘッダをご参照ください。

リクエストパラメータ

パラメータの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

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をご参照ください。

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

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

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

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

• responseFormetType=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>