VPC環境で利用できます。
Cloud DB for PostgreSQLインスタンスのバックアップファイルを Object Storageに転送します。
バックアップファイルを Object Storageに転送する前に、バックアップファイルの保存・検索用の Object Storageバケットが作成されている必要があります。詳細は、Object Storageガイドをご参照ください。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | POST | /vpostgresql/v2/exportBackupToObjectStorage |
参考
ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。
リクエストヘッダ
Cloud DB for PostgreSQL (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for PostgreSQL (VPC)のリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
regionCode |
String | Optional | リージョンコード
|
fileName |
String | Required | バックアップファイル名 |
bucketName |
String | Required | バックアップファイルが転送される Object Storageバケット名 |
cloudPostgresqlInstanceNo |
String | Required | Cloud DB for PostgreSQLインスタンス番号 |
responseFormatType |
String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vpostgresql/v2/exportBackupToObjectStorage
?regionCode=KR
&fileName=20210528
&bucketName=bucket***
&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}'
レスポンス
レスポンス形式を説明します。
レスポンスステータスコード
Cloud DB for PostgreSQL (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud DB for PostgreSQL (VPC)のレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
responseFormatType=jsonの場合
{
"exportBackupToObjectStorageResponse": {
"requestId": "5ee62bcc-****-****-****-b826ca85ef50",
"returnCode": "0",
"returnMessage": "success"
}
}
responseFormatType=xml(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<exportBackupToObjectStorageResponse>
<requestId>5ee62bcc-****-****-****-b826ca85ef50</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
</exportBackupToObjectStorageResponse>