MENU
      getCloudPostgresqlBackupList

        getCloudPostgresqlBackupList


        Article summary

        Available in VPC

        Get the backup list of a Cloud DB for PostgreSQL instance.

        Request

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

        MethodURI
        GET, POST/getCloudPostgresqlBackupList

        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.

        FieldTypeRequiredDescription
        regionCodeStringOptionalRegion code
        • Region code of the Cloud DB for PostgreSQL server instance to view
        • Check through getRegionList
        • First Region of the getRegionList query result (default)
        pageNoIntegerOptionalPage numbers in paged results
        • Page the result values using pageNo and pageSize
        • 0 (minimum)
        pageSizeIntegerConditionalNumber of results to display on a page
        • Page the result values using pageNo and pageSize
        • Required when entering pageNo
        • 1 - 1000
        responseFormatTypeStringOptionalFormat 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/getCloudPostgresqlBackupList
        ?regionCode=KR'
        --header 'x-ncp-apigw-timestamp: {Timestamp}'
        --header 'x-ncp-iam-access-key: {Access Key}'
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
        Curl

        Response

        The following describes the response format.

        Response body

        See CloudPostgresqlBackupList 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
        {
            "getCloudPostgresqlBackupListResponse": {
                "totalRows": 1,
                "cloudPostgresqlBackupList": [
                    {
                        "cloudPostgresqlInstanceNo": "****925",
                        "cloudPostgresqlServiceName": "test-****",
                        "backupType": "USER",
                        "backupRetention": 10,
                        "backupSize": 10422991,
                        "backupTime": "02:00",
                        "lastBackupDate": "2024-06-04T02:00:19+0900"
                    }
                ],
                "requestId": "d00059bd-****-****-****-a1a3a4dcbf86",
                "returnCode": "0",
                "returnMessage": "success"
            }
        }
        JSON
        • If responseFormatType=xml (default)
        <?xml version="1.0" encoding="UTF-8"?>
        <getCloudPostgresqlBackupListResponse>
            <requestId>d00059bd-****-****-****-a1a3a4dcbf86</requestId>
            <returnCode>0</returnCode>
            <returnMessage>success</returnMessage>
            <totalRows>1</totalRows>
            <cloudPostgresqlBackupList>
                <cloudPostgresqlBackup>
                    <cloudPostgresqlInstanceNo>****925</cloudPostgresqlInstanceNo>
                    <cloudPostgresqlServiceName>test-****</cloudPostgresqlServiceName>
                    <backupType>USER</backupType>
                    <backupRetention>10</backupRetention>
                    <backupSize>10422991</backupSize>
                    <backupTime>02:00</backupTime>
                    <lastBackupDate>2024-06-04T02:00:19+0900</lastBackupDate>
                </cloudPostgresqlBackup>
            </cloudPostgresqlBackupList>
        </getCloudPostgresqlBackupListResponse>
        XML

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.