getCloudPostgresqlBackupDetailList

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

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

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

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

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