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

Return to the regular view of this page.

CacheStore(DBaaS)

Overview

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

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

Version

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

VersionStatusNot Before
1.0CURRENT-

CLI Version History

1.0

Initial CLI release for CacheStore(DBaaS)

Changes

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

1 - CLIs

1.1 - Create Cluster

1.1.1 - 1.0

scp-cli cachestore cluster create
--database_user_password <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--ha_enabled <value>]
[--nat_enabled <value>]
[--replica_count <value>]
[--tags <value>]
[--database_port <value>]
[--sentinel_port <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.2 - Create Restore Cluster

1.2.1 - 1.0

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

Description

Create Restore Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.3 - List Backup Histories

1.3.1 - 1.0

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

Description

List Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.4 - List Clusters

1.4.1 - 1.0

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

Description

List Clusters.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.5 - List Commands

1.5.1 - 1.0

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

Description

List Commands.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

NameDescriptionExample
id
applied_value
description
modifiable
name

1.6 - List Engine Version Properties

1.6.1 - 1.0

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

Description

List Engine Version Properties.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required		stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

1.7 - List Engine Versions

1.7.1 - 1.0

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

Description

List Engine Versions.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.8 - List Parameter Groups

1.8.1 - 1.0

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

Description

List Parameter Groups.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.9 - List Parameter Values

1.9.1 - 1.0

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

Description

List Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.10 - List Parameters

1.10.1 - 1.0

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

Description

List Parameters.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.11 - List Server Types

1.11.1 - 1.0

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

Description

List Server Types.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.12 - Patch Minor Version

1.12.1 - 1.0

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

Description

Patch Minor Version.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

1.13 - Remove Backup Histories

1.13.1 - 1.0

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

Description

Remove Backup Histories.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-
backup_history_number
required		arrayBackup id-

1.14 - Restart Cluster

1.14.1 - 1.0

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

Description

Restart Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster IDmycluster

Responses

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

1.15 - Set Backup

1.15.1 - 1.0

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

Description

Set Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.16 - Set Block Storage Size

1.16.1 - 1.0

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

Description

Set Block Storage Size.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.17 - Set Maintenance

1.17.1 - 1.0

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

Description

Set Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.18 - Set Parameter Values

1.18.1 - 1.0

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

Description

Set Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

1.19 - Set Security Group Rules

1.19.1 - 1.0

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

Description

Set Security Group Rules.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.20 - Set Server Type

1.20.1 - 1.0

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

Description

Set Server Type.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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

Responses

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

1.21 - Show Cluster

1.21.1 - 1.0

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

Description

Show Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster IDmycluster

Responses

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

1.22 - Show Request

1.22.1 - 1.0

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

Description

Show Request.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
request_id
required		stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

1.23 - Start Cluster

1.23.1 - 1.0

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

Description

Start Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster IDmycluster

Responses

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

1.24 - Stop Cluster

1.24.1 - 1.0

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

Description

Stop Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster IDmycluster

Responses

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

1.25 - Switchover Cluster

1.25.1 - 1.0

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

Description

Switchover Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster IDmycluster
switch_host_name
required		stringSwitch over target-

Responses

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

1.26 - Synchronize Cluster State

1.26.1 - 1.0

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

Description

Synchronize Cluster State.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster IDmycluster

Responses

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

1.27 - Synchronize Commands

1.27.1 - 1.0

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

Description

Synchronize Commands.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.28 - Synchronize Parameter Values

1.28.1 - 1.0

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

Description

Synchronize Parameter Values.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.29 - Terminate Cluster

1.29.1 - 1.0

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

Description

Terminate Cluster.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster IDmycluster

1.30 - Unset Backup

1.30.1 - 1.0

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

Description

Unset Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

1.31 - Unset Maintenance

1.31.1 - 1.0

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

Description

Unset Maintenance.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringDB cluster id-

1.32 - Update Commands

1.32.1 - 1.0

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

Description

Update Commands.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

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