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

Return to the regular view of this page.

Database

1 - CacheStore(DBaaS)

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of CacheStore(DBaaS) service and how to call CLI.

Version

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

VersionStatusNot Before
1.0CURRENT-

CLI Version History

1.0

Initial CLI release for CacheStore(DBaaS)

Changes

  • [New] cachestore create cluster - command has been added.
  • [New] cachestore create restore - command has been added.
  • [New] cachestore delete cluster - command has been added.
  • [New] cachestore list backup histories - command has been added.
  • [New] cachestore list clusters - command has been added.
  • [New] cachestore list commands - command has been added.
  • [New] cachestore list engine version properties - command has been added.
  • [New] cachestore list engine versions - command has been added.
  • [New] cachestore list parameter groups - command has been added.
  • [New] cachestore list parameter values - command has been added.
  • [New] cachestore list parameters - command has been added.
  • [New] cachestore list server types - command has been added.
  • [New] cachestore remove backup histories - command has been added.
  • [New] cachestore restart cluster - command has been added.
  • [New] cachestore set backup - command has been added.
  • [New] cachestore set block storage size - command has been added.
  • [New] cachestore set commands - command has been added.
  • [New] cachestore set maintenance - command has been added.
  • [New] cachestore set parameter values - command has been added.
  • [New] cachestore set security group rules - command has been added.
  • [New] cachestore set server type - command has been added.
  • [New] cachestore show cluster - command has been added.
  • [New] cachestore show request - command has been added.
  • [New] cachestore start cluster - command has been added.
  • [New] cachestore stop cluster - command has been added.
  • [New] cachestore switchover cluster - command has been added.
  • [New] cachestore sync cluster state - command has been added.
  • [New] cachestore sync commands - command has been added.
  • [New] cachestore sync parameter values - command has been added.
  • [New] cachestore unset backup - command has been added.
  • [New] cachestore unset maintenance - command has been added.

1.1 - CLIs

1.1.1 - Create Cluster

1.1.1.1 - 1.0

scp-cli cachestore cluster create
--database_user_password <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>]
[--replica_count <value>]
[--tags <value>]
[--database_port <value>]
[--sentinel_port <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user passwordtest123!
timezone
required
stringTimezoneAsia/Seoul
subnet_id
required
stringSubnet ID1ddd7f1e4a8a43ed8b82d70cade0b321
name
required
stringCluster namemycluster
instance_name_prefix
required
stringInstance name prefixmyprefix
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}, {"role_type": "DATA", "size_gb": 56, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "MASTER", "service_ip_address": "192.168.10.10/32"}], "role_type": "MASTER", "server_type_name": "redis1v2m4"}'
dbaas_engine_version_id
required
stringDBaaS engine version IDc1b856dd12754c0ba2614a39d0ed3ad1
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
ha_enabled
optional
booleanHA availability-
nat_enabled
optional
booleanNAT availability-
replica_count
optional
integerReplica count-
tags
optional
arraytag'{"key": "", "value": ""}'
database_port
optional
integerDatabase service port-
sentinel_port
optional
integerSentinel port-
retention_period_day
optional
stringBackup retention period (day)7
starting_time_hour
optional
stringBackup starting time (hour)2
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

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

1.1.2 - Create Restore Cluster

1.1.2.1 - 1.0

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

Description

Create Restore Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.1.3 - List Backup Histories

1.1.3.1 - 1.0

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

Description

List Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.1.4 - List Clusters

1.1.4.1 - 1.0

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

Description

List Clusters.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.1.5 - List Commands

1.1.5.1 - 1.0

scp-cli cachestore command list
--cluster_id <value>

Description

List Commands.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
id
applied_value
description
modifiable
name

1.1.6 - List Engine Version Properties

1.1.6.1 - 1.0

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

Description

List Engine Version Properties.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

1.1.7 - List Engine Versions

1.1.7.1 - 1.0

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

Description

List Engine Versions.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.1.8 - List Parameter Groups

1.1.8.1 - 1.0

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

Description

List Parameter Groups.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.1.9 - List Parameter Values

1.1.9.1 - 1.0

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

Description

List Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

1.1.10 - List Parameters

1.1.10.1 - 1.0

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

Description

List Parameters.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.1.11 - List Server Types

1.1.11.1 - 1.0

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

Description

List Server Types.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.1.12 - Patch Minor Version

1.1.12.1 - 1.0

scp-cli cachestore minor version patch
--cluster_id <value>
--software_version <value>
--dbaas_engine <value>

Description

Patch Minor Version.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
software_version
required
stringsoftware_version-
dbaas_engine
required
stringdbaas_engine-

1.1.13 - Remove Backup Histories

1.1.13.1 - 1.0

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

Description

Remove Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

1.1.14 - Restart Cluster

1.1.14.1 - 1.0

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

Description

Restart Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster IDmycluster

Responses

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

1.1.15 - Set Backup

1.1.15.1 - 1.0

scp-cli cachestore backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>

Description

Set Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.1.16 - Set Block Storage Size

1.1.16.1 - 1.0

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

Description

Set Block Storage Size.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.1.17 - Set Maintenance

1.1.17.1 - 1.0

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

Description

Set Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.1.18 - Set Parameter Values

1.1.18.1 - 1.0

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

Description

Set Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

1.1.19 - Set Security Group Rules

1.1.19.1 - 1.0

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

Description

Set Security Group Rules.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.1.20 - Set Server Type

1.1.20.1 - 1.0

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

Description

Set Server Type.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.1.21 - Show Cluster

1.1.21.1 - 1.0

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

Description

Show Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster IDmycluster

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
allowable_ip_addressesAllowed IP addresses list[]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engineDBaaS engine
dbaas_engine_version_nameDBaaS engine version name
ha_enabledHA availability
init_config_option{}
instance_countInstance Count
instance_groups[]
maintenance_optionMaintenance option{}
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
nat_enabledNAT availability
product_image_typeProduct image type
product_typeProduct type
role_typeRole type{}
service_stateService state
software_versionSoftware version
subnet_idSubnet ID
timezoneTimezone

1.1.22 - Show Request

1.1.22.1 - 1.0

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

Description

Show Request.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

1.1.23 - Start Cluster

1.1.23.1 - 1.0

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

Description

Start Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster IDmycluster

Responses

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

1.1.24 - Stop Cluster

1.1.24.1 - 1.0

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

Description

Stop Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster IDmycluster

Responses

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

1.1.25 - Switchover Cluster

1.1.25.1 - 1.0

scp-cli cachestore cluster switchover
--cluster_id <value>
--switch_host_name <value>

Description

Switchover Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster IDmycluster
switch_host_name
required
stringSwitch over target-

Responses

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

1.1.26 - Synchronize Cluster State

1.1.26.1 - 1.0

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

Description

Synchronize Cluster State.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster IDmycluster

Responses

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

1.1.27 - Synchronize Commands

1.1.27.1 - 1.0

scp-cli cachestore command sync
--cluster_id <value>

Description

Synchronize Commands.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

1.1.28 - Synchronize Parameter Values

1.1.28.1 - 1.0

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

Description

Synchronize Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

1.1.29 - Terminate Cluster

1.1.29.1 - 1.0

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

Description

Terminate Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster IDmycluster

1.1.30 - Unset Backup

1.1.30.1 - 1.0

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

Description

Unset Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

1.1.31 - Unset Maintenance

1.1.31.1 - 1.0

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

Description

Unset Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

1.1.32 - Update Commands

1.1.32.1 - 1.0

scp-cli cachestore command set
--cluster_id <value>
--commands <value>

Description

Update Commands.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
commands
required
arrayApply command information'{"id": "", "name": "", "new_value": ""}'

2 - EPAS(DBaaS)

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of EPAS(DBaaS) service and how to call CLI.

Version

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

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20260531

CLI Version History

1.1

CLI version 1.1 release for EPAS(DBaaS)

Changes

  • [Changed] epas show cluster - command has been changed.
    • Response model has been changed to EpasClusterDetailResponseV1Dot1.
    • The following fields are added to the response:
      • is_kernel_patchable
  • [New] epas create other region replica - command has been added.
  • [New] epas patch minor version - command has been added.
  • [New] epas upgrade kernel - command has been added.

1.0

Initial CLI release for EPAS(DBaaS)

Changes

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

2.1 - CLIs

