This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

PostgreSQL(DBaaS)

Overview

Provides a Command-line Interface (CLI) 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 CLI.

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

CLI Version History

1.1

CLI version 1.1 release for PostgreSQL(DBaaS)

Changes

  • [Changed] postgresql show cluster - command has been changed.
    • Response model has been changed to PostgresqlClusterDetailResponseV1Dot1.
    • The following fields are added to the response:
      • is_kernel_patchable
  • [New] postgresql patch minor version - command has been added.
  • [New] postgresql upgrade kernel - command has been added.

1.0

Initial CLI release for PostgreSQL(DBaaS)

Changes

  • [New] postgresql add block storages - command has been added.
  • [New] postgresql create cluster - command has been added.
  • [New] postgresql create other region replica - command has been added.
  • [New] postgresql create replica - command has been added.
  • [New] postgresql create restore - command has been added.
  • [New] postgresql delete archive log - command has been added.
  • [New] postgresql delete cluster - command has been added.
  • [New] postgresql export log - command has been added.
  • [New] postgresql list backup histories - command has been added.
  • [New] postgresql list clusters - command has been added.
  • [New] postgresql list engine version properties - command has been added.
  • [New] postgresql list engine versions - command has been added.
  • [New] postgresql list log export configs - command has been added.
  • [New] postgresql list parameter groups - command has been added.
  • [New] postgresql list parameter values - command has been added.
  • [New] postgresql list parameters - command has been added.
  • [New] postgresql list replicas - command has been added.
  • [New] postgresql list server types - command has been added.
  • [New] postgresql promote replica cluster - command has been added.
  • [New] postgresql register log export config - command has been added.
  • [New] postgresql remove backup histories - command has been added.
  • [New] postgresql reset replica - command has been added.
  • [New] postgresql restart cluster - command has been added.
  • [New] postgresql set archive config - command has been added.
  • [New] postgresql set audit log - command has been added.
  • [New] postgresql set backup - command has been added.
  • [New] postgresql set block storage size - command has been added.
  • [New] postgresql set log export config - command has been added.
  • [New] postgresql set maintenance - command has been added.
  • [New] postgresql set parameter values - command has been added.
  • [New] postgresql set security group rules - command has been added.
  • [New] postgresql set server type - command has been added.
  • [New] postgresql show archive config - command has been added.
  • [New] postgresql show cluster - command has been added.
  • [New] postgresql show request - command has been added.
  • [New] postgresql start cluster - command has been added.
  • [New] postgresql stop cluster - command has been added.
  • [New] postgresql switchover cluster - command has been added.
  • [New] postgresql sync archive config - command has been added.
  • [New] postgresql sync cluster state - command has been added.
  • [New] postgresql sync parameter values - command has been added.
  • [New] postgresql sync replica state - command has been added.
  • [New] postgresql unregister log export config - command has been added.
  • [New] postgresql unset backup - command has been added.
  • [New] postgresql unset maintenance - command has been added.

1 - CLIs

1.1 - Add Block Storages

1.1.1 - 1.1

scp-cli postgresql block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]

Description

Add Block Storages.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole typeOS
volume_type
optional
stringVolume type-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.1.2 - 1.0

scp-cli postgresql block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]

Description

Add Block Storages.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole typeOS
volume_type
optional
stringVolume type-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.2 - Create Cluster

1.2.1 - 1.1

scp-cli postgresql cluster create
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--ha_enabled <value>]
[--nat_enabled <value>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_encoding <value>]
[--database_locale <value>]
[--database_port <value>]
[--archive_frequency_minute <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_name
required
stringDatabase Name-
timezone
required
stringTimezoneAsia/Seoul
subnet_id
required
stringSubnet ID1ddd7f1e4a8a43ed8b82d70cade0b321
name
required
stringCluster namemycluster
instance_name_prefix
required
stringInstance name prefixmyprefix
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}'
dbaas_engine_version_id
required
stringDBaaS engine version IDc1b856dd12754c0ba2614a39d0ed3ad1
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
ha_enabled
optional
booleanHA availability-
nat_enabled
optional
booleanNAT availability-
origin_cluster_id
optional
stringOrigin cluster ID-
tags
optional
arraytag'{"key": "", "value": ""}'
vip_public_ip_id
optional
string(VIP) Public IP ID-
virtual_ip_address
optional
stringVirtual IP address-
audit_enabled
optional
booleanAudit usage state-
database_encoding
optional
stringDatabase encoding-
database_locale
optional
stringDatabase locale information-
database_port
optional
integerDatabase service port-
archive_frequency_minute
optional
stringBackup starting time (minute)-
retention_period_day
optional
stringBackup retention period (day)7
starting_time_hour
optional
stringBackup starting time (hour)2
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.2.2 - 1.0

