Database

1 - CacheStore(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 CacheStore(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

1.1 - CLIs

1.1.1 - Create Cluster

1.1.1.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user password-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
array'{"block_storage_groups": [{"role_type": "", "size_gb": "", "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}'
dbaas_engine_version_id
required
stringDBaaS engine version ID-
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 hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

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

1.1.2 - Create Restore Cluster

1.1.2.1 - 1.0

scpcli cachestore 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

Responses

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

1.1.3 - List Backup Histories

1.1.3.1 - 1.0

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

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

1.1.5 - List Commands

1.1.5.1 - 1.0

scpcli cachestore command list
--cluster_id <value>

Description

List Commands.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli cachestore engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli cachestore parameter value list
--cluster_id <value>

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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 - Remove Backup Histories

1.1.12.1 - 1.0

scpcli cachestore backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

1.1.13 - Restart Cluster

1.1.13.1 - 1.0

scpcli cachestore cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

1.1.14 - Set Backup

1.1.14.1 - 1.0

scpcli cachestore backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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.15 - Set Block Storage Size

1.1.15.1 - 1.0

scpcli cachestore block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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.16 - Set Maintenance

1.1.16.1 - 1.0

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

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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.17 - Set Parameter Values

1.1.17.1 - 1.0

scpcli cachestore parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

1.1.18 - Set Security Group Rules

1.1.18.1 - 1.0

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

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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.19 - Set Server Type

1.1.19.1 - 1.0

scpcli cachestore server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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.20 - Show Cluster

1.1.20.1 - 1.0

scpcli cachestore cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
backup_optionBackup setting option
database_port
sentinel_port

1.1.21 - Show Request

1.1.21.1 - 1.0

scpcli cachestore request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

1.1.22 - Start Cluster

1.1.22.1 - 1.0

scpcli cachestore cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

1.1.23 - Stop Cluster

1.1.23.1 - 1.0

scpcli cachestore cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

1.1.24 - Switchover Cluster

1.1.24.1 - 1.0

scpcli cachestore cluster switchover
--cluster_id <value>
--switch_host_name <value>

Description

Switchover Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
switch_host_name
required
stringSwitch over target-

Responses

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

1.1.25 - Synchronize Cluster State

1.1.25.1 - 1.0

scpcli cachestore cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

1.1.26 - Synchronize Commands

1.1.26.1 - 1.0

scpcli cachestore command sync
--cluster_id <value>

Description

Synchronize Commands.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

1.1.27 - Synchronize Parameter Values

1.1.27.1 - 1.0

scpcli cachestore parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

1.1.28 - Terminate Cluster

1.1.28.1 - 1.0

scpcli cachestore cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

1.1.29 - Unset Backup

1.1.29.1 - 1.0

scpcli cachestore backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

1.1.30 - Unset Maintenance

1.1.30.1 - 1.0

scpcli cachestore maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

1.1.31 - Update Commands

1.1.31.1 - 1.0

scpcli cachestore command set
--cluster_id <value>
--commands <value>

Description

Update Commands.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

2 - EPAS(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 EPAS(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

2.1 - CLIs

2.1.1 - Add Block Storages

2.1.1.1 - 1.0

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

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole type-
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.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_name
required
stringDatabase Name-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}'
dbaas_engine_version_id
required
stringDBaaS engine version ID-
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 hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

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

2.1.3 - Create Replica

2.1.3.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
replicas
required
arrayReplicas list'{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "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 hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

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

2.1.4 - Create Restore Cluster

2.1.4.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

Responses

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

2.1.5 - Delete Archive Log

2.1.5.1 - 1.0

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

Description

Delete Archive Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
stringArchive log typeALL

2.1.6 - Export Log

2.1.6.1 - 1.0

scpcli epas log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2.1.7 - List Backup Histories

2.1.7.1 - 1.0

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

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2.1.8 - List Clusters

2.1.8.1 - 1.0

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

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

2.1.9 - List Engine Version Properties

2.1.9.1 - 1.0

scpcli epas engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

2.1.10 - List Engine Versions

2.1.10.1 - 1.0

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

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2.1.11 - List Log Export Configs

2.1.11.1 - 1.0

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

Description

List Log Export Configs.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2.1.12 - List Parameter Groups

2.1.12.1 - 1.0

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

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2.1.13 - List Parameter Values

2.1.13.1 - 1.0

scpcli epas parameter value list
--cluster_id <value>

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2.1.14 - List Parameters

2.1.14.1 - 1.0

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

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2.1.15 - List Replicas

2.1.15.1 - 1.0

scpcli epas replica list
--cluster_id <value>

Description

List Replicas.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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 - List Server Types

2.1.16.1 - 1.0

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

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2.1.17 - Patch Minor Version

2.1.17.1 - 1.0

scpcli epas minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>

Description

Patch Minor Version.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

2.1.18 - Promote Replica Cluster

2.1.18.1 - 1.0

scpcli epas replica cluster promote
--cluster_id <value>

Description

Promote Replica Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.19 - Register Log Export Config

2.1.19.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2.1.20 - Remove Backup Histories

2.1.20.1 - 1.0

scpcli epas backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

2.1.21 - Reset Replica

2.1.21.1 - 1.0

scpcli epas replica reset
--replica_cluster_id <value>

Description

Reset Replica.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

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

2.1.22 - Restart Cluster

2.1.22.1 - 1.0

scpcli epas cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.23 - Set Archive Config

2.1.23.1 - 1.0

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

Description

Set Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

2.1.24 - Set Audit Log

2.1.24.1 - 1.0

scpcli epas audit log set
--cluster_id <value>
--use_audit_log <value>

Description

Set Audit Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
use_audit_log
required
booleanuse_audit_log-

2.1.25 - Set Backup

2.1.25.1 - 1.0

scpcli epas backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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)-
archive_frequency_minute
required
stringBackup starting time (minute)-

Responses

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

2.1.26 - Set Block Storage Size

2.1.26.1 - 1.0

scpcli epas block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2.1.27 - Set Log Export Config

2.1.27.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2.1.28 - Set Maintenance

2.1.28.1 - 1.0

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

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2.1.29 - Set Parameter Values

2.1.29.1 - 1.0

scpcli epas parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

2.1.30 - Set Security Group Rules

2.1.30.1 - 1.0

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

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2.1.31 - Set Server Type

2.1.31.1 - 1.0

scpcli epas server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2.1.32 - Show Archive Config

2.1.32.1 - 1.0

scpcli epas archive config show
--cluster_id <value>

Description

Show Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

2.1.33 - Show Cluster

2.1.33.1 - 1.0

scpcli epas cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID
block_storage_groupsBlock storage groups list
instancesInstances list
role_typeRole type
server_type_nameServer type name

2.1.34 - Show Request

2.1.34.1 - 1.0

scpcli epas request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

2.1.35 - Start Cluster

2.1.35.1 - 1.0

scpcli epas cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.36 - Stop Cluster

2.1.36.1 - 1.0

scpcli epas cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.37 - Switchover Cluster

2.1.37.1 - 1.0

scpcli epas cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.38 - Synchronize Archive Config

2.1.38.1 - 1.0

scpcli epas archive config sync
--cluster_id <value>

Description

Synchronize Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

2.1.39 - Synchronize Cluster State

2.1.39.1 - 1.0

scpcli epas cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.40 - Synchronize Parameter Values

2.1.40.1 - 1.0

scpcli epas parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

2.1.41 - Synchronize Replica State

2.1.41.1 - 1.0

scpcli epas replica state sync
--origin_cluster_id <value>

Description

Synchronize Replica State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

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

2.1.42 - Terminate Cluster

2.1.42.1 - 1.0

scpcli epas cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

2.1.43 - Unregister Log Export Config

2.1.43.1 - 1.0

scpcli epas log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

2.1.44 - Unset Backup

2.1.44.1 - 1.0

scpcli epas backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

2.1.45 - Unset Maintenance

2.1.45.1 - 1.0

scpcli epas maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

3 - MariaDB(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 MariaDB(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

3.1 - CLIs

3.1.1 - Add Block Storages

3.1.1.1 - 1.0

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

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole type-
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.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_name
required
stringDatabase Name-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}'
dbaas_engine_version_id
required
stringDBaaS engine version ID-
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 hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

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

3.1.3 - Create Replica

3.1.3.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
replicas
required
arrayReplicas list'{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "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 hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

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

3.1.4 - Create Restore Cluster

3.1.4.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

Responses

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

3.1.5 - Export Log

3.1.5.1 - 1.0

scpcli mariadb log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

3.1.6 - List Backup Histories

3.1.6.1 - 1.0

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

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

3.1.7 - List Clusters

3.1.7.1 - 1.0

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

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

3.1.8 - List Engine Version Properties

3.1.8.1 - 1.0

scpcli mariadb engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

3.1.9 - List Engine Versions

3.1.9.1 - 1.0

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

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

3.1.10 - List Log Export Configs

3.1.10.1 - 1.0

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

Description

List Log Export Configs.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

3.1.11 - List Parameter Groups

3.1.11.1 - 1.0

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

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

3.1.12 - List Parameter Values

3.1.12.1 - 1.0

scpcli mariadb parameter value list
--cluster_id <value>

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

3.1.13 - List Parameters

3.1.13.1 - 1.0

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

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

3.1.14 - List Replicas

3.1.14.1 - 1.0

scpcli mariadb replica list
--cluster_id <value>

Description

List Replicas.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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 - List Server Types

3.1.15.1 - 1.0

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

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

3.1.16 - Patch Minor Version

3.1.16.1 - 1.0

scpcli mariadb minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>

Description

Patch Minor Version.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

3.1.17 - Promote Replica Cluster

3.1.17.1 - 1.0

scpcli mariadb replica cluster promote
--cluster_id <value>

Description

Promote Replica Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.18 - Register Log Export Config

3.1.18.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

3.1.19 - Remove Backup Histories

3.1.19.1 - 1.0

scpcli mariadb backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

3.1.20 - Reset Replica

3.1.20.1 - 1.0

scpcli mariadb replica reset
--replica_cluster_id <value>

Description

Reset Replica.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

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

3.1.21 - Restart Cluster

3.1.21.1 - 1.0

scpcli mariadb cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.22 - Set Archive Config

3.1.22.1 - 1.0

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

Description

Set Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

3.1.23 - Set Audit Log

3.1.23.1 - 1.0

scpcli mariadb audit log set
--cluster_id <value>
--use_audit_log <value>

Description

Set Audit Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
use_audit_log
required
booleanuse_audit_log-

3.1.24 - Set Backup

3.1.24.1 - 1.0

scpcli mariadb backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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)-
archive_frequency_minute
required
stringBackup starting time (minute)-

Responses

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

3.1.25 - Set Block Storage Size

3.1.25.1 - 1.0

scpcli mariadb block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

3.1.26 - Set Log Export Config

3.1.26.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

3.1.27 - Set Maintenance

3.1.27.1 - 1.0

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

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

3.1.28 - Set Parameter Values

3.1.28.1 - 1.0

scpcli mariadb parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

3.1.29 - Set Security Group Rules

3.1.29.1 - 1.0

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

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

3.1.30 - Set Server Type

3.1.30.1 - 1.0

scpcli mariadb server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

3.1.31 - Show Archive Config

3.1.31.1 - 1.0

scpcli mariadb archive config show
--cluster_id <value>

Description

Show Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

3.1.32 - Show Cluster

3.1.32.1 - 1.0

scpcli mariadb cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
audit_enabledAudit usage state
backup_optionBackup setting option
database_character_setDatabase encoding
database_nameDatabase Name
database_portDatabase service port
database_user_nameDatabase User Name
origin_regionOrigin Region

3.1.33 - Show Request

3.1.33.1 - 1.0

scpcli mariadb request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

3.1.34 - Start Cluster

3.1.34.1 - 1.0

scpcli mariadb cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.35 - Stop Cluster

3.1.35.1 - 1.0

scpcli mariadb cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.36 - Switchover Cluster

3.1.36.1 - 1.0

scpcli mariadb cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.37 - Synchronize Archive Config

3.1.37.1 - 1.0

scpcli mariadb archive config sync
--cluster_id <value>

Description

Synchronize Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

3.1.38 - Synchronize Cluster State

3.1.38.1 - 1.0

scpcli mariadb cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.39 - Synchronize Parameter Values

3.1.39.1 - 1.0

scpcli mariadb parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

3.1.40 - Synchronize Replica State

3.1.40.1 - 1.0

scpcli mariadb replica state sync
--origin_cluster_id <value>

Description

Synchronize Replica State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

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

3.1.41 - Terminate Cluster

3.1.41.1 - 1.0

scpcli mariadb cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

3.1.42 - Unregister Log Export Config

3.1.42.1 - 1.0

scpcli mariadb log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

3.1.43 - Unset Backup

3.1.43.1 - 1.0

scpcli mariadb backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

3.1.44 - Unset Maintenance

3.1.44.1 - 1.0

scpcli mariadb maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

4 - Microsoft SQL Server(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Microsoft SQL Server(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until

4.1 - CLIs

4.1.1 - Add Block Storages

4.1.1.1 - 1.0

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

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole type-
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

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

Description

Add Secondary.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

Add/Remove Databases.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "", "server_type_name": ""}'
dbaas_engine_version_id
required
stringDBaaS engine version ID-
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 hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

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

4.1.5 - Create Restore Cluster

4.1.5.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

Responses

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

4.1.6 - Export Log

4.1.6.1 - 1.0

scpcli sqlserver log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

4.1.9 - List Engine Version Properties

4.1.9.1 - 1.0

scpcli sqlserver engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

List Log Export Configs.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver parameter value list
--cluster_id <value>

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>

Description

Patch Minor Version.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver audit log set
--cluster_id <value>
--use_audit_log <value>

Description

Set Audit Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

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

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
audit_enabledAudit usage state
backup_optionBackup setting option
database_collation
database_portDatabase service port
database_service_nameDatabase Service Name
database_user_nameDatabase User Name
databasesDatabases

4.1.29 - Show Request

4.1.29.1 - 1.0

scpcli sqlserver request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

4.1.36 - Unregister Log Export Config

4.1.36.1 - 1.0

scpcli sqlserver log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

scpcli sqlserver backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

4.1.38 - Unset Maintenance

4.1.38.1 - 1.0

scpcli sqlserver maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

5 - MySQL(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 MySQL(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

5.1 - CLIs

5.1.1 - Add Block Storages

5.1.1.1 - 1.0

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

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole type-
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.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_name
required
stringDatabase Name-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}'
dbaas_engine_version_id
required
stringDBaaS engine version ID-
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 hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

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

5.1.3 - Create Replica

5.1.3.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
replicas
required
arrayReplicas list'{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "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 hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

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

5.1.4 - Create Restore Cluster

5.1.4.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

Responses

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

5.1.5 - Export Log

5.1.5.1 - 1.0

scpcli mysql log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

5.1.6 - List Backup Histories

5.1.6.1 - 1.0

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

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

5.1.7 - List Clusters

5.1.7.1 - 1.0

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

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

5.1.8 - List Engine Version Properties

5.1.8.1 - 1.0

scpcli mysql engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

5.1.9 - List Engine Versions

5.1.9.1 - 1.0

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

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

5.1.10 - List Log Export Configs

5.1.10.1 - 1.0

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

Description

List Log Export Configs.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

5.1.11 - List Parameter Groups

5.1.11.1 - 1.0

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

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

5.1.12 - List Parameter Values

5.1.12.1 - 1.0

scpcli mysql parameter value list
--cluster_id <value>

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

5.1.13 - List Parameters

5.1.13.1 - 1.0

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

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

5.1.14 - List Replicas

5.1.14.1 - 1.0

scpcli mysql replica list
--cluster_id <value>

Description

List Replicas.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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 - List Server Types

5.1.15.1 - 1.0

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

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

5.1.16 - Patch Minor Version

5.1.16.1 - 1.0

scpcli mysql minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>

Description

Patch Minor Version.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

5.1.17 - Promote Replica Cluster

5.1.17.1 - 1.0

scpcli mysql replica cluster promote
--cluster_id <value>

Description

Promote Replica Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.18 - Register Log Export Config

5.1.18.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

5.1.19 - Remove Backup Histories

5.1.19.1 - 1.0

scpcli mysql backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

5.1.20 - Reset Replica

5.1.20.1 - 1.0

scpcli mysql replica reset
--replica_cluster_id <value>

Description

Reset Replica.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

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

5.1.21 - Restart Cluster

5.1.21.1 - 1.0

scpcli mysql cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.22 - Set Archive Config

5.1.22.1 - 1.0

scpcli mysql archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]

Description

Set Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

5.1.23 - Set Backup

5.1.23.1 - 1.0

scpcli mysql backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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)-
archive_frequency_minute
required
stringBackup starting time (minute)-

Responses

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

5.1.24 - Set Block Storage Size

5.1.24.1 - 1.0

scpcli mysql block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

5.1.25 - Set Log Export Config

5.1.25.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

5.1.26 - Set Maintenance

5.1.26.1 - 1.0

scpcli mysql maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

5.1.27 - Set Parameter Values

5.1.27.1 - 1.0

scpcli mysql parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

5.1.28 - Set Security Group Rules

5.1.28.1 - 1.0

scpcli mysql security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

5.1.29 - Set Server Type

5.1.29.1 - 1.0

scpcli mysql server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

5.1.30 - Show Archive Config

5.1.30.1 - 1.0

scpcli mysql archive config show
--cluster_id <value>

Description

Show Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

5.1.31 - Show Cluster

5.1.31.1 - 1.0

scpcli mysql cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
backup_optionBackup setting option
database_character_setDatabase encoding
database_nameDatabase Name
database_portDatabase service port
database_user_nameDatabase User Name
origin_regionOrigin Region

5.1.32 - Show Request

5.1.32.1 - 1.0

scpcli mysql request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

5.1.33 - Start Cluster

5.1.33.1 - 1.0

scpcli mysql cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.34 - Stop Cluster

5.1.34.1 - 1.0

scpcli mysql cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.35 - Switchover Cluster

5.1.35.1 - 1.0

scpcli mysql cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.36 - Synchronize Archive Config

5.1.36.1 - 1.0

scpcli mysql archive config sync
--cluster_id <value>

Description

Synchronize Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

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

5.1.37 - Synchronize Cluster State

5.1.37.1 - 1.0

scpcli mysql cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.38 - Synchronize Parameter Values

5.1.38.1 - 1.0

scpcli mysql parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

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

5.1.39 - Synchronize Replica State

5.1.39.1 - 1.0

scpcli mysql replica state sync
--origin_cluster_id <value>

Description

Synchronize Replica State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

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

5.1.40 - Terminate Cluster

5.1.40.1 - 1.0

scpcli mysql cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

5.1.41 - Unregister Log Export Config

5.1.41.1 - 1.0

scpcli mysql log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

5.1.42 - Unset Backup

5.1.42.1 - 1.0

scpcli mysql backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

5.1.43 - Unset Maintenance

5.1.43.1 - 1.0

scpcli mysql maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

6 - PostgreSQL(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 PostgreSQL(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

6.1 - CLIs

6.1.1 - Add Block Storages

6.1.1.1 - 1.0

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

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole type-
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.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_name
required
stringDatabase Name-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}'
dbaas_engine_version_id
required
stringDBaaS engine version ID-
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 hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

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

6.1.3 - Create Other region Replica

6.1.3.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
subnet_id
required
stringSubnet ID-
replicas
required
arrayReplicas list'{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "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 hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

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

6.1.4 - Create Replica

6.1.4.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
replicas
required
arrayReplicas list'{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "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 hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

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

6.1.5 - Create Restore Cluster

6.1.5.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

Responses

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

6.1.6 - Delete Archive Log

6.1.6.1 - 1.0

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

Description

Delete Archive Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
stringArchive log typeALL

6.1.7 - Export Log

6.1.7.1 - 1.0

scpcli postgresql log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

6.1.8 - List Backup Histories

6.1.8.1 - 1.0

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

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

6.1.9 - List Clusters

6.1.9.1 - 1.0

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

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

6.1.10 - List Engine Version Properties

6.1.10.1 - 1.0

scpcli postgresql engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

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

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

6.1.12 - List Log Export Configs

6.1.12.1 - 1.0

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

Description

List Log Export Configs.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

6.1.13 - List Parameter Groups

6.1.13.1 - 1.0

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

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

6.1.14 - List Parameter Values

6.1.14.1 - 1.0

scpcli postgresql parameter value list
--cluster_id <value>

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

6.1.15 - List Parameters

6.1.15.1 - 1.0

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

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

6.1.16 - List Replicas

6.1.16.1 - 1.0

scpcli postgresql replica list
--cluster_id <value>

Description

List Replicas.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

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

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

6.1.18 - Patch Minor Version

6.1.18.1 - 1.0

scpcli postgresql minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>

Description

Patch Minor Version.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

scpcli postgresql replica cluster promote
--cluster_id <value>

Description

Promote Replica Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

6.1.21 - Remove Backup Histories

6.1.21.1 - 1.0

scpcli postgresql backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

6.1.22 - Reset Replica

6.1.22.1 - 1.0

scpcli postgresql replica reset
--replica_cluster_id <value>

Description

Reset Replica.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

scpcli postgresql cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

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

Description

Set Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

scpcli postgresql audit log set
--cluster_id <value>
--use_audit_log <value>

Description

Set Audit Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
use_audit_log
required
booleanuse_audit_log-

6.1.26 - Set Backup

6.1.26.1 - 1.0

scpcli postgresql backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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)-
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.0

scpcli postgresql block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

6.1.28 - Set Log Export Config

6.1.28.1 - 1.0

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

6.1.29 - Set Maintenance

6.1.29.1 - 1.0

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

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

6.1.30 - Set Parameter Values

6.1.30.1 - 1.0

scpcli postgresql parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

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

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

6.1.32 - Set Server Type

6.1.32.1 - 1.0

scpcli postgresql server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

6.1.33 - Show Archive Config

6.1.33.1 - 1.0

scpcli postgresql archive config show
--cluster_id <value>

Description

Show Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

scpcli postgresql cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID
block_storage_groupsBlock storage groups list
instancesInstances list
role_typeRole type
server_type_nameServer type name

6.1.35 - Show Request

6.1.35.1 - 1.0

scpcli postgresql request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

6.1.36 - Start Cluster

6.1.36.1 - 1.0

scpcli postgresql cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

scpcli postgresql cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

scpcli postgresql cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

scpcli postgresql archive config sync
--cluster_id <value>

Description

Synchronize Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

scpcli postgresql cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

scpcli postgresql parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

scpcli postgresql replica state sync
--origin_cluster_id <value>

Description

Synchronize Replica State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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

scpcli postgresql cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.1.44 - Unregister Log Export Config

6.1.44.1 - 1.0

scpcli postgresql log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

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

6.1.45 - Unset Backup

6.1.45.1 - 1.0

scpcli postgresql backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.1.46 - Unset Maintenance

6.1.46.1 - 1.0

scpcli postgresql maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-