getCloudMongoDbBackupDetailList

Prev Next

VPC環境で利用できます。

概要

使用可能な Cloud DB for MongoDBのバックアップ詳細情報リストを照会します。

リクエスト

リクエストパラメータ

パラメータ名 要否 タイプ 制約事項 説明
regionCode No String - リージョンコード
Cloud DB for MongoDBのバックアップ詳細情報リストを照会するリージョン(Region)を決定可能
regionCodeは、getRegionListアクションを通じて取得可能
Default: getRegionList照会結果の最初のリージョンを選択
pageNo No Integer Min: 0 - ページング結果のページ番号
結果値を pageNo、pageSizeを利用してページング処理可能
pageSize Conditional Integer Min: 1 - ページング時に表示する各ページのサイズ
結果値を pageNo、pageSizeを利用してページング処理可能
pageNoを入力する際に必ず入力
cloudMongoDbInstanceNo Yes String - Cloud DB for MongoDBのインスタンス番号
バックアップ詳細情報を照会する Cloud DB for MongoDBインスタンス番号を決定可能
cloudMongoDbInstanceNoは、getCloudMongoDbInstanceListアクションを通じて取得可能
output No String - レスポンス結果のフォーマットタイプ
Options : xml | json
Default : json

レスポンス

レスポンスデータのタイプ

  • CloudMongoDbBackupDetailListタイプ
CloudMongoDbBackupDetailList extends CommonResponse
private Integer totalRows;
private List<CloudMongoDbBackupDetail> cloudMongoDbInstanceList = new ArrayList<>();
CloudMongoDbBackupDetail
private Date startTime;
private Date endTime;
private Long backupSize;
private Long dataStorageSize;
private String shard;

例

呼び出し

ncloud vmongodb getCloudMongoDbBackupDetailList --regionCode KR --cloudMongoDbInstanceNo ****821 --pageNo 0 --pageSize 10

レスポンス

<getCloudMongoDbBackupDetailListResponse>
    <requestId>2e320a76-469e-4f28-81b0-a03ea6c8053b</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMongoDbBackupDetailList>
        <cloudMongoDbBackupDetail>
            <startTime>2021-05-12T16:00:00+0900</startTime>
            <endTime>2021-05-12T16:00:00+0900</endTime>
            <backupSize>116</backupSize>
            <dataStorageSize>10737418240</dataStorageSize>
            <shard>****test001</shard>
        </cloudMongoDbBackupDetail>
    </cloudMongoDbBackupDetailList>
</getCloudMongoDbBackupDetailListResponse>