2.1.1 - Add Block Storages

2.1.1.1 - 1.1

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

Description

Add Block Storages.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.1.2 - 1.0

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

Description

Add Block Storages.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.2 - Create Cluster

2.1.2.1 - 1.1

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

Description

Create Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.2.2 - 1.0

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

Description

Create Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.3 - Create Other region Replica

2.1.3.1 - 1.1

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

Description

Create Other region Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.3.2 - 1.0

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

Description

Create Other region Replica.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.4 - Create Replica

2.1.4.1 - 1.1

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

Description

Create Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.4.2 - 1.0

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

Description

Create Replica.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.5 - Create Restore Cluster

2.1.5.1 - 1.1

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

Description

Create Restore Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.5.2 - 1.0

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

Description

Create Restore Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.6 - Delete Archive Log

2.1.6.1 - 1.1

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

Description

Delete Archive Log.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
stringArchive log typeALL

2.1.6.2 - 1.0

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

Description

Delete Archive Log.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
stringArchive log typeALL

2.1.7 - Export Log

2.1.7.1 - 1.1

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

Description

Export Log.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.7.2 - 1.0

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

Description

Export Log.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.8 - List Backup Histories

2.1.8.1 - 1.1

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

Description

List Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.8.2 - 1.0

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

Description

List Backup Histories.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.9 - List Clusters

2.1.9.1 - 1.1

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

Description

List Clusters.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.9.2 - 1.0

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

Description

List Clusters.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.10 - List Engine Version Properties

2.1.10.1 - 1.1

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

Description

List Engine Version Properties.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

2.1.10.2 - 1.0

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

Description

List Engine Version Properties.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

2.1.11 - List Engine Versions

2.1.11.1 - 1.1

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

Description

List Engine Versions.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.11.2 - 1.0

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

Description

List Engine Versions.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.12 - List Log Export Configs

2.1.12.1 - 1.1

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

Description

List Log Export Configs.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.12.2 - 1.0

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

Description

List Log Export Configs.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.13 - List Parameter Groups

2.1.13.1 - 1.1

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

Description

List Parameter Groups.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.13.2 - 1.0

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

Description

List Parameter Groups.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.14 - List Parameter Values

2.1.14.1 - 1.1

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

Description

List Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.14.2 - 1.0

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

Description

List Parameter Values.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.15 - List Parameters

2.1.15.1 - 1.1

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

Description

List Parameters.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.15.2 - 1.0

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

Description

List Parameters.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.16 - List Replicas

2.1.16.1 - 1.1

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

Description

List Replicas.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.16.2 - 1.0

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

Description

List Replicas.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.17 - List Server Types

2.1.17.1 - 1.1

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

Description

List Server Types.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.17.2 - 1.0

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

Description

List Server Types.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.18 - Patch Minor Version

2.1.18.1 - 1.1

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

Description

Patch Minor Version.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

2.1.18.2 - 1.0

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

Description

Patch Minor Version.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

2.1.19 - Promote Replica Cluster

2.1.19.1 - 1.1

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

Description

Promote Replica Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.19.2 - 1.0

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

Description

Promote Replica Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.20 - Register Log Export Config

2.1.20.1 - 1.1

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

Description

Register Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.20.2 - 1.0

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

Description

Register Log Export Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.21 - Remove Backup Histories

2.1.21.1 - 1.1

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

Description

Remove Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

2.1.21.2 - 1.0

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

Description

Remove Backup Histories.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

2.1.22 - Reset Replica

2.1.22.1 - 1.1

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

Description

Reset Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

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

2.1.22.2 - 1.0

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

Description

Reset Replica.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

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

2.1.23 - Restart Cluster

2.1.23.1 - 1.1

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

Description

Restart Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.23.2 - 1.0

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

Description

Restart Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.24 - Set Archive Config

2.1.24.1 - 1.1

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

Description

Set Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

2.1.24.2 - 1.0

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

Description

Set Archive Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

2.1.25 - Set Audit Log

2.1.25.1 - 1.1

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

Description

Set Audit Log.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
use_audit_log
required
booleanuse_audit_log-

2.1.25.2 - 1.0

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

Description

Set Audit Log.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
use_audit_log
required
booleanuse_audit_log-

2.1.26 - Set Backup

2.1.26.1 - 1.1

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

Description

Set Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.26.2 - 1.0

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

Description

Set Backup.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.27 - Set Block Storage Size

2.1.27.1 - 1.1

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

Description

Set Block Storage Size.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.27.2 - 1.0

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

Description

Set Block Storage Size.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.28 - Set Log Export Config

2.1.28.1 - 1.1

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

Description

Set Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

2.1.28.2 - 1.0

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

Description

Set Log Export Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

2.1.29 - Set Maintenance

2.1.29.1 - 1.1

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

Description

Set Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.29.2 - 1.0

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

Description

Set Maintenance.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.30 - Set Parameter Values

2.1.30.1 - 1.1

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

Description

Set Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

2.1.30.2 - 1.0

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

Description

Set Parameter Values.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

2.1.31 - Set Security Group Rules

2.1.31.1 - 1.1

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

Description

Set Security Group Rules.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.31.2 - 1.0

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

Description

Set Security Group Rules.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.32 - Set Server Type

2.1.32.1 - 1.1

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

Description

Set Server Type.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

2.1.32.2 - 1.0

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

Description

Set Server Type.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

2.1.33 - Show Archive Config

2.1.33.1 - 1.1

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

Description

Show Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

2.1.33.2 - 1.0

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

Description

Show Archive Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

2.1.34 - Show Cluster

2.1.34.1 - 1.1

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

Description

Show Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.34.2 - 1.0

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

Description

Show Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.35 - Show Request

2.1.35.1 - 1.1

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

Description

Show Request.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

2.1.35.2 - 1.0

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

Description

Show Request.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

2.1.36 - Start Cluster

2.1.36.1 - 1.1

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

Description

Start Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.36.2 - 1.0

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

Description

Start Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.37 - Stop Cluster

2.1.37.1 - 1.1

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

Description

Stop Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.37.2 - 1.0

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

Description

Stop Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.38 - Switchover Cluster

2.1.38.1 - 1.1

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

Description

Switchover Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.38.2 - 1.0

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

Description

Switchover Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.39 - Synchronize Archive Config

2.1.39.1 - 1.1

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

Description

Synchronize Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

2.1.39.2 - 1.0

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

Description

Synchronize Archive Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

2.1.40 - Synchronize Cluster State

2.1.40.1 - 1.1

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

Description

Synchronize Cluster State.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.40.2 - 1.0

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

Description

Synchronize Cluster State.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.41 - Synchronize Parameter Values

2.1.41.1 - 1.1

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

Description

Synchronize Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.41.2 - 1.0

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

Description

Synchronize Parameter Values.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.42 - Synchronize Replica State

2.1.42.1 - 1.1

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

Description

Synchronize Replica State.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

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

2.1.42.2 - 1.0

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

Description

Synchronize Replica State.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

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

2.1.43 - Terminate Cluster

2.1.43.1 - 1.1

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

Description

Terminate Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

2.1.43.2 - 1.0

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

Description

Terminate Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

2.1.44 - Unregister Log Export Config

2.1.44.1 - 1.1

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

Description

Unregister Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

2.1.44.2 - 1.0

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

Description

Unregister Log Export Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

2.1.45 - Unset Backup

2.1.45.1 - 1.1

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

Description

Unset Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

2.1.45.2 - 1.0

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

Description

Unset Backup.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

2.1.46 - Unset Maintenance

2.1.46.1 - 1.1

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

Description

Unset Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

2.1.46.2 - 1.0

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

Description

Unset Maintenance.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

2.1.47 - Upgrade Kernel

2.1.47.1 - 1.1

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

Description

Upgrade Kernel.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

2.1.47.2 - 1.0

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

Description

Upgrade Kernel.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

3 - MariaDB(DBaaS)

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of MariaDB(DBaaS) service and how to call CLI.

Version

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

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20260531

CLI Version History

1.1

CLI version 1.1 release for MariaDB(DBaaS)

Changes

  • [Changed] mariadb create cluster - command has been changed.
    • Request model has been changed to MariadbClusterCreateRequestV1Dot1.
    • The following fields are added to the request:
      • service_watch_log_collection
  • [Changed] mariadb show cluster - command has been changed.
    • Response model has been changed to MariadbClusterDetailResponseV1Dot1.
    • The following fields are added to the response:
      • is_kernel_patchable
      • service_watch_log_collection
  • [New] mariadb create other region replica - command has been added.
  • [New] mariadb patch minor version - command has been added.
  • [New] mariadb upgrade kernel - command has been added.

