getCloudPostgresqlBackupList

VPC環境で利用できます。

Cloud DB for PostgreSQLインスタンスのバックアップリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

Cloud DB for PostgreSQL (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for PostgreSQL (VPC)のリクエストヘッダをご参照ください。

リクエストパラメータ

パラメータの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

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

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、CloudPostgresqlBackupListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

• 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"
    }
}

• responseFormatType=xml(デフォルト)の場合

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