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

Return to the regular view of this page.

CLIs

1: Add Block Storages

1.1: 1.2
1.2: 1.1
1.3: 1.0

2: Create Cluster

2.1: 1.2
2.2: 1.1
2.3: 1.0

3: Create Other region Replica

3.1: 1.2
3.2: 1.1
3.3: 1.0

4: Create Replica

4.1: 1.2
4.2: 1.1
4.3: 1.0

5: Create Restore Cluster

5.1: 1.2
5.2: 1.1
5.3: 1.0

6: Delete Archive Log

6.1: 1.2
6.2: 1.1
6.3: 1.0

7: Export Log

7.1: 1.2
7.2: 1.1
7.3: 1.0

8: List Backup Histories

8.1: 1.2
8.2: 1.1
8.3: 1.0

9: List Clusters

9.1: 1.2
9.2: 1.1
9.3: 1.0

10: List Engine Version Properties

10.1: 1.2
10.2: 1.1
10.3: 1.0

11: List Engine Versions

11.1: 1.2
11.2: 1.1
11.3: 1.0

12: List Log Export Configs

12.1: 1.2
12.2: 1.1
12.3: 1.0

13: List Parameter Groups

13.1: 1.2
13.2: 1.1
13.3: 1.0

14: List Parameter Values

14.1: 1.2
14.2: 1.1
14.3: 1.0

15: List Parameters

15.1: 1.2
15.2: 1.1
15.3: 1.0

16: List Replicas

16.1: 1.2
16.2: 1.1
16.3: 1.0

17: List Server Types

17.1: 1.2
17.2: 1.1
17.3: 1.0

18: Manual Backup

18.1: 1.2

19: Patch Minor Version

19.1: 1.2
19.2: 1.1
19.3: 1.0

20: Promote Replica Cluster

20.1: 1.2
20.2: 1.1
20.3: 1.0

21: Register Log Export Config

21.1: 1.2
21.2: 1.1
21.3: 1.0

22: Remove Backup Histories

22.1: 1.2
22.2: 1.1
22.3: 1.0

23: Reset Replica

23.1: 1.2
23.2: 1.1
23.3: 1.0

24: Restart Cluster

24.1: 1.2
24.2: 1.1
24.3: 1.0

25: Set Archive Config

25.1: 1.2
25.2: 1.1
25.3: 1.0

26: Set Audit Log

26.1: 1.2
26.2: 1.1
26.3: 1.0

27: Set Backup

27.1: 1.2
27.2: 1.1
27.3: 1.0

28: Set Block Storage Size

28.1: 1.2
28.2: 1.1
28.3: 1.0

29: Set Log Export Config

29.1: 1.2
29.2: 1.1
29.3: 1.0

30: Set Maintenance

30.1: 1.2
30.2: 1.1
30.3: 1.0

31: Set Parameter Values

31.1: 1.2
31.2: 1.1
31.3: 1.0

32: Set Security Group Rules

32.1: 1.2
32.2: 1.1
32.3: 1.0

33: Set Server Type

33.1: 1.2
33.2: 1.1
33.3: 1.0

34: Show Archive Config

34.1: 1.2
34.2: 1.1
34.3: 1.0

35: Show Cluster

35.1: 1.2
35.2: 1.1
35.3: 1.0

36: Show Instance

36.1: 1.2

37: Show Request

37.1: 1.2
37.2: 1.1
37.3: 1.0

38: Start Cluster

38.1: 1.2
38.2: 1.1
38.3: 1.0

39: Stop Cluster

39.1: 1.2
39.2: 1.1
39.3: 1.0

40: Switchover Cluster

40.1: 1.2
40.2: 1.1
40.3: 1.0

41: Synchronize Archive Config

41.1: 1.2
41.2: 1.1
41.3: 1.0

42: Synchronize Cluster State

42.1: 1.2
42.2: 1.1
42.3: 1.0

43: Synchronize Parameter Values

43.1: 1.2
43.2: 1.1
43.3: 1.0

44: Synchronize Replica State

44.1: 1.2
44.2: 1.1
44.3: 1.0

45: Terminate Cluster

45.1: 1.2
45.2: 1.1
45.3: 1.0

46: Unregister Log Export Config

46.1: 1.2
46.2: 1.1
46.3: 1.0

47: Unset Backup

47.1: 1.2
47.2: 1.1
47.3: 1.0

48: Unset Maintenance

48.1: 1.2
48.2: 1.1
48.3: 1.0

49: Upgrade Kernel

49.1: 1.2
49.2: 1.1
49.3: 1.0

1 - Add Block Storages

