Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getCloudMongoDbBackupList

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を入力する際に必ず入力
output No String - レスポンス結果のフォーマットタイプ
Options : xml | json
Default : json

レスポンス

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

  • CloudMongoDbBackupListタイプ
CloudMongoDbBackupList extends CommonResponse
private Integer totalRows;
private List<CloudMongoDbBackup> cloudMongoDbInstanceList = new ArrayList<>();
CloudMongoDbBackup
private String cloudMongoDbInstanceNo;
private String cloudMongoDbServiceName;
private Integer backupFileRetentionPeriod;
private String backupTime;
private Long backupSize;
private Date lastBackupDate;

呼び出し

ncloud vmongodb getCloudMongoDbBackupList --regionCode KR 

レスポンス

<getCloudMongoDbBackupListResponse>
    <requestId>94edea29-9c1e-44f5-9e9c-120f22688ca1</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMongoDbBackupList>
        <cloudMongoDbBackup>
            <cloudMongoDbInstanceNo>****890</cloudMongoDbInstanceNo>
            <cloudMongoDbServiceName>test-****</cloudMongoDbServiceName>
            <backupFileRetentionPeriod>1</backupFileRetentionPeriod>
            <backupTime>00:30</backupTime>
            <backupSize>302</backupSize>
            <lastBackupDate>2021-05-25T00:00:00+0900</lastBackupDate>
        </cloudMongoDbBackup>
    </cloudMongoDbBackupList>
</getCloudMongoDbBackupListResponse>