getCloudMongoDbBackupDetailList

Prev Next

Available in VPC

Overview

Querying a list of available Cloud DB for MongoDB backup details

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: the first region of the getRegionList search results is selected
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
cloudMongoDbInstanceNo Yes String - Cloud DB for MongoDB instance number
You can determine the number of the Cloud DB for MongoDB instance of which backup details are to be searched.
cloudMongoDbInstanceNo can be obtained via the getCloudMongoDbInstanceList action
output No String - Format type of the response result
Options : xml | json
Default : json

Responses

Response data type

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

Examples

Call

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

Responses

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