scp-cli postgresql cluster create
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--ha_enabled <value>]
[--nat_enabled <value>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_encoding <value>]
[--database_locale <value>]
[--database_port <value>]
[--archive_frequency_minute <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_name
required
stringDatabase Name-
timezone
required
stringTimezoneAsia/Seoul
subnet_id
required
stringSubnet ID1ddd7f1e4a8a43ed8b82d70cade0b321
name
required
stringCluster namemycluster
instance_name_prefix
required
stringInstance name prefixmyprefix
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}'
dbaas_engine_version_id
required
stringDBaaS engine version IDc1b856dd12754c0ba2614a39d0ed3ad1
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
ha_enabled
optional
booleanHA availability-
nat_enabled
optional
booleanNAT availability-
origin_cluster_id
optional
stringOrigin cluster ID-
tags
optional
arraytag'{"key": "", "value": ""}'
vip_public_ip_id
optional
string(VIP) Public IP ID-
virtual_ip_address
optional
stringVirtual IP address-
audit_enabled
optional
booleanAudit usage state-
database_encoding
optional
stringDatabase encoding-
database_locale
optional
stringDatabase locale information-
database_port
optional
integerDatabase service port-
archive_frequency_minute
optional
stringBackup starting time (minute)-
retention_period_day
optional
stringBackup retention period (day)7
starting_time_hour
optional
stringBackup starting time (hour)2
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.3 - Create Other region Replica

1.3.1 - 1.1

scp-cli postgresql replica dr create
--cluster_id <value>
--subnet_id <value>
--replicas <value>
--replica_count <value>
--region <value>
--nat_enabled <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Other region Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
subnet_id
required
stringSubnet ID-
replicas
required
arrayReplicas list'{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}'
replica_count
required
integerReplica count-
region
required
stringReplica region-
nat_enabled
required
booleanNAT availability-
allowable_ip_addresses
required
arrayAllowed IP addresses list-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.3.2 - 1.0

scp-cli postgresql replica dr create
--cluster_id <value>
--subnet_id <value>
--replicas <value>
--replica_count <value>
--region <value>
--nat_enabled <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Other region Replica.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
subnet_id
required
stringSubnet ID-
replicas
required
arrayReplicas list'{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}'
replica_count
required
integerReplica count-
region
required
stringReplica region-
nat_enabled
required
booleanNAT availability-
allowable_ip_addresses
required
arrayAllowed IP addresses list-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.4 - Create Replica

1.4.1 - 1.1

scp-cli postgresql replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
replicas
required
arrayReplicas list'{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}'
replica_count
required
integerReplica count-
allowable_ip_addresses
required
arrayAllowed IP addresses list-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.4.2 - 1.0

scp-cli postgresql replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Replica.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
replicas
required
arrayReplicas list'{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}'
replica_count
required
integerReplica count-
allowable_ip_addresses
required
arrayAllowed IP addresses list-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.5 - Create Restore Cluster

1.5.1 - 1.1