1.0

Initial CLI release for MariaDB(DBaaS)

Changes

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

3.1 - CLIs

3.1.1 - Add Block Storages

3.1.1.1 - 1.1

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

Description

Add Block Storages.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.1.2 - 1.0

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

Description

Add Block Storages.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.2 - Create Cluster

3.1.2.1 - 1.1

scp-cli mariadb 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_character_set <value>]
[--database_port <value>]
[--archive_frequency_minute <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.2.2 - 1.0

scp-cli mariadb 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_character_set <value>]
[--database_port <value>]
[--archive_frequency_minute <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.3 - Create Other region Replica

3.1.3.1 - 1.1

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

Description

Create Other region Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.3.2 - 1.0

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

Description

Create Other region Replica.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.4 - Create Replica

3.1.4.1 - 1.1

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

Description

Create Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.4.2 - 1.0

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

Description

Create Replica.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.5 - Create Restore Cluster

3.1.5.1 - 1.1

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

Description

Create Restore Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.5.2 - 1.0

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

Description

Create Restore Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.6 - Export Log

3.1.6.1 - 1.1

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

Description

Export Log.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.6.2 - 1.0

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

Description

Export Log.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.7 - List Backup Histories

3.1.7.1 - 1.1

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

Description

List Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.7.2 - 1.0

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

Description

List Backup Histories.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.8 - List Clusters

3.1.8.1 - 1.1

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

Description

List Clusters.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.8.2 - 1.0

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

Description

List Clusters.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.9 - List Engine Version Properties

3.1.9.1 - 1.1

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

Description

List Engine Version Properties.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

3.1.9.2 - 1.0

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

Description

List Engine Version Properties.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

3.1.10 - List Engine Versions

3.1.10.1 - 1.1

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

Description

List Engine Versions.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.10.2 - 1.0

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

Description

List Engine Versions.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.11 - List Log Export Configs

3.1.11.1 - 1.1

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

Description

List Log Export Configs.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.11.2 - 1.0

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

Description

List Log Export Configs.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.12 - List Parameter Groups

3.1.12.1 - 1.1

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

Description

List Parameter Groups.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.12.2 - 1.0

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

Description

List Parameter Groups.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.13 - List Parameter Values

3.1.13.1 - 1.1

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

Description

List Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.13.2 - 1.0

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

Description

List Parameter Values.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.14 - List Parameters

3.1.14.1 - 1.1

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

Description

List Parameters.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.14.2 - 1.0

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

Description

List Parameters.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.15 - List Replicas

3.1.15.1 - 1.1

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

Description

List Replicas.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.15.2 - 1.0

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

Description

List Replicas.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.16 - List Server Types

3.1.16.1 - 1.1

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

Description

List Server Types.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.16.2 - 1.0

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

Description

List Server Types.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.17 - Patch Minor Version

3.1.17.1 - 1.1

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

Description

Patch Minor Version.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

3.1.17.2 - 1.0

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

Description

Patch Minor Version.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

3.1.18 - Promote Replica Cluster

3.1.18.1 - 1.1

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

Description

Promote Replica Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.18.2 - 1.0

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

Description

Promote Replica Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.19 - Register Log Export Config

3.1.19.1 - 1.1

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

Description

Register Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.19.2 - 1.0

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

Description

Register Log Export Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.20 - Remove Backup Histories

3.1.20.1 - 1.1

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

Description

Remove Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

3.1.20.2 - 1.0

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

Description

Remove Backup Histories.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

3.1.21 - Reset Replica

3.1.21.1 - 1.1

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

Description

Reset Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

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

3.1.21.2 - 1.0

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

Description

Reset Replica.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

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

3.1.22 - Restart Cluster

3.1.22.1 - 1.1

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

Description

Restart Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.22.2 - 1.0

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

Description

Restart Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.23 - Set Archive Config

3.1.23.1 - 1.1

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

Description

Set Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

3.1.23.2 - 1.0

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

Description

Set Archive Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

3.1.24 - Set Audit Log

3.1.24.1 - 1.1

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

Description

Set Audit Log.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
use_audit_log
required
booleanuse_audit_log-

3.1.24.2 - 1.0

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

Description

Set Audit Log.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
use_audit_log
required
booleanuse_audit_log-

3.1.25 - Set Backup

3.1.25.1 - 1.1

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

Description

Set Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.25.2 - 1.0

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

Description

Set Backup.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.26 - Set Block Storage Size

3.1.26.1 - 1.1

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

Description

Set Block Storage Size.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.26.2 - 1.0

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

Description

Set Block Storage Size.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.27 - Set Log Export Config

3.1.27.1 - 1.1

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

Description

Set Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

3.1.27.2 - 1.0

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

Description

Set Log Export Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

3.1.28 - Set Maintenance

3.1.28.1 - 1.1

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

Description

Set Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.28.2 - 1.0

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

Description

Set Maintenance.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.29 - Set Parameter Values

3.1.29.1 - 1.1

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

Description

Set Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

3.1.29.2 - 1.0

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

Description

Set Parameter Values.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

3.1.30 - Set Security Group Rules

3.1.30.1 - 1.1

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

Description

Set Security Group Rules.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.30.2 - 1.0

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

Description

Set Security Group Rules.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.31 - Set Server Type

3.1.31.1 - 1.1

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

Description

Set Server Type.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

3.1.31.2 - 1.0

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

Description

Set Server Type.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

3.1.32 - Show Archive Config

3.1.32.1 - 1.1

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

Description

Show Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

3.1.32.2 - 1.0

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

Description

Show Archive Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

3.1.33 - Show Cluster

3.1.33.1 - 1.1

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

Description

Show Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.33.2 - 1.0

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

Description

Show Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.34 - Show Request

3.1.34.1 - 1.1

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

Description

Show Request.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

3.1.34.2 - 1.0

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

Description

Show Request.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

3.1.35 - Start Cluster

3.1.35.1 - 1.1

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

Description

Start Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.35.2 - 1.0

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

Description

Start Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.36 - Stop Cluster

3.1.36.1 - 1.1

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

Description

Stop Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.36.2 - 1.0

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

Description

Stop Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.37 - Switchover Cluster

3.1.37.1 - 1.1

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

Description

Switchover Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.37.2 - 1.0

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

Description

Switchover Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.38 - Synchronize Archive Config

3.1.38.1 - 1.1

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

Description

Synchronize Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

3.1.38.2 - 1.0

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

Description

Synchronize Archive Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

3.1.39 - Synchronize Cluster State

3.1.39.1 - 1.1

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

Description

Synchronize Cluster State.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.39.2 - 1.0

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

Description

Synchronize Cluster State.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.40 - Synchronize Parameter Values

3.1.40.1 - 1.1

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

Description

Synchronize Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.40.2 - 1.0

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

Description

Synchronize Parameter Values.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.41 - Synchronize Replica State

3.1.41.1 - 1.1

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

Description

Synchronize Replica State.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

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

3.1.41.2 - 1.0

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

Description

Synchronize Replica State.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

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

3.1.42 - Terminate Cluster

3.1.42.1 - 1.1

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

Description

Terminate Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

3.1.42.2 - 1.0

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

Description

Terminate Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

3.1.43 - Unregister Log Export Config

3.1.43.1 - 1.1

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

Description

Unregister Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

3.1.43.2 - 1.0

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

Description

Unregister Log Export Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

3.1.44 - Unset Backup

3.1.44.1 - 1.1

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

Description

Unset Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

3.1.44.2 - 1.0

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

Description

Unset Backup.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

3.1.45 - Unset Maintenance

3.1.45.1 - 1.1

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

Description

Unset Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

3.1.45.2 - 1.0

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

Description

Unset Maintenance.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

3.1.46 - Upgrade Kernel

3.1.46.1 - 1.1

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

Description

Upgrade Kernel.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

3.1.46.2 - 1.0

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

Description

Upgrade Kernel.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

4 - Microsoft SQL Server(DBaaS)

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Microsoft SQL Server(DBaaS) service and how to call CLI.

Version

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

VersionStatusNot Before

CLI Version History

1.0

Initial CLI release for Microsoft SQL Server(DBaaS)

Changes

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

4.1 - CLIs

4.1.1 - Add Block Storages

4.1.1.1 - 1.0

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

Description

Add Block Storages.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.2 - Add Secondary

4.1.2.1 - 1.0

scp-cli sqlserver secondary add
--cluster_id <value>
--name <value>
--license <value>
[--service_ip_address <value>]

Description

Add Secondary.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
name
required
stringSecondary Name-
license
required
stringlicense-
service_ip_address
optional
stringUser subnet IP address-

Responses

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

4.1.3 - Add/Remove Databases

4.1.3.1 - 1.0

scp-cli sqlserver database set
--cluster_id <value>
[--add_databases <value>]
[--del_databases <value>]

Description

Add/Remove Databases.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
add_databases
optional
arrayDatabases'{"database_name": "", "drive_letter": "E"}'
del_databases
optional
arrayDatabases'{"database_name": "", "drive_letter": "E"}'

Responses

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

4.1.4 - Create Cluster

4.1.4.1 - 1.0

scp-cli sqlserver cluster create
--archive_frequency_minute <value>
--license <value>
--databases <value>
--database_user_password <value>
--database_user_name <value>
--database_service_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>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_collation <value>]
[--database_name <value>]
[--database_port <value>]
[--full_backup_day_of_week <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.5 - Create Restore Cluster

4.1.5.1 - 1.0

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

Description

Create Restore Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.6 - Export Log

4.1.6.1 - 1.0

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

Description

Export Log.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.7 - List Backup Histories

4.1.7.1 - 1.0

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

Description

List Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.8 - List Clusters

4.1.8.1 - 1.0

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

Description

List Clusters.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.9 - List Engine Version Properties

4.1.9.1 - 1.0

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

Description

List Engine Version Properties.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

4.1.10 - List Engine Versions

4.1.10.1 - 1.0

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

Description

List Engine Versions.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.11 - List Log Export Configs

4.1.11.1 - 1.0

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

Description

List Log Export Configs.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.12 - List Parameter Groups

4.1.12.1 - 1.0

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

Description

List Parameter Groups.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.13 - List Parameter Values

4.1.13.1 - 1.0

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

Description

List Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

4.1.14 - List Parameters

4.1.14.1 - 1.0

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

Description

List Parameters.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.15 - List Server Types

4.1.15.1 - 1.0

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

Description

List Server Types.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.16 - Patch Minor Version

4.1.16.1 - 1.0

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

Description

Patch Minor Version.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
software_version
required
stringsoftware_version-
backup_before_upgrade
required
booleanbackup_before_upgrade-

4.1.17 - Register Log Export Config

4.1.17.1 - 1.0

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

Description

Register Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.18 - Remove Backup Histories

4.1.18.1 - 1.0

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

Description

Remove Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
backup_history_number
required
arrayBackup id-

4.1.19 - Restart Cluster

4.1.19.1 - 1.0

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

Description

Restart Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

4.1.20 - Set Audit Log

4.1.20.1 - 1.0

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

Description

Set Audit Log.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
use_audit_log
required
booleanuse_audit_log-

4.1.21 - Set Backup

4.1.21.1 - 1.0

scp-cli sqlserver backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
[--full_backup_day_of_week <value>]

Description

Set Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-
archive_frequency_minute
required
stringBackup starting time (minute)-
full_backup_day_of_week
optional
stringFull backup day of week-

Responses

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

4.1.22 - Set Block Storage Size

4.1.22.1 - 1.0

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

Description

Set Block Storage Size.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.23 - Set Log Export Config

4.1.23.1 - 1.0

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

Description

Set Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

4.1.24 - Set Maintenance

4.1.24.1 - 1.0

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

Description

Set Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

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

4.1.25 - Set Parameter Values

4.1.25.1 - 1.0

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

Description

Set Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

4.1.26 - Set Security Group Rules

4.1.26.1 - 1.0

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

Description

Set Security Group Rules.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.27 - Set Server Type

4.1.27.1 - 1.0

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

Description

Set Server Type.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

4.1.28 - Show Cluster

4.1.28.1 - 1.0

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

Description

Show Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

4.1.29 - Show Request

4.1.29.1 - 1.0

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

Description

Show Request.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

4.1.30 - Start Cluster

4.1.30.1 - 1.0

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

Description

Start Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

4.1.31 - Stop Cluster

4.1.31.1 - 1.0

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

Description

Stop Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

4.1.32 - Switchover Cluster

4.1.32.1 - 1.0

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

Description

Switchover Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

4.1.33 - Synchronize Cluster State

4.1.33.1 - 1.0

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

Description

Synchronize Cluster State.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

4.1.34 - Synchronize Parameter Values

4.1.34.1 - 1.0

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

Description

Synchronize Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

4.1.35 - Terminate Cluster

4.1.35.1 - 1.0

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

Description

Terminate Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

4.1.36 - Unregister Log Export Config

4.1.36.1 - 1.0

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

Description

Unregister Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

4.1.37 - Unset Backup

4.1.37.1 - 1.0

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

Description

Unset Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

4.1.38 - Unset Maintenance

4.1.38.1 - 1.0

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

Description

Unset Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

5 - MySQL(DBaaS)

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of MySQL(DBaaS) service and how to call CLI.

Version

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

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20260531

CLI Version History

1.1

CLI version 1.1 release for MySQL(DBaaS)

Changes

  • [Changed] mysql create cluster - command has been changed.
    • Request model has been changed to MysqlClusterCreateRequestV1Dot1.
    • The following fields are added to the request:
      • service_watch_log_collection
  • [Changed] mysql show cluster - command has been changed.
    • Response model has been changed to MysqlClusterDetailResponseV1Dot1.
    • The following fields are added to the response:
      • is_kernel_patchable
      • service_watch_log_collection
  • [New] mysql create other region replica - command has been added.
  • [New] mysql patch minor version - command has been added.
  • [New] mysql upgrade kernel - command has been added.

1.0

Initial CLI release for MySQL(DBaaS)

Changes

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

5.1 - CLIs

5.1.1 - Add Block Storages

5.1.1.1 - 1.1

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

Description

Add Block Storages.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.1.2 - 1.0

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

Description

Add Block Storages.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.2 - Create Cluster

5.1.2.1 - 1.1

scp-cli mysql 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_case_sensitive <value>]
[--database_character_set <value>]
[--database_port <value>]
[--archive_frequency_minute <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.2.2 - 1.0

scp-cli mysql 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_case_sensitive <value>]
[--database_character_set <value>]
[--database_port <value>]
[--archive_frequency_minute <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.3 - Create Other region Replica

5.1.3.1 - 1.1

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

Description

Create Other region Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.3.2 - 1.0

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

Description

Create Other region Replica.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.4 - Create Replica

5.1.4.1 - 1.1

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

Description

Create Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.4.2 - 1.0

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

Description

Create Replica.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.5 - Create Restore Cluster

5.1.5.1 - 1.1

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

Description

Create Restore Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.5.2 - 1.0

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

Description

Create Restore Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.6 - Export Log

5.1.6.1 - 1.1

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

Description

Export Log.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.6.2 - 1.0

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

Description

Export Log.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.7 - List Backup Histories

5.1.7.1 - 1.1

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

Description

List Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.7.2 - 1.0

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

Description

List Backup Histories.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.8 - List Clusters

5.1.8.1 - 1.1

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

Description

List Clusters.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.8.2 - 1.0

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

Description

List Clusters.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.9 - List Engine Version Properties

5.1.9.1 - 1.1

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

Description

List Engine Version Properties.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

5.1.9.2 - 1.0

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

Description

List Engine Version Properties.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

5.1.10 - List Engine Versions

5.1.10.1 - 1.1

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

Description

List Engine Versions.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.10.2 - 1.0

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

Description

List Engine Versions.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.11 - List Log Export Configs

5.1.11.1 - 1.1

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

Description

List Log Export Configs.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.11.2 - 1.0

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

Description

List Log Export Configs.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.12 - List Parameter Groups

5.1.12.1 - 1.1

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

Description

List Parameter Groups.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.12.2 - 1.0

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

Description

List Parameter Groups.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.13 - List Parameter Values

5.1.13.1 - 1.1

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

Description

List Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.13.2 - 1.0

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

Description

List Parameter Values.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.14 - List Parameters

5.1.14.1 - 1.1

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

Description

List Parameters.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.14.2 - 1.0

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

Description

List Parameters.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.15 - List Replicas

5.1.15.1 - 1.1

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

Description

List Replicas.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.15.2 - 1.0

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

Description

List Replicas.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.16 - List Server Types

5.1.16.1 - 1.1

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

Description

List Server Types.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.16.2 - 1.0

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

Description

List Server Types.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.17 - Patch Minor Version

5.1.17.1 - 1.1

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

Description

Patch Minor Version.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

5.1.17.2 - 1.0

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

Description

Patch Minor Version.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

5.1.18 - Promote Replica Cluster

5.1.18.1 - 1.1

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

Description

Promote Replica Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.18.2 - 1.0

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

Description

Promote Replica Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.19 - Register Log Export Config

5.1.19.1 - 1.1

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

Description

Register Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.19.2 - 1.0

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

Description

Register Log Export Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.20 - Remove Backup Histories

5.1.20.1 - 1.1

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

Description

Remove Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

5.1.20.2 - 1.0

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

Description

Remove Backup Histories.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

5.1.21 - Reset Replica

5.1.21.1 - 1.1

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

Description

Reset Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

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

5.1.21.2 - 1.0

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

Description

Reset Replica.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

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

5.1.22 - Restart Cluster

5.1.22.1 - 1.1

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

Description

Restart Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.22.2 - 1.0

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

Description

Restart Cluster.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.23 - Set Archive Config

5.1.23.1 - 1.1

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

Description

Set Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

5.1.23.2 - 1.0

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

Description

Set Archive Config.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

5.1.24 - Set Backup

5.1.24.1 - 1.1

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

Description

Set Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.24.2 - 1.0

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

Description

Set Backup.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.25 - Set Block Storage Size

5.1.25.1 - 1.1

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

Description

Set Block Storage Size.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

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

Responses

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

5.1.25.2 - 1.0

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

Description

Set Block Storage Size.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

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

Responses

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

5.1.26 - Set Log Export Config

5.1.26.1 - 1.1

scp-cli mysql log export config set
--log_type <value>
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--delete_on_export <value>
--access_key <value>

Description

Set Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
delete_on_export
required
booleanDelete on exportTrue
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

5.1.26.2 - 1.0

scp-cli mysql log export config set
--log_type <value>
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--delete_on_export <value>
--access_key <value>

Description

Set Log Export Config.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
delete_on_export
required
booleanDelete on exportTrue
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

5.1.27 - Set Maintenance

5.1.27.1 - 1.1

scp-cli mysql maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.27.2 - 1.0

scp-cli mysql maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.28 - Set Parameter Values

5.1.28.1 - 1.1

scp-cli mysql parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
parameters
required
arrayParameter request list'{"id": "", "new_value": "", "old_value": ""}'

5.1.28.2 - 1.0

scp-cli mysql parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
parameters
required
arrayParameter request list'{"id": "", "new_value": "", "old_value": ""}'

5.1.29 - Set Security Group Rules

5.1.29.1 - 1.1

scp-cli mysql security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.29.2 - 1.0

scp-cli mysql security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.30 - Set Server Type

5.1.30.1 - 1.1

scp-cli mysql server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.30.2 - 1.0

scp-cli mysql server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.31 - Show Archive Config

5.1.31.1 - 1.1

scp-cli mysql archive config show
--cluster_id <value>

Description

Show Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

5.1.31.2 - 1.0

scp-cli mysql archive config show
--cluster_id <value>

Description

Show Archive Config.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

5.1.32 - Show Cluster

5.1.32.1 - 1.1

scp-cli mysql cluster show
--cluster_id <value>

Description

Show Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
allowable_ip_addressesAllowed IP addresses list[]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engineDBaaS engine
dbaas_engine_version_nameDBaaS engine version name
ha_enabledHA availability
init_config_option{}
instance_countInstance Count
instance_groupsInstance groups list[]
is_kernel_patchableWhether the kernel can be patched
maintenance_optionMaintenance option{}
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
nat_enabledNAT availability
origin_cluster_idOrigin cluster ID
product_image_typeProduct image type
product_typeProduct type
replicasReplicas list
role_typeRole type{}
service_stateService state
service_watch_log_collectionServiceWatch log collection
software_versionSoftware version
subnet_idSubnet ID
timezoneTimezone
vip_public_ip_address(VIP) Public IP Address
vip_public_ip_id(VIP) Public IP ID
virtual_ip_addressVirtual IP address

5.1.32.2 - 1.0

scp-cli mysql cluster show
--cluster_id <value>

Description

Show Cluster.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
allowable_ip_addressesAllowed IP addresses list[]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engineDBaaS engine
dbaas_engine_version_nameDBaaS engine version name
ha_enabledHA availability
init_config_option{}
instance_countInstance Count
instance_groupsInstance groups list[]
maintenance_optionMaintenance option{}
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
nat_enabledNAT availability
origin_cluster_idOrigin cluster ID
product_image_typeProduct image type
product_typeProduct type
replicasReplicas list
role_typeRole type{}
service_stateService state
software_versionSoftware version
subnet_idSubnet ID
timezoneTimezone
vip_public_ip_address(VIP) Public IP Address
vip_public_ip_id(VIP) Public IP ID
virtual_ip_addressVirtual IP address

5.1.33 - Show Request

5.1.33.1 - 1.1

scp-cli mysql request show
--request_id <value>

Description

Show Request.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

5.1.33.2 - 1.0

scp-cli mysql request show
--request_id <value>

Description

Show Request.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

5.1.34 - Start Cluster

5.1.34.1 - 1.1

scp-cli mysql cluster start
--cluster_id <value>

Description

Start Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.34.2 - 1.0

scp-cli mysql cluster start
--cluster_id <value>

Description

Start Cluster.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.35 - Stop Cluster

5.1.35.1 - 1.1

scp-cli mysql cluster stop
--cluster_id <value>

Description

Stop Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.35.2 - 1.0

scp-cli mysql cluster stop
--cluster_id <value>

Description

Stop Cluster.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.36 - Switchover Cluster

5.1.36.1 - 1.1

scp-cli mysql cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.36.2 - 1.0

scp-cli mysql cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.37 - Synchronize Archive Config

5.1.37.1 - 1.1

scp-cli mysql archive config sync
--cluster_id <value>

Description

Synchronize Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.37.2 - 1.0

scp-cli mysql archive config sync
--cluster_id <value>

Description

Synchronize Archive Config.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.38 - Synchronize Cluster State

5.1.38.1 - 1.1

scp-cli mysql cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.38.2 - 1.0

scp-cli mysql cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.39 - Synchronize Parameter Values

5.1.39.1 - 1.1

scp-cli mysql parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.39.2 - 1.0

scp-cli mysql parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.40 - Synchronize Replica State

5.1.40.1 - 1.1

scp-cli mysql replica state sync
--origin_cluster_id <value>

Description

Synchronize Replica State.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.40.2 - 1.0

scp-cli mysql replica state sync
--origin_cluster_id <value>

Description

Synchronize Replica State.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.41 - Terminate Cluster

5.1.41.1 - 1.1

scp-cli mysql cluster delete
--cluster_id <value>

Description

Terminate Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

5.1.41.2 - 1.0

scp-cli mysql cluster delete
--cluster_id <value>

Description

Terminate Cluster.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

5.1.42 - Unregister Log Export Config

5.1.42.1 - 1.1

scp-cli mysql log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

5.1.42.2 - 1.0

scp-cli mysql log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

5.1.43 - Unset Backup

5.1.43.1 - 1.1

scp-cli mysql backup unset
--cluster_id <value>

Description

Unset Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

5.1.43.2 - 1.0

scp-cli mysql backup unset
--cluster_id <value>

Description

Unset Backup.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

5.1.44 - Unset Maintenance

5.1.44.1 - 1.1

scp-cli mysql maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

5.1.44.2 - 1.0

scp-cli mysql maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

5.1.45 - Upgrade Kernel

5.1.45.1 - 1.1

scp-cli mysql kernel upgrade
--cluster_id <value>

Description

Upgrade Kernel.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

5.1.45.2 - 1.0

scp-cli mysql kernel upgrade
--cluster_id <value>

Description

Upgrade Kernel.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6 - PostgreSQL(DBaaS)

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of PostgreSQL(DBaaS) service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20260531

CLI Version History

1.1

CLI version 1.1 release for PostgreSQL(DBaaS)

Changes

  • [Changed] postgresql show cluster - command has been changed.
    • Response model has been changed to PostgresqlClusterDetailResponseV1Dot1.
    • The following fields are added to the response:
      • is_kernel_patchable
  • [New] postgresql patch minor version - command has been added.
  • [New] postgresql upgrade kernel - command has been added.

1.0

Initial CLI release for PostgreSQL(DBaaS)

Changes

  • [New] postgresql add block storages - command has been added.
  • [New] postgresql create cluster - command has been added.
  • [New] postgresql create other region replica - command has been added.
  • [New] postgresql create replica - command has been added.
  • [New] postgresql create restore - command has been added.
  • [New] postgresql delete archive log - command has been added.
  • [New] postgresql delete cluster - command has been added.
  • [New] postgresql export log - command has been added.
  • [New] postgresql list backup histories - command has been added.
  • [New] postgresql list clusters - command has been added.
  • [New] postgresql list engine version properties - command has been added.
  • [New] postgresql list engine versions - command has been added.
  • [New] postgresql list log export configs - command has been added.
  • [New] postgresql list parameter groups - command has been added.
  • [New] postgresql list parameter values - command has been added.
  • [New] postgresql list parameters - command has been added.
  • [New] postgresql list replicas - command has been added.
  • [New] postgresql list server types - command has been added.
  • [New] postgresql promote replica cluster - command has been added.
  • [New] postgresql register log export config - command has been added.
  • [New] postgresql remove backup histories - command has been added.
  • [New] postgresql reset replica - command has been added.
  • [New] postgresql restart cluster - command has been added.
  • [New] postgresql set archive config - command has been added.
  • [New] postgresql set audit log - command has been added.
  • [New] postgresql set backup - command has been added.
  • [New] postgresql set block storage size - command has been added.
  • [New] postgresql set log export config - command has been added.
  • [New] postgresql set maintenance - command has been added.
  • [New] postgresql set parameter values - command has been added.
  • [New] postgresql set security group rules - command has been added.
  • [New] postgresql set server type - command has been added.
  • [New] postgresql show archive config - command has been added.
  • [New] postgresql show cluster - command has been added.
  • [New] postgresql show request - command has been added.
  • [New] postgresql start cluster - command has been added.
  • [New] postgresql stop cluster - command has been added.
  • [New] postgresql switchover cluster - command has been added.
  • [New] postgresql sync archive config - command has been added.
  • [New] postgresql sync cluster state - command has been added.
  • [New] postgresql sync parameter values - command has been added.
  • [New] postgresql sync replica state - command has been added.
  • [New] postgresql unregister log export config - command has been added.
  • [New] postgresql unset backup - command has been added.
  • [New] postgresql unset maintenance - command has been added.

6.1 - CLIs

6.1.1 - Add Block Storages

6.1.1.1 - 1.1

scp-cli postgresql block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]

