getCloudPostgresqlBackupDetailList

Available in VPC

Get Cloud DB for PostgreSQL instance backup details in a list.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
GET, POST	/getCloudPostgresqlBackupDetailList

Request headers

For headers common to all Cloud DB for PostgreSQL (VPC) APIs, see Cloud DB for PostgreSQL (VPC) request headers.

Request parameter

The following describes the parameters.

Field	Type	Required	Description
`regionCode`	String	Optional	Region code Region code of the Cloud DB for PostgreSQL server instance to view Check through getRegionList First Region of the `getRegionList` query result (default)
`cloudPostgresqlInstanceNo`	String	Required	Cloud DB for PostgreSQL instance number Check through getCloudPostgresqlInstanceList
`pageNo`	Integer	Optional	Page numbers in paged results Page the result values using `pageNo` and `pageSize` 0 (minimum)
`pageSize`	Integer	Conditional	Number of results to display on a page Page the result values using `pageNo` and `pageSize` Required when entering `pageNo` 1 - 1000
`responseFormatType`	String	Optional	Format of the response result `xml` (default) \| `json`

Request example

The following is a sample request.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vpostgresql/v2/getCloudPostgresqlBackupDetailList
?regionCode=KR
&cloudPostgresqlInstanceNo=****925' 
--header 'x-ncp-apigw-timestamp: {Timestamp}' 
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response body

See CloudPostgresqlBackupDetailList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

If responseFormatType=json

{
    "getCloudPostgresqlBackupDetailListResponse": {
        "totalRows": 1,
        "cloudPostgresqlBackupDetailList": [
            {
                "fileName": "91839",
                "startTime": "2024-06-03T11:26:34+0900",
                "endTime": "2024-06-03T11:26:42+0900",
                "backupSize": 4196999,
                "dataStorageSize": 10737418240,
                "archivedWalFileSize": 2024301
            }
        ],
        "requestId": "0edb0365-6e13-464d-bcc1-1c3f335eec25",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

If responseFormatType=xml (default)

<?xml version="1.0" encoding="UTF-8"?>
<getCloudPostgresqlBackupDetailListResponse>
    <requestId>b41efca4-****-****-****-24ef4eed8410</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudPostgresqlBackupDetailList>
        <cloudPostgresqlBackupDetail>
            <fileName>91839</fileName>
            <startTime>2024-06-03T11:26:34+0900</startTime>
            <endTime>2024-06-03T11:26:42+0900</endTime>
            <backupSize>4196999</backupSize>
            <dataStorageSize>10737418240</dataStorageSize>
            <archivedWalFileSize>2024301</archivedWalFileSize>
        </cloudPostgresqlBackupDetail>
    </cloudPostgresqlBackupDetailList>
</getCloudPostgresqlBackupDetailListResponse>