scp-cli postgresql restore create
--cluster_id <value>
--server_type_name <value>
--name <value>
--instance_name_prefix <value>
[--allowable_ip_addresses <value>]
[--backup_history_number <value>]
[--backup_recovery_time <value>]
[--block_storage_groups <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Restore Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
server_type_name
required
stringServer type name-
name
required
stringCluster namemycluster
instance_name_prefix
required
stringInstance name prefixmyprefix
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
backup_history_number
optional
stringBackup id202501010000
backup_recovery_time
optional
stringBackup Recovery Time-
block_storage_groups
optional
arrayBlock storage groups list'{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}'
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.5.2 - 1.0

scp-cli postgresql restore create
--cluster_id <value>
--server_type_name <value>
--name <value>
--instance_name_prefix <value>
[--allowable_ip_addresses <value>]
[--backup_history_number <value>]
[--backup_recovery_time <value>]
[--block_storage_groups <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Restore Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
server_type_name
required
stringServer type name-
name
required
stringCluster namemycluster
instance_name_prefix
required
stringInstance name prefixmyprefix
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
backup_history_number
optional
stringBackup id202501010000
backup_recovery_time
optional
stringBackup Recovery Time-
block_storage_groups
optional
arrayBlock storage groups list'{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}'
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.6 - Delete Archive Log

1.6.1 - 1.1

scp-cli postgresql archive log delete
--cluster_id <value>
[--type <value>]

Description

Delete Archive Log.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
stringArchive log typeALL

1.6.2 - 1.0

scp-cli postgresql archive log delete
--cluster_id <value>
[--type <value>]

Description

Delete Archive Log.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
stringArchive log typeALL

1.7 - Export Log

1.7.1 - 1.1

scp-cli postgresql log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.7.2 - 1.0

scp-cli postgresql log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.8 - List Backup Histories

1.8.1 - 1.1

scp-cli postgresql backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]

Description

List Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
limit
optional
integerNumber of backup lists-
page
optional
integerBackup list page-

Responses

NameDescriptionExample
backup_end_atBackup end time
backup_history_numberBackup id
backup_size_gbBackup amount(GB)
backup_start_atBackup start time
backup_stateBackup state
backup_state_detailBackup detail state
software_versionSoftware version

1.8.2 - 1.0

scp-cli postgresql backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]

Description

List Backup Histories.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
limit
optional
integerNumber of backup lists-
page
optional
integerBackup list page-

Responses

NameDescriptionExample
backup_end_atBackup end time
backup_history_numberBackup id
backup_size_gbBackup amount(GB)
backup_start_atBackup start time
backup_stateBackup state
backup_state_detailBackup detail state
software_versionSoftware version

1.9 - List Clusters

1.9.1 - 1.1

scp-cli postgresql cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]

Description

List Clusters.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-
database_name
optional
stringDatabase Name-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

1.9.2 - 1.0

scp-cli postgresql cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]

Description

List Clusters.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-
database_name
optional
stringDatabase Name-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

1.10 - List Engine Version Properties

1.10.1 - 1.1

scp-cli postgresql engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

1.10.2 - 1.0

scp-cli postgresql engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

1.11 - List Engine Versions

1.11.1 - 1.1

scp-cli postgresql engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

1.11.2 - 1.0

scp-cli postgresql engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

1.12 - List Log Export Configs

1.12.1 - 1.1

scp-cli postgresql log export configs list
--cluster_id <value>
[--type <value>]

Description

List Log Export Configs.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
****Log typealert

Responses

NameDescriptionExample
bucket_nameBucket nameexamplebucket
delete_on_exportDelete on exportTrue
is_bucket_deletedBucket deletedFalse
is_registeredLog type registration stateTrue
log_labelLog labelDB Alert Log
log_typeLog typealert
schedule_day_of_monthSchedule day of month28
schedule_day_of_weekSchedule day of weekMON
schedule_frequency_typeSchedule frequency typeDAY
schedule_hourSchedule hour12

1.12.2 - 1.0

scp-cli postgresql log export configs list
--cluster_id <value>
[--type <value>]

Description

List Log Export Configs.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
****Log typealert

Responses

NameDescriptionExample
bucket_nameBucket nameexamplebucket
delete_on_exportDelete on exportTrue
is_bucket_deletedBucket deletedFalse
is_registeredLog type registration stateTrue
log_labelLog labelDB Alert Log
log_typeLog typealert
schedule_day_of_monthSchedule day of month28
schedule_day_of_weekSchedule day of weekMON
schedule_frequency_typeSchedule frequency typeDAY
schedule_hourSchedule hour12

