getCloudMongoDbBackupList

Prev Next

Available in VPC

Overview

Querying a backup list of Cloud DB for MongoDB

Requests

Request parameters

Parameter name Requirement status Type Restrictions Description
regionCode No String - Region code
You can set the region from which the Cloud DB for MongoDB backup details are to be searched
regionCode can be obtained via the getRegionList action
Default: selects the first region of the getRegionList query results
pageNo No Integer Min: 0 - Page number of paged result
Paging can be handled using pageNo and pageSize
pageSize Conditional Integer Min: 1 - Size of each page to be displayed when paging
Paging can be handled using pageNo and pageSize
It must be entered when entering pageNo
output No String - Format type of the response result
Options : xml | json
Default : json

Responses

Response data type

  • CloudMongoDbBackupList type
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;

Examples

Call

ncloud vmongodb getCloudMongoDbBackupList --regionCode KR 

Responses

<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>