Description

Add Block Storages.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole typeOS
volume_type
optional
stringVolume type-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.2 - 1.0

scp-cli postgresql block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]

Description

Add Block Storages.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole typeOS
volume_type
optional
stringVolume type-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.2 - Create Cluster

6.1.2.1 - 1.1

scp-cli postgresql cluster create
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--ha_enabled <value>]
[--nat_enabled <value>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_encoding <value>]
[--database_locale <value>]
[--database_port <value>]
[--archive_frequency_minute <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_name
required
stringDatabase Name-
timezone
required
stringTimezoneAsia/Seoul
subnet_id
required
stringSubnet ID1ddd7f1e4a8a43ed8b82d70cade0b321
name
required
stringCluster namemycluster
instance_name_prefix
required
stringInstance name prefixmyprefix
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}'
dbaas_engine_version_id
required
stringDBaaS engine version IDc1b856dd12754c0ba2614a39d0ed3ad1
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
ha_enabled
optional
booleanHA availability-
nat_enabled
optional
booleanNAT availability-
origin_cluster_id
optional
stringOrigin cluster ID-
tags
optional
arraytag'{"key": "", "value": ""}'
vip_public_ip_id
optional
string(VIP) Public IP ID-
virtual_ip_address
optional
stringVirtual IP address-
audit_enabled
optional
booleanAudit usage state-
database_encoding
optional
stringDatabase encoding-
database_locale
optional
stringDatabase locale information-
database_port
optional
integerDatabase service port-
archive_frequency_minute
optional
stringBackup starting time (minute)-
retention_period_day
optional
stringBackup retention period (day)7
starting_time_hour
optional
stringBackup starting time (hour)2
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.2.2 - 1.0

