Cloud DB for PostgreSQL (VPC)の概要

Prev Next

VPC環境で利用できます。

Cloud DB for PostgreSQLは、PostgreSQLデータベースを簡単に構築して自動的に管理できます。NAVERの最適化設定で安定的に運用し、障害が発生すると自動復旧する完全管理型クラウドデータベースサービスです。Cloud DB for PostgreSQLでは、データベース管理機能関連の APIを RESTful形式で提供します。

Cloud DB for PostgreSQLの共通設定

Cloud DB for PostgreSQL APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

https://ncloud.apigw.ntruss.com/vpostgresql/v2

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
  • x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
  • Access Keyの発行と確認: 認証キーの作成を参照
  • サブアカウントの Access Key発行と確認: サブアカウントの作成を参照
  • x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名
  • Secret Keyの発行と確認: 認証キーの作成を参照
  • 署名の作成: シグネチャーの作成を参照
  • レスポンス

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

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

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

    Cloud DB for PostgreSQL API

    Cloud DB for PostgreSQL APIサービスで提供する APIの説明は次の通りです。

    API 説明
    addCloudPostgresqlDatabaseList Cloud DB for PostgreSQLデータベースを追加
    addCloudPostgresqlUserList Cloud DB for PostgreSQL DBユーザーを追加
    changeCloudPostgresqlUserList Cloud DB for PostgreSQL DB User情報
    createCloudPostgresqlInstance Cloud DB for PostgreSQLインスタンスを作成
    createCloudPostgresqlReadReplicaInstance Cloud DB for PostgreSQL Read Replicaサーバインスタンスを作成
    deleteCloudPostgresqlDatabaseList Cloud DB for PostgreSQLデータベースを削除
    deleteCloudPostgresqlInstance Cloud DB for PostgreSQLインスタンスを削除
    deleteCloudPostgresqlReadReplicaInstance Cloud DB for PostgreSQL Read Replicaサーバインスタンスを削除
    deleteCloudPostgresqlUserList Cloud DB for PostgreSQL DBユーザーを削除
    exportBackupToObjectStorage Cloud DB for PostgreSQLバックアップファイルをObject Storageに転送
    exportDbServerLogToObjectStorage Cloud DB for PostgreSQLデータベースサーバログファイルをObject Storageに転送
    getCloudPostgresqlBackupDetailList Cloud DB for PostgreSQLバックアップ詳細リストを照会
    getCloudPostgresqlBackupList Cloud DB for PostgreSQLバックアップリストを照会
    getCloudPostgresqlBucketList Cloud DB for PostgreSQLで使用可能な Object Storageバケットリストを照会
    getCloudPostgresqlDatabaseList Cloud DB for PostgreSQL Databaseリストを照会
    getCloudPostgresqlImageProductList Cloud DB for PostgreSQL商品コードリストを照会
    getCloudPostgresqlInstanceDetail Cloud DB for PostgreSQLインスタンスの詳細情報を照会
    getCloudPostgresqlInstanceList Cloud DB for PostgreSQLインスタンスリストを照会
    getCloudPostgresqlProductList Cloud DB for PostgreSQLサーバスペックコードリストを照会
    getCloudPostgresqlTargetSubnetList Cloud DB for PostgreSQLで使用可能な Subnetリストを照会
    getCloudPostgresqlTargetVpcList Cloud DB for PostgreSQLで使用可能な VPCリストを照会
    getCloudPostgresqlUserList Cloud DB for PostgreSQL DB Userリストを照会
    getDbServerLogList Cloud DB for PostgreSQLデータベースサーバログリストを照会
    rebootCloudPostgresqlServerInstance Cloud DB for PostgreSQLサーバインスタンスを再起動

    Cloud DB for PostgreSQL関連リソース

    Cloud DB for PostgreSQL APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。