1.13 - List Parameter Groups

1.13.1 - 1.1

scp-cli postgresql parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]

Description

List Parameter Groups.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
major_version
optional
stringSoftware major version-
product_image_type
optional
stringProduct image type-
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter group ID
major_versionSoftware major version
nameParameter group name
product_image_typeProduct image type
product_typeProduct type

1.13.2 - 1.0

scp-cli postgresql parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]

Description

List Parameter Groups.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
major_version
optional
stringSoftware major version-
product_image_type
optional
stringProduct image type-
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter group ID
major_versionSoftware major version
nameParameter group name
product_image_typeProduct image type
product_typeProduct type

1.14 - List Parameter Values

1.14.1 - 1.1

scp-cli postgresql parameter value list
--cluster_id <value>

Description

List Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idParameter id
allows_valueParameter allows value
applied_valueParameter applied value
apply_typeParameter apply type
data_typeParameter data type
default_valueParameter default value
descriptionParameter description
is_modifiableParameter is_modifiable
nameParameter name
software_typeParameter software type

1.14.2 - 1.0

scp-cli postgresql parameter value list
--cluster_id <value>

Description

List Parameter Values.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idParameter id
allows_valueParameter allows value
applied_valueParameter applied value
apply_typeParameter apply type
data_typeParameter data type
default_valueParameter default value
descriptionParameter description
is_modifiableParameter is_modifiable
nameParameter name
software_typeParameter software type

1.15 - List Parameters

1.15.1 - 1.1

scp-cli postgresql parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List Parameters.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
dbaas_parameter_group_id
required
stringParameter group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter id
dbaas_parameter_group_idParameter id
default_valueParameter default value
descriptionParameter description
nameParameter name
software_typeParameter software type

1.15.2 - 1.0

scp-cli postgresql parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List Parameters.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
dbaas_parameter_group_id
required
stringParameter group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter id
dbaas_parameter_group_idParameter id
default_valueParameter default value
descriptionParameter description
nameParameter name
software_typeParameter software type

1.16 - List Replicas

1.16.1 - 1.1

scp-cli postgresql replica list
--cluster_id <value>

Description

List Replicas.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
nameServer name
regionReplica region
replica_stateReplica state
replica_state_detailReplica detail state
synced_atReplica check time

1.16.2 - 1.0

scp-cli postgresql replica list
--cluster_id <value>

Description

List Replicas.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
nameServer name
regionReplica region
replica_stateReplica state
replica_state_detailReplica detail state
synced_atReplica check time

1.17 - List Server Types

1.17.1 - 1.1

scp-cli postgresql engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

1.17.2 - 1.0

scp-cli postgresql engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

1.18 - Patch Minor Version

1.18.1 - 1.1

scp-cli postgresql minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>

Description

Patch Minor Version.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
software_version
required
stringsoftware_version-
backup_before_upgrade
required
booleanbackup_before_upgrade-

1.18.2 - 1.0

scp-cli postgresql minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>

Description

Patch Minor Version.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
software_version
required
stringsoftware_version-
backup_before_upgrade
required
booleanbackup_before_upgrade-

1.19 - Promote Replica Cluster

1.19.1 - 1.1

scp-cli postgresql replica cluster promote
--cluster_id <value>

Description

Promote Replica Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.19.2 - 1.0

scp-cli postgresql replica cluster promote
--cluster_id <value>

Description

Promote Replica Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.20 - Register Log Export Config

1.20.1 - 1.1

scp-cli postgresql log export config register
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--log_type <value>
--delete_on_export <value>
--bucket_name <value>
--access_key <value>

Description

Register Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
log_type
required
stringLog typealert
delete_on_export
required
booleanDelete on exportTrue
bucket_name
required
stringBucket nameexamplebucket
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.20.2 - 1.0

scp-cli postgresql log export config register
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--log_type <value>
--delete_on_export <value>
--bucket_name <value>
--access_key <value>

Description

Register Log Export Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
log_type
required
stringLog typealert
delete_on_export
required
booleanDelete on exportTrue
bucket_name
required
stringBucket nameexamplebucket
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.21 - Remove Backup Histories