scp-cli postgresql cluster create
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--ha_enabled <value>]
[--nat_enabled <value>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_encoding <value>]
[--database_locale <value>]
[--database_port <value>]
[--archive_frequency_minute <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_name
required
stringDatabase Name-
timezone
required
stringTimezoneAsia/Seoul
subnet_id
required
stringSubnet ID1ddd7f1e4a8a43ed8b82d70cade0b321
name
required
stringCluster namemycluster
instance_name_prefix
required
stringInstance name prefixmyprefix
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}'
dbaas_engine_version_id
required
stringDBaaS engine version IDc1b856dd12754c0ba2614a39d0ed3ad1
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
ha_enabled
optional
booleanHA availability-
nat_enabled
optional
booleanNAT availability-
origin_cluster_id
optional
stringOrigin cluster ID-
tags
optional
arraytag'{"key": "", "value": ""}'
vip_public_ip_id
optional
string(VIP) Public IP ID-
virtual_ip_address
optional
stringVirtual IP address-
audit_enabled
optional
booleanAudit usage state-
database_encoding
optional
stringDatabase encoding-
database_locale
optional
stringDatabase locale information-
database_port
optional
integerDatabase service port-
archive_frequency_minute
optional
stringBackup starting time (minute)-
retention_period_day
optional
stringBackup retention period (day)7
starting_time_hour
optional
stringBackup starting time (hour)2
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.3 - Create Other region Replica

