PostgreSQL(DBaaS)

PostgreSQL(DBaaS)

Overview

Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of PostgreSQL(DBaaS) service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20260531

OpenAPI URL

https://postgresql.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

API Version History

1.1

API version 1.1 release for PostgreSQL(DBaaS)

Changes

  • [Changed] GET /postgresql/1.0/clusters/{cluster_id} - ShowCluster API has been changed.
    • Response model has been changed to PostgresqlClusterDetailResponseV1Dot1.
    • The following fields are added to the response:
      • is_kernel_patchable
  • [New] PUT /postgresql/1.1/clusters/{cluster_id}/kernel-upgrade - UpgradeKernel API has been added.
  • [New] PUT /postgresql/1.1/clusters/{cluster_id}/patch - PatchMinorVersion API has been added.

1.0

Initial API release for PostgreSQL(DBaaS)

Changes

  • [New] POST /postgresql/1.0/clusters - CreateCluster API has been added.
  • [New] GET /postgresql/1.0/clusters - ListClusters API has been added.
  • [New] GET /postgresql/1.0/clusters/{cluster_id} - ShowCluster API has been added.
  • [New] DELETE /postgresql/1.0/clusters/{cluster_id} - DeleteCluster API has been added.
  • [New] PUT /postgresql/1.0/clusters/{cluster_id}/parameters - SetParameterValues API has been added.
  • [New] GET /postgresql/1.0/clusters/{cluster_id}/parameters - ListParameterValues API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/parameters/sync - SyncParameterValues API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/backups - SetBackup API has been added.
  • [New] DELETE /postgresql/1.0/clusters/{cluster_id}/backups - UnsetBackup API has been added.
  • [New] GET /postgresql/1.0/clusters/{cluster_id}/backup-histories - ListBackupHistories API has been added.
  • [New] PUT /postgresql/1.0/clusters/{cluster_id}/backup-histories - RemoveBackupHistories API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/restore - CreateRestore API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/restart - RestartCluster API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/start - StartCluster API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/stop - StopCluster API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/switchover - SwitchoverCluster API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/sync-state - SyncClusterState API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/promote - PromoteReplicaCluster API has been added.
  • [New] GET /postgresql/1.0/clusters/{cluster_id}/replicas - ListReplicas API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/replicas - CreateReplica API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/replicas/other-region - CreateOtherRegionReplica API has been added.
  • [New] POST /postgresql/1.0/clusters/{origin_cluster_id}/sync-replica-state - SyncReplicaState API has been added.
  • [New] POST /postgresql/1.0/clusters/{replica_cluster_id}/reset-replica - ResetReplica API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/security-group-rules - SetSecurityGroupRules API has been added.
  • [New] DELETE /postgresql/1.0/clusters/{cluster_id}/archive - DeleteArchiveLog API has been added.
  • [New] GET /postgresql/1.0/clusters/{cluster_id}/archive - ShowArchiveConfig API has been added.
  • [New] PUT /postgresql/1.0/clusters/{cluster_id}/archive - SetArchiveConfig API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/archive/sync - SyncArchiveConfig API has been added.
  • [New] PUT /postgresql/1.0/clusters/{cluster_id}/audit-log - SetAuditLog API has been added.
  • [New] GET /postgresql/1.0/clusters/{cluster_id}/log-export-configs - ListLogExportConfigs API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/log-export-configs - RegisterLogExportConfig API has been added.
  • [New] DELETE /postgresql/1.0/clusters/{cluster_id}/log-export-configs/{log_type} - UnregisterLogExportConfig API has been added.
  • [New] PUT /postgresql/1.0/clusters/{cluster_id}/log-export-configs/{log_type} - SetLogExportConfig API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/log-export-configs/{log_type}/export - ExportLog API has been added.
  • [New] DELETE /postgresql/1.0/clusters/{cluster_id}/maintenance - UnsetMaintenance API has been added.
  • [New] POST /postgresql/1.0/clusters/{cluster_id}/maintenance - SetMaintenance API has been added.
  • [New] GET /postgresql/1.0/engine-versions - ListEngineVersions API has been added.
  • [New] GET /postgresql/1.0/engine-versions/{dbaas_engine_version_id}/properties - ListEngineVersionProperties API has been added.
  • [New] POST /postgresql/1.0/instance-groups/{instance_group_id}/block-storage-groups - AddBlockStorages API has been added.
  • [New] POST /postgresql/1.0/instance-groups/{instance_group_id}/resize - SetServerType API has been added.
  • [New] POST /postgresql/1.0/block-storage-groups/{block_storage_group_id}/resize - SetBlockStorageSize API has been added.
  • [New] GET /postgresql/1.0/parameter-groups - ListParameterGroups API has been added.
  • [New] GET /postgresql/1.0/parameters - ListParameters API has been added.
  • [New] GET /postgresql/1.0/server-types - ListServerTypes API has been added.
  • [New] GET /postgresql/1.0/requests/{request_id} - ShowRequest API has been added.