getCloudMongoDbBackupList

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

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

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

レスポンス例

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

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

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