6.1.3.1 - 1.1

scp-cli postgresql replica dr create
--cluster_id <value>
--subnet_id <value>
--replicas <value>
--replica_count <value>
--region <value>
--nat_enabled <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Other region Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
subnet_id
required
stringSubnet ID-
replicas
required
arrayReplicas list'{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}'
replica_count
required
integerReplica count-
region
required
stringReplica region-
nat_enabled
required
booleanNAT availability-
allowable_ip_addresses
required
arrayAllowed IP addresses list-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.3.2 - 1.0

scp-cli postgresql replica dr create
--cluster_id <value>
--subnet_id <value>
--replicas <value>
--replica_count <value>
--region <value>
--nat_enabled <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Other region Replica.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
subnet_id
required
stringSubnet ID-
replicas
required
arrayReplicas list'{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}'
replica_count
required
integerReplica count-
region
required
stringReplica region-
nat_enabled
required
booleanNAT availability-
allowable_ip_addresses
required
arrayAllowed IP addresses list-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.4 - Create Replica

6.1.4.1 - 1.1

scp-cli postgresql replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
replicas
required
arrayReplicas list'{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}'
replica_count
required
integerReplica count-
allowable_ip_addresses
required
arrayAllowed IP addresses list-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.4.2 - 1.0

scp-cli postgresql replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Replica.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
replicas
required
arrayReplicas list'{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}'
replica_count
required
integerReplica count-
allowable_ip_addresses
required
arrayAllowed IP addresses list-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.5 - Create Restore Cluster

6.1.5.1 - 1.1

