scp-cli cachestore cluster create
--database_user_password <value>
--timezone <value>
--subnet_id <value>
--service_watch_log_collection <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--ha_enabled <value>]
[--nat_enabled <value>]
[--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.1	-

Parameters

Name	Type	Description	Example
database_user_password required	string	Database user password	`test123!`
timezone required	string	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint.	`Asia/Seoul`
subnet_id required	string	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.	`1ddd7f1e4a8a43ed8b82d70cade0b321`
service_watch_log_collection required	boolean	ServiceWatch log collection	`True`
name required	string	Cluster name	`mycluster`
instance_name_prefix required	string	Instance name prefix	`myprefix`
instance_groups required	array	Instance groups list	`'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}, {"role_type": "DATA", "size_gb": 56, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "MASTER", "service_ip_address": "192.168.10.10/32"}], "role_type": "MASTER", "server_type_name": "redis1v2m4"}'`
dbaas_engine_version_id required	string	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint.	`c1b856dd12754c0ba2614a39d0ed3ad1`
allowable_ip_addresses optional	array	Allowed IP addresses list	-
ha_enabled optional	boolean	HA availability	-
nat_enabled optional	boolean	NAT availability	-
replica_count optional	integer	Replica count	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
database_port optional	integer	Database service port	-
sentinel_port optional	integer	Sentinel port	-
retention_period_day optional	string	Backup retention period (day)	`7`
starting_time_hour optional	string	Backup starting time (hour)	`2`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

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

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

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
database_user_password required	string	Database user password	`test123!`
timezone required	string	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint.	`Asia/Seoul`
subnet_id required	string	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.	`1ddd7f1e4a8a43ed8b82d70cade0b321`
name required	string	Cluster name	`mycluster`
instance_name_prefix required	string	Instance name prefix	`myprefix`
instance_groups required	array	Instance groups list	`'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}, {"role_type": "DATA", "size_gb": 56, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "MASTER", "service_ip_address": "192.168.10.10/32"}], "role_type": "MASTER", "server_type_name": "redis1v2m4"}'`
dbaas_engine_version_id required	string	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint.	`c1b856dd12754c0ba2614a39d0ed3ad1`
allowable_ip_addresses optional	array	Allowed IP addresses list	-
ha_enabled optional	boolean	HA availability	-
nat_enabled optional	boolean	NAT availability	-
replica_count optional	integer	Replica count	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
database_port optional	integer	Database service port	-
sentinel_port optional	integer	Sentinel port	-
retention_period_day optional	string	Backup retention period (day)	`7`
starting_time_hour optional	string	Backup starting time (hour)	`2`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

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

2 - Create Restore Cluster

2.1 - 1.1

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.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

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

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

Responses

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

3 - List Backup Histories

3.1 - 1.1

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

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

3.2 - 1.0

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

Description

List Backup Histories.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

Responses

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

4 - List Clusters

4.1 - 1.1

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

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
ha_enabled	HA availability
instance_count	Instance Count
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster name
role_type	Role type
service_state	Service state

4.2 - 1.0

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

Description

List Clusters.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
ha_enabled	HA availability
instance_count	Instance Count
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster name
role_type	Role type
service_state	Service state

5 - List Commands

5.1 - 1.1

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

Description

List Commands.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
id
applied_value
description
modifiable
name

5.2 - 1.0

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

Description

List Commands.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
id
applied_value
description
modifiable
name

6 - List Engine Version Properties

6.1 - 1.1

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

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

6.2 - 1.0

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

Description

List Engine Version Properties.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

Responses

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

7 - List Engine Versions

7.1 - 1.1

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

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

7.2 - 1.0

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

Description

List Engine Versions.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

Responses

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

8 - List Parameter Groups

8.1 - 1.1

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

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

8.2 - 1.0

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

Description

List Parameter Groups.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

Responses

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

9 - List Parameter Values

9.1 - 1.1

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

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

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

9.2 - 1.0

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

Description

List Parameter Values.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

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

10 - List Parameters

10.1 - 1.1

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

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

10.2 - 1.0

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

Description

List Parameters.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

Responses

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

11 - List Server Types

11.1 - 1.1

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

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

11.2 - 1.0

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

Description

List Server Types.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

Responses

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

12 - Patch Minor Version

12.1 - 1.1

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

Description

Patch Minor Version.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

12.2 - 1.0

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

Description

Patch Minor Version.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

13 - Remove Backup Histories

13.1 - 1.1

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

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

13.2 - 1.0

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

Description

Remove Backup Histories.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

14 - Restart Cluster

14.1 - 1.1

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

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`mycluster`

Responses

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

14.2 - 1.0

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

Description

Restart Cluster.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`mycluster`

Responses

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

15 - Set Backup

15.1 - 1.1

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

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

15.2 - 1.0

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

Description

Set Backup.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

Responses

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

16 - Set Block Storage Size

16.1 - 1.1

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

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

16.2 - 1.0

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

Description

Set Block Storage Size.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

Responses

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

17 - Set Maintenance

17.1 - 1.1

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.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

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

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

Responses

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

18 - Set Parameter Values

18.1 - 1.1

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

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

18.2 - 1.0

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

Description

Set Parameter Values.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

19 - Set Security Group Rules

19.1 - 1.1

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

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

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

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

Responses

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

20 - Set Server Type

20.1 - 1.1

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

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

20.2 - 1.0

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

Description

Set Server Type.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

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

Responses

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

21 - Show Cluster

21.1 - 1.1

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

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`mycluster`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID
allowable_ip_addresses	Allowed IP addresses list	[]
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engine	DBaaS engine
dbaas_engine_version_name	DBaaS engine version name
ha_enabled	HA availability
init_config_option		{}
instance_count	Instance Count
instance_groups		[]
maintenance_option	Maintenance option	{}
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster name
nat_enabled	NAT availability
product_image_type	Product image type
product_type	Product type
role_type	Role type	{}
service_state	Service state
service_watch_log_collection	ServiceWatch log collection
software_version	Software version
subnet_id	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.
timezone	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint.

21.2 - 1.0

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

Description

Show Cluster.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`mycluster`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID
allowable_ip_addresses	Allowed IP addresses list	[]
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engine	DBaaS engine
dbaas_engine_version_name	DBaaS engine version name
ha_enabled	HA availability
init_config_option		{}
instance_count	Instance Count
instance_groups		[]
maintenance_option	Maintenance option	{}
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster name
nat_enabled	NAT availability
product_image_type	Product image type
product_type	Product type
role_type	Role type	{}
service_state	Service state
software_version	Software version
subnet_id	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.
timezone	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint.

22 - Show Instance

22.1 - 1.1

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

Description

Show Instance.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

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

23 - Show Request

23.1 - 1.1

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

Description

Show Request.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
request_id required	string	Request ID	-

Responses

Name	Description	Example
request_id	Request ID
state	Request state

23.2 - 1.0

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

Description

Show Request.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
request_id required	string	Request ID	-

Responses

Name	Description	Example
request_id	Request ID
state	Request state

24 - Start Cluster

24.1 - 1.1

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

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`mycluster`

Responses

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

24.2 - 1.0

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

Description

Start Cluster.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`mycluster`

Responses

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

25 - Stop Cluster

25.1 - 1.1

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

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`mycluster`

Responses

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

25.2 - 1.0

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

Description

Stop Cluster.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`mycluster`

Responses

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

26 - Switchover Cluster

26.1 - 1.1

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

Description

Switchover Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`mycluster`
switch_host_name required	string	Switch over target	-

Responses

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

26.2 - 1.0

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

Description

Switchover Cluster.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`mycluster`
switch_host_name required	string	Switch over target	-

Responses

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

27 - Synchronize Cluster State

27.1 - 1.1

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

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`mycluster`

Responses

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

27.2 - 1.0

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

Description

Synchronize Cluster State.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`mycluster`

Responses

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

28 - Synchronize Commands

28.1 - 1.1

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

Description

Synchronize Commands.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

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

28.2 - 1.0

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

Description

Synchronize Commands.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

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

29 - Synchronize Parameter Values

29.1 - 1.1

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

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

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

29.2 - 1.0

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

Description

Synchronize Parameter Values.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

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

30 - Terminate Cluster

30.1 - 1.1

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

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`mycluster`

30.2 - 1.0

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

Description

Terminate Cluster.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`mycluster`

31 - Unset Backup

31.1 - 1.1

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

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

31.2 - 1.0

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

Description

Unset Backup.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

32 - Unset Maintenance

32.1 - 1.1

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

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	DB cluster id	-

32.2 - 1.0

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

Description

Unset Maintenance.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	DB cluster id	-

33 - Update Commands

33.1 - 1.1

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

Description

Update Commands.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
commands required	array	Apply command information	`'{"id": "", "name": "", "new_value": ""}'`

33.2 - 1.0

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

Description

Update Commands.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
commands required	array	Apply command information	`'{"id": "", "name": "", "new_value": ""}'`