getCloudPostgresqlBackupList

Available in VPC

View the list of Cloud DB for PostgreSQL backups.

Commands

The command statement is as follows.

ncloud vpostgresql getCloudPostgresqlBackupList [regionCode] [pageNo] [pageSize] [output]

Parameter

The following describes the parameters.

Parameter	Type	Required	Description	Restrictions
regionCode	String	N	Region code - regionCode can be obtained through the getRegionList action - Default: It selects the first region of the getRegionList search result	-
pageNo	Integer	N	Page number of the paged results - The results can be paged using pageNo and pageSize	- Min: 0
pageSize	Integer	N	Size of each page to be displayed when paging - The results can be paged using pageNo and pageSize - This field must be entered when pageNo is entered	- Min: 1 - Max: 1000
output	String	N	Format type of the response result - Options: xml \| json - Default: json	-

Response

Response data type

CloudPostgresqlBackupList type

CloudPostgresqlBackupList extends CommonResponse	Description
private Integer totalRows;	Total number of lists searched
private List<CloudPostgresqlBackup> cloudPostgresqlBackupList = new ArrayList<>();	Cloud DB for PostgreSQL backup list

CloudPostgresqlBackup type

CloudPostgresqlBackup	Description
private String cloudPostgresqlInstanceNo;	Cloud DB for PostgreSQL instance number
private String cloudPostgresqlServiceName;	Cloud DB for PostgreSQL service name
private String backupType;	Backup type
private Integer backupRetention;	Backup file retention period
private String backupTime;	Backup time
private Long backupSize;	Backup size
private Date lastBackupDate;	Date and time of last backup
private Integer backupFileStorageCount;	Number of backup files retained

Examples

It describes call and response examples.

Call examples

The following is a call example.

ncloud vpostgresql getCloudPostgresqlBackupList --regionCode KR

Response example

The following is a sample response.

When the response result format type (output) is JSON

{
  "getCloudPostgresqlBackupListResponse": {
    "requestId": "2086d40d-d152-49a7-aa26-effaecb5a616",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": "1",
    "cloudPostgresqlBackupList": [
      {
        "cloudPostgresqlInstanceNo": "****890",
        "cloudPostgresqlServiceName": "test-****",
        "backupType": "USER",
        "backupRetention": "10",
        "backupTime": "02:00",
        "backupSize": "571482767",
        "lastBackupDate": "2021-05-28T02:10:00+0900",
        "backupFileStorageCount": 5
      }
    ]
  }
}

When the response result format type (output) is XML

<getCloudPostgresqlBackupListResponse>
    <requestId>2086d40d-d152-49a7-aa26-effaecb5a616</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudPostgresqlBackupList>
        <cloudPostgresqlBackup>
            <cloudPostgresqlInstanceNo>****890</cloudPostgresqlInstanceNo>
            <cloudPostgresqlServiceName>test-****</cloudPostgresqlServiceName>
            <backupType>USER</backupType>
            <backupRetention>10</backupRetention>
            <backupTime>02:00</backupTime>
            <backupSize>571482767</backupSize>
            <lastBackupDate>2021-05-28T02:10:00+0900</lastBackupDate>
            <backupFileStorageCount>5</backupFileStorageCount>
        </cloudPostgresqlBackup>
    </cloudPostgresqlBackupList>
</getCloudPostgresqlBackupListResponse>

Documentation Index