CacheStore(DBaaS)

Overview

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

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

Version

VersionStatusSupported Until
1.0CURRENT-

1 - CLIs

1.1 - Create Cluster

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.2 - Create Restore Cluster

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.3 - List Backup Histories

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.4 - List Clusters

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.5 - List Commands

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.6 - List Engine Version Properties

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.7 - List Engine Versions

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.8 - List Parameter Groups

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.9 - List Parameter Values

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.10 - List Parameters

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

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.12 - Remove Backup Histories

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.13 - Restart Cluster

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.14 - Set Backup

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.15 - Set Block Storage Size

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.16 - Set Maintenance

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.17 - Set Parameter Values

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.18 - Set Security Group Rules

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.19 - Set Server Type

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.20 - Show Cluster

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.21 - Show Request

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.22 - Start Cluster

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.23 - Stop Cluster

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.24 - Switchover Cluster

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.25 - Synchronize Cluster State

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.26 - Synchronize Commands

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.27 - Synchronize Parameter Values

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.28 - Terminate Cluster

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.29 - Unset Backup

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.30 - Unset Maintenance

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.31 - Update Commands

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": ""}'