1.1 - 1.2

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)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
instance_group_id required	string	Instance group ID	-
size_gb required	integer	Size in GB	`104`
role_type required	string	Role type	`OS`
volume_type optional	string	Volume type	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.2 - 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 (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
instance_group_id required	string	Instance group ID	-
size_gb required	integer	Size in GB	`104`
role_type required	string	Role type	`OS`
volume_type optional	string	Volume type	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
instance_group_id required	string	Instance group ID	-
size_gb required	integer	Size in GB	`104`
role_type required	string	Role type	`OS`
volume_type optional	string	Volume type	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

2 - Create Cluster

2.1 - 1.2

scp-cli postgresql cluster create
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--service_watch_log_collection <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)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
database_user_password required	string	Database user password	`test123!`
database_user_name required	string	Database User Name	`mydatabaseusr`
database_name required	string	Database Name	`mydatabase`
timezone required	string	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint.	`Asia/Seoul`
subnet_id required	string	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.	`1ddd7f1e4a8a43ed8b82d70cade0b321`
service_watch_log_collection required	boolean	ServiceWatch log collection	`True`
name required	string	Cluster name	`mycluster`
instance_name_prefix required	string	Instance name prefix	`myprefix`
instance_groups required	array	Instance groups list	`'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}, {"role_type": "DATA", "size_gb": 56, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": "db1v2m4"}'`
dbaas_engine_version_id required	string	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint.	`c1b856dd12754c0ba2614a39d0ed3ad1`
allowable_ip_addresses optional	array	Allowed IP addresses list	-
ha_enabled optional	boolean	HA availability	-
nat_enabled optional	boolean	NAT availability	-
origin_cluster_id optional	string	Origin cluster ID	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
vip_public_ip_id optional	string	(VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint.	-
virtual_ip_address optional	string	Virtual IP address	-
audit_enabled optional	boolean	Audit usage state	`False`
database_encoding optional	string	Database encoding	-
database_locale optional	string	Database locale information	-
database_port optional	integer	Database service port	-
archive_frequency_minute optional	string	Backup starting time (minute)	-
retention_period_day optional	string	Backup retention period (day)	`7`
starting_time_hour optional	string	Backup starting time (hour)	`2`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

2.2 - 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 (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
database_user_password required	string	Database user password	`test123!`
database_user_name required	string	Database User Name	`mydatabaseusr`
database_name required	string	Database Name	`mydatabase`
timezone required	string	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint.	`Asia/Seoul`
subnet_id required	string	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.	`1ddd7f1e4a8a43ed8b82d70cade0b321`
name required	string	Cluster name	`mycluster`
instance_name_prefix required	string	Instance name prefix	`myprefix`
instance_groups required	array	Instance groups list	`'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}, {"role_type": "DATA", "size_gb": 56, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": "db1v2m4"}'`
dbaas_engine_version_id required	string	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint.	`c1b856dd12754c0ba2614a39d0ed3ad1`
allowable_ip_addresses optional	array	Allowed IP addresses list	-
ha_enabled optional	boolean	HA availability	-
nat_enabled optional	boolean	NAT availability	-
origin_cluster_id optional	string	Origin cluster ID	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
vip_public_ip_id optional	string	(VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint.	-
virtual_ip_address optional	string	Virtual IP address	-
audit_enabled optional	boolean	Audit usage state	`False`
database_encoding optional	string	Database encoding	-
database_locale optional	string	Database locale information	-
database_port optional	integer	Database service port	-
archive_frequency_minute optional	string	Backup starting time (minute)	-
retention_period_day optional	string	Backup retention period (day)	`7`
starting_time_hour optional	string	Backup starting time (hour)	`2`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

2.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
database_user_password required	string	Database user password	`test123!`
database_user_name required	string	Database User Name	`mydatabaseusr`
database_name required	string	Database Name	`mydatabase`
timezone required	string	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint.	`Asia/Seoul`
subnet_id required	string	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.	`1ddd7f1e4a8a43ed8b82d70cade0b321`
name required	string	Cluster name	`mycluster`
instance_name_prefix required	string	Instance name prefix	`myprefix`
instance_groups required	array	Instance groups list	`'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}, {"role_type": "DATA", "size_gb": 56, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": "db1v2m4"}'`
dbaas_engine_version_id required	string	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint.	`c1b856dd12754c0ba2614a39d0ed3ad1`
allowable_ip_addresses optional	array	Allowed IP addresses list	-
ha_enabled optional	boolean	HA availability	-
nat_enabled optional	boolean	NAT availability	-
origin_cluster_id optional	string	Origin cluster ID	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
vip_public_ip_id optional	string	(VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint.	-
virtual_ip_address optional	string	Virtual IP address	-
audit_enabled optional	boolean	Audit usage state	`False`
database_encoding optional	string	Database encoding	-
database_locale optional	string	Database locale information	-
database_port optional	integer	Database service port	-
archive_frequency_minute optional	string	Backup starting time (minute)	-
retention_period_day optional	string	Backup retention period (day)	`7`
starting_time_hour optional	string	Backup starting time (hour)	`2`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

3 - Create Other region Replica

3.1 - 1.2

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)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
subnet_id required	string	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.	-
replicas required	array	Replicas list	`'{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}, {"role_type": "DATA", "size_gb": 56, "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	integer	Replica count	-
region required	string	Replica region	-
nat_enabled required	boolean	NAT availability	-
allowable_ip_addresses required	array	Allowed IP addresses list	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

3.2 - 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 (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
subnet_id required	string	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.	-
replicas required	array	Replicas list	`'{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}, {"role_type": "DATA", "size_gb": 56, "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	integer	Replica count	-
region required	string	Replica region	-
nat_enabled required	boolean	NAT availability	-
allowable_ip_addresses required	array	Allowed IP addresses list	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

3.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
subnet_id required	string	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.	-
replicas required	array	Replicas list	`'{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}, {"role_type": "DATA", "size_gb": 56, "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	integer	Replica count	-
region required	string	Replica region	-
nat_enabled required	boolean	NAT availability	-
allowable_ip_addresses required	array	Allowed IP addresses list	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

4 - Create Replica

4.1 - 1.2

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)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
replicas required	array	Replicas list	`'{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}, {"role_type": "DATA", "size_gb": 56, "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	integer	Replica count	-
allowable_ip_addresses required	array	Allowed IP addresses list	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

4.2 - 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 (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
replicas required	array	Replicas list	`'{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}, {"role_type": "DATA", "size_gb": 56, "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	integer	Replica count	-
allowable_ip_addresses required	array	Allowed IP addresses list	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

4.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
replicas required	array	Replicas list	`'{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}, {"role_type": "DATA", "size_gb": 56, "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	integer	Replica count	-
allowable_ip_addresses required	array	Allowed IP addresses list	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

5 - Create Restore Cluster

5.1 - 1.2

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)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
server_type_name required	string	Server type name	-
name required	string	Cluster name	`mycluster`
instance_name_prefix required	string	Instance name prefix	`myprefix`
allowable_ip_addresses optional	array	Allowed IP addresses list	-
backup_history_number optional	string	Backup id	`202501010000`
backup_recovery_time optional	string	Backup Recovery Time	-
block_storage_groups optional	array	Block storage groups list	`'{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}'`
tags optional	array	tag	`'{"key": "", "value": ""}'`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

5.2 - 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 (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
server_type_name required	string	Server type name	-
name required	string	Cluster name	`mycluster`
instance_name_prefix required	string	Instance name prefix	`myprefix`
allowable_ip_addresses optional	array	Allowed IP addresses list	-
backup_history_number optional	string	Backup id	`202501010000`
backup_recovery_time optional	string	Backup Recovery Time	-
block_storage_groups optional	array	Block storage groups list	`'{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}'`
tags optional	array	tag	`'{"key": "", "value": ""}'`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

5.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
server_type_name required	string	Server type name	-
name required	string	Cluster name	`mycluster`
instance_name_prefix required	string	Instance name prefix	`myprefix`
allowable_ip_addresses optional	array	Allowed IP addresses list	-
backup_history_number optional	string	Backup id	`202501010000`
backup_recovery_time optional	string	Backup Recovery Time	-
block_storage_groups optional	array	Block storage groups list	`'{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}'`
tags optional	array	tag	`'{"key": "", "value": ""}'`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

6 - Delete Archive Log

6.1 - 1.2

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

Description

Delete Archive Log.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
type optional	string	Archive log type	`ALL`

6.2 - 1.1

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

Description

Delete Archive Log.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
type optional	string	Archive log type	`ALL`

6.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
type optional	string	Archive log type	`ALL`

7 - Export Log

7.1 - 1.2

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

Description

Export Log.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
log_type required	****	Log type	`alert`
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

7.2 - 1.1

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

Description

Export Log.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
log_type required	****	Log type	`alert`
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

7.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
log_type required	****	Log type	`alert`
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

8 - List Backup Histories

8.1 - 1.2

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

Description

List Backup Histories.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
limit optional	integer	Number of backup lists	-
page optional	integer	Backup list page	-

Responses

Name	Description	Example
backup_end_at	Backup end time
backup_history_number	Backup id
backup_size_gb	Backup amount(GB)
backup_start_at	Backup start time
backup_state	Backup state
backup_state_detail	Backup detail state
software_version	Software version

8.2 - 1.1

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

Description

List Backup Histories.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
limit optional	integer	Number of backup lists	-
page optional	integer	Backup list page	-

Responses

Name	Description	Example
backup_end_at	Backup end time
backup_history_number	Backup id
backup_size_gb	Backup amount(GB)
backup_start_at	Backup start time
backup_state	Backup state
backup_state_detail	Backup detail state
software_version	Software version

8.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
limit optional	integer	Number of backup lists	-
page optional	integer	Backup list page	-

Responses

Name	Description	Example
backup_end_at	Backup end time
backup_history_number	Backup id
backup_size_gb	Backup amount(GB)
backup_start_at	Backup start time
backup_state	Backup state
backup_state_detail	Backup detail state
software_version	Software version

9 - List Clusters

9.1 - 1.2

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)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Cluster name	-
service_state optional	string	Service state	-
database_name optional	string	Database Name	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
database_name	Database Name
ha_enabled	HA availability
instance_count	Instance Count
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster name
role_type	Role type
service_state	Service state

9.2 - 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 (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Cluster name	-
service_state optional	string	Service state	-
database_name optional	string	Database Name	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
database_name	Database Name
ha_enabled	HA availability
instance_count	Instance Count
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster name
role_type	Role type
service_state	Service state

9.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Cluster name	-
service_state optional	string	Service state	-
database_name optional	string	Database Name	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
database_name	Database Name
ha_enabled	HA availability
instance_count	Instance Count
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster name
role_type	Role type
service_state	Service state

10 - List Engine Version Properties

10.1 - 1.2

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

Description

List Engine Version Properties.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
dbaas_engine_version_id required	string	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint.	-

Responses

Name	Description	Example
name	DBaas engine property name
value	DBaas engine property value

10.2 - 1.1

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

Description

List Engine Version Properties.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
dbaas_engine_version_id required	string	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint.	-

Responses

Name	Description	Example
name	DBaas engine property name
value	DBaas engine property value

10.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
dbaas_engine_version_id required	string	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint.	-

Responses

Name	Description	Example
name	DBaas engine property name
value	DBaas engine property value

11 - List Engine Versions

11.1 - 1.2

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

Description

List Engine Versions.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
id optional	string	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint.	-
product_image_type optional	****	Product image type	-
eos_included optional	boolean	EoS included	-

Responses

Name	Description	Example
id	ID
end_of_service	End of Service
major_version	Software major version
name	DBaaS engine version name
os_type	OS type
os_version	OS version
product_image_type	Product type
software_version	Software version

11.2 - 1.1

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

Description

List Engine Versions.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
id optional	string	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint.	-
product_image_type optional	****	Product image type	-
eos_included optional	boolean	EoS included	-

Responses

Name	Description	Example
id	ID
end_of_service	End of Service
major_version	Software major version
name	DBaaS engine version name
os_type	OS type
os_version	OS version
product_image_type	Product type
software_version	Software version

11.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
id optional	string	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint.	-
product_image_type optional	****	Product image type	-
eos_included optional	boolean	EoS included	-

Responses

Name	Description	Example
id	ID
end_of_service	End of Service
major_version	Software major version
name	DBaaS engine version name
os_type	OS type
os_version	OS version
product_image_type	Product type
software_version	Software version

12 - List Log Export Configs

12.1 - 1.2

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

Description

List Log Export Configs.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
type optional	****	Log type	`alert`

Responses

Name	Description	Example
bucket_name	Bucket name	examplebucket
delete_on_export	Delete on export	True
is_bucket_deleted	Bucket deleted	False
is_registered	Log type registration state	True
log_label	Log label	DB Alert Log
log_type	Log type	alert
schedule_day_of_month	Schedule day of month	28
schedule_day_of_week	Schedule day of week	MON
schedule_frequency_type	Schedule frequency type	DAY
schedule_hour	Schedule hour	12

12.2 - 1.1

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

Description

List Log Export Configs.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
type optional	****	Log type	`alert`

Responses

Name	Description	Example
bucket_name	Bucket name	examplebucket
delete_on_export	Delete on export	True
is_bucket_deleted	Bucket deleted	False
is_registered	Log type registration state	True
log_label	Log label	DB Alert Log
log_type	Log type	alert
schedule_day_of_month	Schedule day of month	28
schedule_day_of_week	Schedule day of week	MON
schedule_frequency_type	Schedule frequency type	DAY
schedule_hour	Schedule hour	12

12.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
type optional	****	Log type	`alert`

Responses

Name	Description	Example
bucket_name	Bucket name	examplebucket
delete_on_export	Delete on export	True
is_bucket_deleted	Bucket deleted	False
is_registered	Log type registration state	True
log_label	Log label	DB Alert Log
log_type	Log type	alert
schedule_day_of_month	Schedule day of month	28
schedule_day_of_week	Schedule day of week	MON
schedule_frequency_type	Schedule frequency type	DAY
schedule_hour	Schedule hour	12

13 - List Parameter Groups

13.1 - 1.2

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

Description

List Parameter Groups.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
major_version optional	string	Software major version	-
product_image_type optional	string	Product image type	-
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Parameter group ID
major_version	Software major version
name	Parameter group name
product_image_type	Product image type
product_type	Product type

13.2 - 1.1

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

Description

List Parameter Groups.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
major_version optional	string	Software major version	-
product_image_type optional	string	Product image type	-
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Parameter group ID
major_version	Software major version
name	Parameter group name
product_image_type	Product image type
product_type	Product type

13.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
major_version optional	string	Software major version	-
product_image_type optional	string	Product image type	-
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Parameter group ID
major_version	Software major version
name	Parameter group name
product_image_type	Product image type
product_type	Product type

14 - List Parameter Values

14.1 - 1.2

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

Description

List Parameter Values.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
id	Parameter id
allows_value	Parameter allows value
applied_value	Parameter applied value
apply_type	Parameter apply type
data_type	Parameter data type
default_value	Parameter default value
description	Parameter description
is_modifiable	Parameter is_modifiable
name	Parameter name
software_type	Parameter software type

14.2 - 1.1

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

Description

List Parameter Values.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
id	Parameter id
allows_value	Parameter allows value
applied_value	Parameter applied value
apply_type	Parameter apply type
data_type	Parameter data type
default_value	Parameter default value
description	Parameter description
is_modifiable	Parameter is_modifiable
name	Parameter name
software_type	Parameter software type

14.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
id	Parameter id
allows_value	Parameter allows value
applied_value	Parameter applied value
apply_type	Parameter apply type
data_type	Parameter data type
default_value	Parameter default value
description	Parameter description
is_modifiable	Parameter is_modifiable
name	Parameter name
software_type	Parameter software type

15 - List Parameters

15.1 - 1.2

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

Description

List Parameters.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
dbaas_parameter_group_id required	string	Parameter group ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Parameter id
dbaas_parameter_group_id	Parameter id
default_value	Parameter default value
description	Parameter description
name	Parameter name
software_type	Parameter software type

15.2 - 1.1

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

Description

List Parameters.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
dbaas_parameter_group_id required	string	Parameter group ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Parameter id
dbaas_parameter_group_id	Parameter id
default_value	Parameter default value
description	Parameter description
name	Parameter name
software_type	Parameter software type

15.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
dbaas_parameter_group_id required	string	Parameter group ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Parameter id
dbaas_parameter_group_id	Parameter id
default_value	Parameter default value
description	Parameter description
name	Parameter name
software_type	Parameter software type

16 - List Replicas

16.1 - 1.2

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

Description

List Replicas.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
name	Server name
region	Replica region
replica_state	Replica state
replica_state_detail	Replica detail state
synced_at	Replica check time

16.2 - 1.1

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

Description

List Replicas.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
name	Server name
region	Replica region
replica_state	Replica state
replica_state_detail	Replica detail state
synced_at	Replica check time

16.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
name	Server name
region	Replica region
replica_state	Replica state
replica_state_detail	Replica detail state
synced_at	Replica check time

17 - List Server Types

17.1 - 1.2

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

Description

List Server Types.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
name optional	string	Server type name	-
product_image_type optional	string	Product image type	-

Responses

Name	Description	Example
cpu_core	Server type cpu core
description	Server type description
memory_gb	Server type memory
name	Server type name
product_image_type	Product image type
product_type	Product type
purpose	Server type purpose
type	Server type class

17.2 - 1.1

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

Description

List Server Types.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
name optional	string	Server type name	-
product_image_type optional	string	Product image type	-

Responses

Name	Description	Example
cpu_core	Server type cpu core
description	Server type description
memory_gb	Server type memory
name	Server type name
product_image_type	Product image type
product_type	Product type
purpose	Server type purpose
type	Server type class

17.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
name optional	string	Server type name	-
product_image_type optional	string	Product image type	-

Responses

Name	Description	Example
cpu_core	Server type cpu core
description	Server type description
memory_gb	Server type memory
name	Server type name
product_image_type	Product image type
product_type	Product type
purpose	Server type purpose
type	Server type class

18 - Manual Backup

18.1 - 1.2

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

Description

Manual Backup.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

19 - Patch Minor Version

19.1 - 1.2

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

Description

Patch Minor Version.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	DB cluster id	-
software_version required	string	software_version	-

19.2 - 1.1

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

Description

Patch Minor Version.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	DB cluster id	-
software_version required	string	software_version	-

19.3 - 1.0

scp-cli postgresql minor version patch
--cluster_id <value>
--software_version <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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	DB cluster id	-
software_version required	string	software_version	-

20 - Promote Replica Cluster

20.1 - 1.2

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

Description

Promote Replica Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

20.2 - 1.1

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

Description

Promote Replica Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

20.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

21 - Register Log Export Config

21.1 - 1.2

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

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
secret_key required	string	Secret key	`secretkey`
schedule_hour required	string	Schedule hour	`12`
schedule_frequency_type required	string	Schedule frequency type	`DAY`
schedule_day_of_week required	****	Schedule day of week	`MON`
schedule_day_of_month required	string	Schedule day of month	`28`
log_type required	string	Log type	`alert`
delete_on_export required	boolean	Delete on export	`True`
bucket_name required	string	Bucket name	`examplebucket`
access_key required	string	Access key	`13952a8851244213f2de8d95069bf161`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

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

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
secret_key required	string	Secret key	`secretkey`
schedule_hour required	string	Schedule hour	`12`
schedule_frequency_type required	string	Schedule frequency type	`DAY`
schedule_day_of_week required	****	Schedule day of week	`MON`
schedule_day_of_month required	string	Schedule day of month	`28`
log_type required	string	Log type	`alert`
delete_on_export required	boolean	Delete on export	`True`
bucket_name required	string	Bucket name	`examplebucket`
access_key required	string	Access key	`13952a8851244213f2de8d95069bf161`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

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

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
secret_key required	string	Secret key	`secretkey`
schedule_hour required	string	Schedule hour	`12`
schedule_frequency_type required	string	Schedule frequency type	`DAY`
schedule_day_of_week required	****	Schedule day of week	`MON`
schedule_day_of_month required	string	Schedule day of month	`28`
log_type required	string	Log type	`alert`
delete_on_export required	boolean	Delete on export	`True`
bucket_name required	string	Bucket name	`examplebucket`
access_key required	string	Access key	`13952a8851244213f2de8d95069bf161`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

22 - Remove Backup Histories

22.1 - 1.2

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

Description

Remove Backup Histories.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
backup_history_number required	array	Backup id	-

22.2 - 1.1

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

Description

Remove Backup Histories.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
backup_history_number required	array	Backup id	-

22.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
backup_history_number required	array	Backup id	-

23 - Reset Replica

23.1 - 1.2

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

Description

Reset Replica.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
replica_cluster_id required	string	Replica cluster id	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

23.2 - 1.1

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

Description

Reset Replica.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
replica_cluster_id required	string	Replica cluster id	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

23.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
replica_cluster_id required	string	Replica cluster id	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

24 - Restart Cluster

24.1 - 1.2

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

Description

Restart Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

24.2 - 1.1

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

Description

Restart Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

24.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

25 - Set Archive Config

25.1 - 1.2

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

Description

Set Archive Config.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
archive_enabled required	boolean	Archive enabled	`True`
retention_period_day optional	integer	Backup retention period (day)	-

25.2 - 1.1

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

Description

Set Archive Config.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
archive_enabled required	boolean	Archive enabled	`True`
retention_period_day optional	integer	Backup retention period (day)	-

25.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
archive_enabled required	boolean	Archive enabled	`True`
retention_period_day optional	integer	Backup retention period (day)	-

26 - Set Audit Log

26.1 - 1.2

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

Description

Set Audit Log.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
use_audit_log required	boolean	use_audit_log	-

26.2 - 1.1

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

Description

Set Audit Log.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
use_audit_log required	boolean	use_audit_log	-

26.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
use_audit_log required	boolean	use_audit_log	-

27 - Set Backup

27.1 - 1.2

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)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
starting_time_hour required	string	Backup starting time (hour)	-
retention_period_day required	string	Backup retention period (day)	-
archive_frequency_minute required	string	Backup starting time (minute)	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

27.2 - 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 (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
starting_time_hour required	string	Backup starting time (hour)	-
retention_period_day required	string	Backup retention period (day)	-
archive_frequency_minute required	string	Backup starting time (minute)	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

27.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
starting_time_hour required	string	Backup starting time (hour)	-
retention_period_day required	string	Backup retention period (day)	-
archive_frequency_minute required	string	Backup starting time (minute)	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

28 - Set Block Storage Size

28.1 - 1.2

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

Description

Set Block Storage Size.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
block_storage_group_id required	string	Block storage group ID	`afc33891202643ba8ba1a5298a1affff`
size_gb required	integer	Size in GB	`16`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

28.2 - 1.1

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

Description

Set Block Storage Size.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
block_storage_group_id required	string	Block storage group ID	`afc33891202643ba8ba1a5298a1affff`
size_gb required	integer	Size in GB	`16`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

28.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
block_storage_group_id required	string	Block storage group ID	`afc33891202643ba8ba1a5298a1affff`
size_gb required	integer	Size in GB	`16`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

29 - Set Log Export Config

29.1 - 1.2

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)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
log_type required	****	Log type	`alert`
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
secret_key required	string	Secret key	`secretkey`
schedule_hour required	string	Schedule hour	`12`
schedule_frequency_type required	string	Schedule frequency type	`DAY`
schedule_day_of_week required	****	Schedule day of week	`MON`
schedule_day_of_month required	string	Schedule day of month	`28`
delete_on_export required	boolean	Delete on export	`True`
access_key required	string	Access key	`13952a8851244213f2de8d95069bf161`

29.2 - 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 (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
log_type required	****	Log type	`alert`
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
secret_key required	string	Secret key	`secretkey`
schedule_hour required	string	Schedule hour	`12`
schedule_frequency_type required	string	Schedule frequency type	`DAY`
schedule_day_of_week required	****	Schedule day of week	`MON`
schedule_day_of_month required	string	Schedule day of month	`28`
delete_on_export required	boolean	Delete on export	`True`
access_key required	string	Access key	`13952a8851244213f2de8d95069bf161`

29.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
log_type required	****	Log type	`alert`
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
secret_key required	string	Secret key	`secretkey`
schedule_hour required	string	Schedule hour	`12`
schedule_frequency_type required	string	Schedule frequency type	`DAY`
schedule_day_of_week required	****	Schedule day of week	`MON`
schedule_day_of_month required	string	Schedule day of month	`28`
delete_on_export required	boolean	Delete on export	`True`
access_key required	string	Access key	`13952a8851244213f2de8d95069bf161`

30 - Set Maintenance

30.1 - 1.2

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)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	DB cluster id	-
term_hour required	string	term_hour	-
start_time required	string	start_time	-
start_minute required	string	start_minute	-
start_day_of_week required	string	start_day_of_week	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

30.2 - 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 (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	DB cluster id	-
term_hour required	string	term_hour	-
start_time required	string	start_time	-
start_minute required	string	start_minute	-
start_day_of_week required	string	start_day_of_week	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

30.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	DB cluster id	-
term_hour required	string	term_hour	-
start_time required	string	start_time	-
start_minute required	string	start_minute	-
start_day_of_week required	string	start_day_of_week	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

31 - Set Parameter Values

31.1 - 1.2

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

Description

Set Parameter Values.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
parameters required	array	Parameter request list	`'{"id": "", "new_value": "", "old_value": ""}'`

31.2 - 1.1

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

Description

Set Parameter Values.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
parameters required	array	Parameter request list	`'{"id": "", "new_value": "", "old_value": ""}'`

31.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
parameters required	array	Parameter request list	`'{"id": "", "new_value": "", "old_value": ""}'`

32 - Set Security Group Rules

32.1 - 1.2

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)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
add_ip_addresses optional	array	Allowed IP addresses list	-
del_ip_addresses optional	array	Allowed IP addresses list	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

32.2 - 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 (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
add_ip_addresses optional	array	Allowed IP addresses list	-
del_ip_addresses optional	array	Allowed IP addresses list	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

32.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
add_ip_addresses optional	array	Allowed IP addresses list	-
del_ip_addresses optional	array	Allowed IP addresses list	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

33 - Set Server Type

33.1 - 1.2

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

Description

Set Server Type.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
instance_group_id required	string	Instance group ID	-
server_type_name required	string	Server type name	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

33.2 - 1.1

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

Description

Set Server Type.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
instance_group_id required	string	Instance group ID	-
server_type_name required	string	Server type name	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

33.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
instance_group_id required	string	Instance group ID	-
server_type_name required	string	Server type name	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

34 - Show Archive Config

34.1 - 1.2

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

Description

Show Archive Config.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
archive_enabled	Archive enabled	True
retention_period_day	Backup retention period (day)

34.2 - 1.1

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

Description

Show Archive Config.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
archive_enabled	Archive enabled	True
retention_period_day	Backup retention period (day)

34.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
archive_enabled	Archive enabled	True
retention_period_day	Backup retention period (day)

35 - Show Cluster

35.1 - 1.2

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

Description

Show Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID
allowable_ip_addresses	Allowed IP addresses list	[]
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engine	DBaaS engine
dbaas_engine_version_name	DBaaS engine version name
ha_enabled	HA availability
init_config_option	DB initial configuration option
instance_count	Instance Count
instance_groups	Instance groups list	[]
is_kernel_patchable	Whether the kernel can be patched
maintenance_option	Maintenance option	{}
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster name
nat_enabled	NAT availability
origin_cluster_id	Origin cluster ID
product_image_type	Product image type
product_type	Product type
replicas	Replicas list	[]
role_type	Role type	{}
service_state	Service state
service_watch_log_collection	ServiceWatch log collection
software_version	Software version
subnet_id	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.
timezone	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint.
vip_public_ip_address	(VIP) Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint.
vip_public_ip_id	(VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint.
virtual_ip_address	Virtual IP address

35.2 - 1.1

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

Description

Show Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID
allowable_ip_addresses	Allowed IP addresses list	[]
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engine	DBaaS engine
dbaas_engine_version_name	DBaaS engine version name
ha_enabled	HA availability
init_config_option	DB initial configuration option
instance_count	Instance Count
instance_groups	Instance groups list	[]
is_kernel_patchable	Whether the kernel can be patched
maintenance_option	Maintenance option	{}
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster name
nat_enabled	NAT availability
origin_cluster_id	Origin cluster ID
product_image_type	Product image type
product_type	Product type
replicas	Replicas list	[]
role_type	Role type	{}
service_state	Service state
software_version	Software version
subnet_id	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.
timezone	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint.
vip_public_ip_address	(VIP) Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint.
vip_public_ip_id	(VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint.
virtual_ip_address	Virtual IP address

35.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID
allowable_ip_addresses	Allowed IP addresses list	[]
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engine	DBaaS engine
dbaas_engine_version_name	DBaaS engine version name
ha_enabled	HA availability
init_config_option	DB initial configuration option
instance_count	Instance Count
instance_groups	Instance groups list	[]
maintenance_option	Maintenance option	{}
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster name
nat_enabled	NAT availability
origin_cluster_id	Origin cluster ID
product_image_type	Product image type
product_type	Product type
replicas	Replicas list	[]
role_type	Role type	{}
service_state	Service state
software_version	Software version
subnet_id	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.
timezone	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint.
vip_public_ip_address	(VIP) Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint.
vip_public_ip_id	(VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint.
virtual_ip_address	Virtual IP address

36 - Show Instance

36.1 - 1.2

scp-cli postgresql instance show
--instance_name <value>
--cluster_id <value>

Description

Show Instance.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
instance_name required	string	Instance name	-
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
account_id	Account ID
block_storages	Block storages	[]
cluster_id	Cluster ID
cluster_name	Cluster name
cpu_core	Server type cpu core
created_at	Creation time
created_by	Creator
dbaas_engine	DBaaS engine
memory_gb	Server type memory
modified_at	Modification time
modified_by	Modifier
name	Name
os_type	OS type
os_version	OS version
product_image_type	Product image type
product_type	Product type
public_ip_address	Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint.
public_ip_id	Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint.
region	Region
role_type	Role type
server_type_name	Server type name
service_ip_address	User subnet IP address
service_state	Service state
software_version	Software version
zone	Availability Zone

37 - Show Request

37.1 - 1.2

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

Description

Show Request.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
request_id required	string	Request ID	-

Responses

Name	Description	Example
request_id	Request ID
state	Request state

37.2 - 1.1

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

Description

Show Request.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
request_id required	string	Request ID	-

Responses

Name	Description	Example
request_id	Request ID
state	Request state

37.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
request_id required	string	Request ID	-

Responses

Name	Description	Example
request_id	Request ID
state	Request state

38 - Start Cluster

38.1 - 1.2

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

Description

Start Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

38.2 - 1.1

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

Description

Start Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

38.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

39 - Stop Cluster

39.1 - 1.2

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

Description

Stop Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

39.2 - 1.1

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

Description

Stop Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

39.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

40 - Switchover Cluster

40.1 - 1.2

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

Description

Switchover Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

40.2 - 1.1

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

Description

Switchover Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

40.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

41 - Synchronize Archive Config

41.1 - 1.2

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

Description

Synchronize Archive Config.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

41.2 - 1.1

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

Description

Synchronize Archive Config.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

41.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

42 - Synchronize Cluster State

42.1 - 1.2

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

Description

Synchronize Cluster State.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

42.2 - 1.1

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

Description

Synchronize Cluster State.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

42.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

43 - Synchronize Parameter Values

43.1 - 1.2

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

Description

Synchronize Parameter Values.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

43.2 - 1.1

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

Description

Synchronize Parameter Values.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

43.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

44 - Synchronize Replica State

44.1 - 1.2

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

Description

Synchronize Replica State.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
origin_cluster_id required	string	Origin cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

44.2 - 1.1

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

Description

Synchronize Replica State.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
origin_cluster_id required	string	Origin cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

44.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
origin_cluster_id required	string	Origin cluster ID	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

45 - Terminate Cluster

45.1 - 1.2

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

Description

Terminate Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

45.2 - 1.1

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

Description

Terminate Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

45.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

46 - Unregister Log Export Config

46.1 - 1.2

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

Description

Unregister Log Export Config.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
log_type required	****	Log type	`alert`
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

46.2 - 1.1

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

Description

Unregister Log Export Config.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
log_type required	****	Log type	`alert`
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

46.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
log_type required	****	Log type	`alert`
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

47 - Unset Backup

47.1 - 1.2

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

Description

Unset Backup.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

47.2 - 1.1

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

Description

Unset Backup.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

47.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

48 - Unset Maintenance

48.1 - 1.2

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

Description

Unset Maintenance.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	DB cluster id	-

48.2 - 1.1

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

Description

Unset Maintenance.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	DB cluster id	-

48.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	DB cluster id	-

49 - Upgrade Kernel

49.1 - 1.2

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

Description

Upgrade Kernel.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

49.2 - 1.1

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

Description

Upgrade Kernel.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

49.3 - 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.

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-