getCloudPostgresqlBackupDetailList

Prev Next

Available in VPC

Views the detailed list of Cloud DB for PostgreSQL backups.

Commands

The text of the command is as follows:

ncloud vpostgresql getCloudPostgresqlBackupDetailList [regionCode] [cloudPostgresqlInstanceNo] [pageNo] [pageSize] [output]

Parameter

The following is a description on parameters.

Parameter Type Requirement status Description Restrictions
regionCode String N Region code
- regionCode can be obtained via the getRegionList action
- Default: selects the first region of the getRegionList search results
-
cloudPostgresqlInstanceNo String Y Cloud DB for PostgreSQL instance number
- cloudPostgresqlInstanceNo can be obtained via the getCloudPostgresqlInstanceList action
-
pageNo Integer N Page number of paged results
- The results can be paged using pageNo and pageSize
- Min: 0
pageSize Integer N Size of each page to be shown during paging
- The results can be paged using pageNo and pageSize
- Enter it every time you enter pageNo
- Min: 1
- Max: 1000
output String N Format type of the response result
- options: xml | json
- default: json
-

Responses

Response data type

  • CloudPostgresqlBackupDetailList type
CloudPostgresqlBackupDetailList extends CommonResponse Description
private Integer totalRows; Total number of items viewed
private List<CloudPostgresqlBackupDetail> cloudPostgresqlBackupDetailList = new ArrayList<>(); Cloud DB for PostgreSQL backup detail list
  • CloudPostgresqlBackupDetail type
CloudPostgresqlBackupDetail Description
private String fileName; Backup file name
private Date startTime; Backup start time
private Date endTime; Backup end time
private Long backupSize; Backup size
private Long dataStorageSize; Data storage size
private Long archivedWalFileSize; Archived Wal File size

Examples

Describes examples of recalls and responses.

Recall examples

The following are examples of recalls.

ncloud vpostgresql getCloudPostgresqlBackupDetailList --regionCode KR --cloudPostgresqlInstanceNo ****890

Response examples

The following are examples of responses.

If the response shows that format type (output) is json

{
  "getCloudPostgresqlBackupDetailListResponse": {
    "requestId": "11ca8ac0-841c-4776-aef5-3feb6eb9440e",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": "1",
    "cloudPostgresqlBackupDetailList": [
      {
        "fileName": "20210528",
        "startTime": "2021-05-28T02:10:00+0900",
        "endTime": "2021-05-28T02:10:10+0900",
        "backupSize": "571482767",
        "dataStorageSize": "10737418240",
        "archivedWalFileSize": "0"
      }
    ]
  }
}

If the response shows that format type (output) is xml

<getCloudPostgresqlBackupDetailListResponse>
    <requestId>d76f9b88-fb9f-44b9-b7a1-f19b4710681e</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudPostgresqlBackupDetailList>
        <cloudPostgresqlBackupDetail>
            <fileName>20210528</fileName>
            <startTime>2021-05-28T02:10:00+0900</startTime>
            <endTime>2021-05-28T02:10:10+0900</endTime>
            <backupSize>571482767</backupSize>
            <dataStorageSize>10737418240</dataStorageSize>
            <archivedWalFileSize>0</archivedWalFileSize>
        </cloudPostgresqlBackupDetail>
    </cloudPostgresqlBackupDetailList>
</getCloudPostgresqlBackupDetailListResponse>