1.21.1 - 1.1

scp-cli postgresql backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

1.21.2 - 1.0

scp-cli postgresql backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

1.22 - Reset Replica

1.22.1 - 1.1

scp-cli postgresql replica reset
--replica_cluster_id <value>

Description

Reset Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.22.2 - 1.0

scp-cli postgresql replica reset
--replica_cluster_id <value>

Description

Reset Replica.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.23 - Restart Cluster

1.23.1 - 1.1

scp-cli postgresql cluster restart
--cluster_id <value>

Description

Restart Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.23.2 - 1.0

scp-cli postgresql cluster restart
--cluster_id <value>

Description

Restart Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.24 - Set Archive Config

1.24.1 - 1.1

scp-cli postgresql archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]

Description

Set Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
archive_enabled
required
booleanArchive enabledTrue
retention_period_day
optional
integerBackup retention period (day)-

1.24.2 - 1.0

scp-cli postgresql archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]

Description

Set Archive Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
archive_enabled
required
booleanArchive enabledTrue
retention_period_day
optional
integerBackup retention period (day)-

1.25 - Set Audit Log

1.25.1 - 1.1

scp-cli postgresql audit log set
--cluster_id <value>
--use_audit_log <value>

Description

Set Audit Log.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
use_audit_log
required
booleanuse_audit_log-

1.25.2 - 1.0

scp-cli postgresql audit log set
--cluster_id <value>
--use_audit_log <value>

Description

Set Audit Log.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
use_audit_log
required
booleanuse_audit_log-

1.26 - Set Backup

1.26.1 - 1.1

scp-cli postgresql backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>

Description

Set Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-
archive_frequency_minute
required
stringBackup starting time (minute)-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.26.2 - 1.0

scp-cli postgresql backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>

Description

Set Backup.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-
archive_frequency_minute
required
stringBackup starting time (minute)-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.27 - Set Block Storage Size

1.27.1 - 1.1

scp-cli postgresql block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.27.2 - 1.0

scp-cli postgresql block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.28 - Set Log Export Config

1.28.1 - 1.1

scp-cli postgresql log export config set
--log_type <value>
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--delete_on_export <value>
--access_key <value>

Description

Set Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
delete_on_export
required
booleanDelete on exportTrue
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

1.28.2 - 1.0

scp-cli postgresql log export config set
--log_type <value>
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--delete_on_export <value>
--access_key <value>

Description

Set Log Export Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
delete_on_export
required
booleanDelete on exportTrue
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

1.29 - Set Maintenance

1.29.1 - 1.1

scp-cli postgresql maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.29.2 - 1.0

scp-cli postgresql maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.30 - Set Parameter Values

1.30.1 - 1.1

scp-cli postgresql parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
parameters
required
arrayParameter request list'{"id": "", "new_value": "", "old_value": ""}'

1.30.2 - 1.0

scp-cli postgresql parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
parameters
required
arrayParameter request list'{"id": "", "new_value": "", "old_value": ""}'

1.31 - Set Security Group Rules

1.31.1 - 1.1

scp-cli postgresql security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.31.2 - 1.0

scp-cli postgresql security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.32 - Set Server Type

1.32.1 - 1.1

scp-cli postgresql server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.32.2 - 1.0

scp-cli postgresql server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.33 - Show Archive Config

1.33.1 - 1.1

scp-cli postgresql archive config show
--cluster_id <value>

Description

Show Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

1.33.2 - 1.0

scp-cli postgresql archive config show
--cluster_id <value>

Description

Show Archive Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

1.34 - Show Cluster

1.34.1 - 1.1

scp-cli postgresql cluster show
--cluster_id <value>

Description

Show Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
allowable_ip_addressesAllowed IP addresses list[]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engineDBaaS engine
dbaas_engine_version_nameDBaaS engine version name
ha_enabledHA availability
init_config_optionDB initial configuration option
instance_countInstance Count
instance_groupsInstance groups list[]
is_kernel_patchableWhether the kernel can be patched
maintenance_optionMaintenance option{}
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
nat_enabledNAT availability
origin_cluster_idOrigin cluster ID
product_image_typeProduct image type
product_typeProduct type
replicasReplicas list[]
role_typeRole type{}
service_stateService state
software_versionSoftware version
subnet_idSubnet ID
timezoneTimezone
vip_public_ip_address(VIP) Public IP Address
vip_public_ip_id(VIP) Public IP ID
virtual_ip_addressVirtual IP address