scp-cli postgresql restore create
--cluster_id <value>
--server_type_name <value>
--name <value>
--instance_name_prefix <value>
[--allowable_ip_addresses <value>]
[--backup_history_number <value>]
[--backup_recovery_time <value>]
[--block_storage_groups <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Restore Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
server_type_name
required
stringServer type name-
name
required
stringCluster namemycluster
instance_name_prefix
required
stringInstance name prefixmyprefix
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
backup_history_number
optional
stringBackup id202501010000
backup_recovery_time
optional
stringBackup Recovery Time-
block_storage_groups
optional
arrayBlock storage groups list'{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}'
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.5.2 - 1.0

scp-cli postgresql restore create
--cluster_id <value>
--server_type_name <value>
--name <value>
--instance_name_prefix <value>
[--allowable_ip_addresses <value>]
[--backup_history_number <value>]
[--backup_recovery_time <value>]
[--block_storage_groups <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Restore Cluster.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
server_type_name
required
stringServer type name-
name
required
stringCluster namemycluster
instance_name_prefix
required
stringInstance name prefixmyprefix
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
backup_history_number
optional
stringBackup id202501010000
backup_recovery_time
optional
stringBackup Recovery Time-
block_storage_groups
optional
arrayBlock storage groups list'{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}'
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours5
starting_day_of_week
optional
stringStarting day of weekMON
starting_time
optional
stringStarting time0000

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.6 - Delete Archive Log

6.1.6.1 - 1.1

scp-cli postgresql archive log delete
--cluster_id <value>
[--type <value>]

Description

Delete Archive Log.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
stringArchive log typeALL

6.1.6.2 - 1.0

scp-cli postgresql archive log delete
--cluster_id <value>
[--type <value>]

Description

Delete Archive Log.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
stringArchive log typeALL

6.1.7 - Export Log

6.1.7.1 - 1.1

scp-cli postgresql log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.7.2 - 1.0

scp-cli postgresql log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.8 - List Backup Histories

6.1.8.1 - 1.1

scp-cli postgresql backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]

Description

List Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
limit
optional
integerNumber of backup lists-
page
optional
integerBackup list page-

Responses

NameDescriptionExample
backup_end_atBackup end time
backup_history_numberBackup id
backup_size_gbBackup amount(GB)
backup_start_atBackup start time
backup_stateBackup state
backup_state_detailBackup detail state
software_versionSoftware version

6.1.8.2 - 1.0

scp-cli postgresql backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]

Description

List Backup Histories.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
limit
optional
integerNumber of backup lists-
page
optional
integerBackup list page-

Responses

NameDescriptionExample
backup_end_atBackup end time
backup_history_numberBackup id
backup_size_gbBackup amount(GB)
backup_start_atBackup start time
backup_stateBackup state
backup_state_detailBackup detail state
software_versionSoftware version

6.1.9 - List Clusters

6.1.9.1 - 1.1

scp-cli postgresql cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]

Description

List Clusters.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-
database_name
optional
stringDatabase Name-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

6.1.9.2 - 1.0

scp-cli postgresql cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]

Description

List Clusters.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-
database_name
optional
stringDatabase Name-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

6.1.10 - List Engine Version Properties

6.1.10.1 - 1.1

scp-cli postgresql engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

6.1.10.2 - 1.0

scp-cli postgresql engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

6.1.11 - List Engine Versions

6.1.11.1 - 1.1

scp-cli postgresql engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

6.1.11.2 - 1.0

scp-cli postgresql engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

6.1.12 - List Log Export Configs

6.1.12.1 - 1.1

scp-cli postgresql log export configs list
--cluster_id <value>
[--type <value>]

Description

List Log Export Configs.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
****Log typealert

Responses

NameDescriptionExample
bucket_nameBucket nameexamplebucket
delete_on_exportDelete on exportTrue
is_bucket_deletedBucket deletedFalse
is_registeredLog type registration stateTrue
log_labelLog labelDB Alert Log
log_typeLog typealert
schedule_day_of_monthSchedule day of month28
schedule_day_of_weekSchedule day of weekMON
schedule_frequency_typeSchedule frequency typeDAY
schedule_hourSchedule hour12

6.1.12.2 - 1.0

scp-cli postgresql log export configs list
--cluster_id <value>
[--type <value>]

Description

List Log Export Configs.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
****Log typealert

Responses

NameDescriptionExample
bucket_nameBucket nameexamplebucket
delete_on_exportDelete on exportTrue
is_bucket_deletedBucket deletedFalse
is_registeredLog type registration stateTrue
log_labelLog labelDB Alert Log
log_typeLog typealert
schedule_day_of_monthSchedule day of month28
schedule_day_of_weekSchedule day of weekMON
schedule_frequency_typeSchedule frequency typeDAY
schedule_hourSchedule hour12

6.1.13 - List Parameter Groups

6.1.13.1 - 1.1

scp-cli postgresql parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]

Description

List Parameter Groups.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
major_version
optional
stringSoftware major version-
product_image_type
optional
stringProduct image type-
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter group ID
major_versionSoftware major version
nameParameter group name
product_image_typeProduct image type
product_typeProduct type

6.1.13.2 - 1.0

scp-cli postgresql parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]

Description

List Parameter Groups.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
major_version
optional
stringSoftware major version-
product_image_type
optional
stringProduct image type-
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter group ID
major_versionSoftware major version
nameParameter group name
product_image_typeProduct image type
product_typeProduct type

6.1.14 - List Parameter Values

6.1.14.1 - 1.1

scp-cli postgresql parameter value list
--cluster_id <value>

Description

List Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idParameter id
allows_valueParameter allows value
applied_valueParameter applied value
apply_typeParameter apply type
data_typeParameter data type
default_valueParameter default value
descriptionParameter description
is_modifiableParameter is_modifiable
nameParameter name
software_typeParameter software type

6.1.14.2 - 1.0

scp-cli postgresql parameter value list
--cluster_id <value>

Description

List Parameter Values.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idParameter id
allows_valueParameter allows value
applied_valueParameter applied value
apply_typeParameter apply type
data_typeParameter data type
default_valueParameter default value
descriptionParameter description
is_modifiableParameter is_modifiable
nameParameter name
software_typeParameter software type

6.1.15 - List Parameters

6.1.15.1 - 1.1

scp-cli postgresql parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List Parameters.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
dbaas_parameter_group_id
required
stringParameter group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter id
dbaas_parameter_group_idParameter id
default_valueParameter default value
descriptionParameter description
nameParameter name
software_typeParameter software type

6.1.15.2 - 1.0

scp-cli postgresql parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List Parameters.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
dbaas_parameter_group_id
required
stringParameter group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter id
dbaas_parameter_group_idParameter id
default_valueParameter default value
descriptionParameter description
nameParameter name
software_typeParameter software type

6.1.16 - List Replicas

6.1.16.1 - 1.1

scp-cli postgresql replica list
--cluster_id <value>

Description

List Replicas.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
nameServer name
regionReplica region
replica_stateReplica state
replica_state_detailReplica detail state
synced_atReplica check time

6.1.16.2 - 1.0

scp-cli postgresql replica list
--cluster_id <value>

Description

List Replicas.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
nameServer name
regionReplica region
replica_stateReplica state
replica_state_detailReplica detail state
synced_atReplica check time

6.1.17 - List Server Types

6.1.17.1 - 1.1

scp-cli postgresql engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

6.1.17.2 - 1.0

scp-cli postgresql engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

6.1.18 - Patch Minor Version

6.1.18.1 - 1.1

scp-cli postgresql minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>

Description

Patch Minor Version.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
software_version
required
stringsoftware_version-
backup_before_upgrade
required
booleanbackup_before_upgrade-

6.1.18.2 - 1.0

scp-cli postgresql minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>

Description

Patch Minor Version.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
software_version
required
stringsoftware_version-
backup_before_upgrade
required
booleanbackup_before_upgrade-

6.1.19 - Promote Replica Cluster

6.1.19.1 - 1.1

scp-cli postgresql replica cluster promote
--cluster_id <value>

Description

Promote Replica Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.19.2 - 1.0

scp-cli postgresql replica cluster promote
--cluster_id <value>

Description

Promote Replica Cluster.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.20 - Register Log Export Config

6.1.20.1 - 1.1

scp-cli postgresql log export config register
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--log_type <value>
--delete_on_export <value>
--bucket_name <value>
--access_key <value>

Description

Register Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
log_type
required
stringLog typealert
delete_on_export
required
booleanDelete on exportTrue
bucket_name
required
stringBucket nameexamplebucket
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.20.2 - 1.0

scp-cli postgresql log export config register
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--log_type <value>
--delete_on_export <value>
--bucket_name <value>
--access_key <value>

Description

Register Log Export Config.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
log_type
required
stringLog typealert
delete_on_export
required
booleanDelete on exportTrue
bucket_name
required
stringBucket nameexamplebucket
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.21 - Remove Backup Histories

6.1.21.1 - 1.1

scp-cli postgresql backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

6.1.21.2 - 1.0

scp-cli postgresql backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