1.34.2 - 1.0

scp-cli postgresql cluster show
--cluster_id <value>

Description

Show Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
allowable_ip_addressesAllowed IP addresses list[]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engineDBaaS engine
dbaas_engine_version_nameDBaaS engine version name
ha_enabledHA availability
init_config_optionDB initial configuration option
instance_countInstance Count
instance_groupsInstance groups list[]
maintenance_optionMaintenance option{}
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
nat_enabledNAT availability
origin_cluster_idOrigin cluster ID
product_image_typeProduct image type
product_typeProduct type
replicasReplicas list[]
role_typeRole type{}
service_stateService state
software_versionSoftware version
subnet_idSubnet ID
timezoneTimezone
vip_public_ip_address(VIP) Public IP Address
vip_public_ip_id(VIP) Public IP ID
virtual_ip_addressVirtual IP address

1.35 - Show Request

1.35.1 - 1.1

scp-cli postgresql request show
--request_id <value>

Description

Show Request.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

1.35.2 - 1.0

scp-cli postgresql request show
--request_id <value>

Description

Show Request.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

1.36 - Start Cluster

1.36.1 - 1.1

scp-cli postgresql cluster start
--cluster_id <value>

Description

Start Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.36.2 - 1.0

scp-cli postgresql cluster start
--cluster_id <value>

Description

Start Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.37 - Stop Cluster

1.37.1 - 1.1

scp-cli postgresql cluster stop
--cluster_id <value>

Description

Stop Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.37.2 - 1.0

scp-cli postgresql cluster stop
--cluster_id <value>

Description

Stop Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.38 - Switchover Cluster

1.38.1 - 1.1

scp-cli postgresql cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.38.2 - 1.0

scp-cli postgresql cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.39 - Synchronize Archive Config

1.39.1 - 1.1

scp-cli postgresql archive config sync
--cluster_id <value>

Description

Synchronize Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.39.2 - 1.0

scp-cli postgresql archive config sync
--cluster_id <value>

Description

Synchronize Archive Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.40 - Synchronize Cluster State

1.40.1 - 1.1

scp-cli postgresql cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.40.2 - 1.0

scp-cli postgresql cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.41 - Synchronize Parameter Values

1.41.1 - 1.1

scp-cli postgresql parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.41.2 - 1.0

scp-cli postgresql parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.42 - Synchronize Replica State

1.42.1 - 1.1

scp-cli postgresql replica state sync
--origin_cluster_id <value>

Description

Synchronize Replica State.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.42.2 - 1.0

scp-cli postgresql replica state sync
--origin_cluster_id <value>

Description

Synchronize Replica State.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

1.43 - Terminate Cluster

1.43.1 - 1.1

scp-cli postgresql cluster delete
--cluster_id <value>

Description

Terminate Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

1.43.2 - 1.0

scp-cli postgresql cluster delete
--cluster_id <value>

Description

Terminate Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

1.44 - Unregister Log Export Config

1.44.1 - 1.1

scp-cli postgresql log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

1.44.2 - 1.0

scp-cli postgresql log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

1.45 - Unset Backup

1.45.1 - 1.1

scp-cli postgresql backup unset
--cluster_id <value>

Description

Unset Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

1.45.2 - 1.0

scp-cli postgresql backup unset
--cluster_id <value>

Description

Unset Backup.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

1.46 - Unset Maintenance

1.46.1 - 1.1

scp-cli postgresql maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

1.46.2 - 1.0

scp-cli postgresql maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

1.47 - Upgrade Kernel

1.47.1 - 1.1

scp-cli postgresql kernel upgrade
--cluster_id <value>

Description

Upgrade Kernel.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

1.47.2 - 1.0

scp-cli postgresql kernel upgrade
--cluster_id <value>

Description

Upgrade Kernel.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-