6.1.22 - Reset Replica

6.1.22.1 - 1.1

scp-cli postgresql replica reset
--replica_cluster_id <value>

Description

Reset Replica.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.22.2 - 1.0

scp-cli postgresql replica reset
--replica_cluster_id <value>

Description

Reset Replica.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.23 - Restart Cluster

6.1.23.1 - 1.1

scp-cli postgresql cluster restart
--cluster_id <value>

Description

Restart Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.23.2 - 1.0

scp-cli postgresql cluster restart
--cluster_id <value>

Description

Restart Cluster.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.24 - Set Archive Config

6.1.24.1 - 1.1

scp-cli postgresql archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]

Description

Set Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
archive_enabled
required
booleanArchive enabledTrue
retention_period_day
optional
integerBackup retention period (day)-

6.1.24.2 - 1.0

scp-cli postgresql archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]

Description

Set Archive Config.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
archive_enabled
required
booleanArchive enabledTrue
retention_period_day
optional
integerBackup retention period (day)-

6.1.25 - Set Audit Log

6.1.25.1 - 1.1

scp-cli postgresql audit log set
--cluster_id <value>
--use_audit_log <value>

Description

Set Audit Log.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
use_audit_log
required
booleanuse_audit_log-

6.1.25.2 - 1.0

scp-cli postgresql audit log set
--cluster_id <value>
--use_audit_log <value>

Description

Set Audit Log.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
use_audit_log
required
booleanuse_audit_log-

6.1.26 - Set Backup

6.1.26.1 - 1.1

scp-cli postgresql backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>

Description

Set Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-
archive_frequency_minute
required
stringBackup starting time (minute)-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.26.2 - 1.0

scp-cli postgresql backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>

Description

Set Backup.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-
archive_frequency_minute
required
stringBackup starting time (minute)-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.27 - Set Block Storage Size

6.1.27.1 - 1.1

scp-cli postgresql block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.27.2 - 1.0

scp-cli postgresql block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.28 - Set Log Export Config

6.1.28.1 - 1.1

scp-cli postgresql log export config set
--log_type <value>
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--delete_on_export <value>
--access_key <value>

Description

Set Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
delete_on_export
required
booleanDelete on exportTrue
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

6.1.28.2 - 1.0

scp-cli postgresql log export config set
--log_type <value>
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--delete_on_export <value>
--access_key <value>

Description

Set Log Export Config.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
delete_on_export
required
booleanDelete on exportTrue
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

6.1.29 - Set Maintenance

6.1.29.1 - 1.1

scp-cli postgresql maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.29.2 - 1.0

scp-cli postgresql maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.30 - Set Parameter Values

6.1.30.1 - 1.1

scp-cli postgresql parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
parameters
required
arrayParameter request list'{"id": "", "new_value": "", "old_value": ""}'

6.1.30.2 - 1.0

scp-cli postgresql parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
parameters
required
arrayParameter request list'{"id": "", "new_value": "", "old_value": ""}'

6.1.31 - Set Security Group Rules

6.1.31.1 - 1.1

scp-cli postgresql security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.31.2 - 1.0

scp-cli postgresql security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.32 - Set Server Type

6.1.32.1 - 1.1

scp-cli postgresql server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.32.2 - 1.0

scp-cli postgresql server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.33 - Show Archive Config

6.1.33.1 - 1.1

scp-cli postgresql archive config show
--cluster_id <value>

Description

Show Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

6.1.33.2 - 1.0

scp-cli postgresql archive config show
--cluster_id <value>

Description

Show Archive Config.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

6.1.34 - Show Cluster

6.1.34.1 - 1.1

scp-cli postgresql cluster show
--cluster_id <value>

Description

Show Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
allowable_ip_addressesAllowed IP addresses list[]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engineDBaaS engine
dbaas_engine_version_nameDBaaS engine version name
ha_enabledHA availability
init_config_optionDB initial configuration option
instance_countInstance Count
instance_groupsInstance groups list[]
is_kernel_patchableWhether the kernel can be patched
maintenance_optionMaintenance option{}
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
nat_enabledNAT availability
origin_cluster_idOrigin cluster ID
product_image_typeProduct image type
product_typeProduct type
replicasReplicas list[]
role_typeRole type{}
service_stateService state
software_versionSoftware version
subnet_idSubnet ID
timezoneTimezone
vip_public_ip_address(VIP) Public IP Address
vip_public_ip_id(VIP) Public IP ID
virtual_ip_addressVirtual IP address

6.1.34.2 - 1.0

scp-cli postgresql cluster show
--cluster_id <value>

Description

Show Cluster.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
allowable_ip_addressesAllowed IP addresses list[]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engineDBaaS engine
dbaas_engine_version_nameDBaaS engine version name
ha_enabledHA availability
init_config_optionDB initial configuration option
instance_countInstance Count
instance_groupsInstance groups list[]
maintenance_optionMaintenance option{}
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
nat_enabledNAT availability
origin_cluster_idOrigin cluster ID
product_image_typeProduct image type
product_typeProduct type
replicasReplicas list[]
role_typeRole type{}
service_stateService state
software_versionSoftware version
subnet_idSubnet ID
timezoneTimezone
vip_public_ip_address(VIP) Public IP Address
vip_public_ip_id(VIP) Public IP ID
virtual_ip_addressVirtual IP address

6.1.35 - Show Request

6.1.35.1 - 1.1

scp-cli postgresql request show
--request_id <value>

Description

Show Request.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

6.1.35.2 - 1.0

scp-cli postgresql request show
--request_id <value>

Description

Show Request.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

6.1.36 - Start Cluster

6.1.36.1 - 1.1

scp-cli postgresql cluster start
--cluster_id <value>

Description

Start Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.36.2 - 1.0

scp-cli postgresql cluster start
--cluster_id <value>

Description

Start Cluster.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.37 - Stop Cluster

6.1.37.1 - 1.1

scp-cli postgresql cluster stop
--cluster_id <value>

Description

Stop Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.37.2 - 1.0

scp-cli postgresql cluster stop
--cluster_id <value>

Description

Stop Cluster.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.38 - Switchover Cluster

6.1.38.1 - 1.1

scp-cli postgresql cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.38.2 - 1.0

scp-cli postgresql cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.39 - Synchronize Archive Config

6.1.39.1 - 1.1

scp-cli postgresql archive config sync
--cluster_id <value>

Description

Synchronize Archive Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.39.2 - 1.0

scp-cli postgresql archive config sync
--cluster_id <value>

Description

Synchronize Archive Config.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.40 - Synchronize Cluster State

6.1.40.1 - 1.1

scp-cli postgresql cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.40.2 - 1.0

scp-cli postgresql cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.41 - Synchronize Parameter Values

6.1.41.1 - 1.1

scp-cli postgresql parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.41.2 - 1.0

scp-cli postgresql parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.42 - Synchronize Replica State

6.1.42.1 - 1.1

scp-cli postgresql replica state sync
--origin_cluster_id <value>

Description

Synchronize Replica State.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.42.2 - 1.0

scp-cli postgresql replica state sync
--origin_cluster_id <value>

Description

Synchronize Replica State.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.43 - Terminate Cluster

6.1.43.1 - 1.1

scp-cli postgresql cluster delete
--cluster_id <value>

Description

Terminate Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.1.43.2 - 1.0

scp-cli postgresql cluster delete
--cluster_id <value>

Description

Terminate Cluster.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.1.44 - Unregister Log Export Config

6.1.44.1 - 1.1

scp-cli postgresql log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

6.1.44.2 - 1.0

scp-cli postgresql log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

6.1.45 - Unset Backup

6.1.45.1 - 1.1

scp-cli postgresql backup unset
--cluster_id <value>

Description

Unset Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.1.45.2 - 1.0

scp-cli postgresql backup unset
--cluster_id <value>

Description

Unset Backup.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.1.46 - Unset Maintenance

6.1.46.1 - 1.1

scp-cli postgresql maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

6.1.46.2 - 1.0

scp-cli postgresql maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

6.1.47 - Upgrade Kernel

6.1.47.1 - 1.1

scp-cli postgresql kernel upgrade
--cluster_id <value>

Description

Upgrade Kernel.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.1.47.2 - 1.0

scp-cli postgresql kernel upgrade
--cluster_id <value>

Description

Upgrade Kernel.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-