이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

CLIs

1: Add Block Storages

1.1: 1.1
1.2: 1.0

2: Add Instances

2.1: 1.1
2.2: 1.0

3: Create Cluster

3.1: 1.1
3.2: 1.0

4: Create Restore Cluster

4.1: 1.1
4.2: 1.0

5: List Backup Histories

5.1: 1.1
5.2: 1.0

6: List Clusters

6.1: 1.1
6.2: 1.0

7: List Engine Version Properties

7.1: 1.1
7.2: 1.0

8: List Engine Versions

8.1: 1.1
8.2: 1.0

9: List Server Types

9.1: 1.1
9.2: 1.0

10: Manual Backup

10.1: 1.1

11: Patch Minor Version

11.1: 1.1
11.2: 1.0

12: Remove Backup Histories

12.1: 1.1
12.2: 1.0

13: Restart Cluster

13.1: 1.1
13.2: 1.0

14: Restart Dashboard

14.1: 1.1
14.2: 1.0

15: Set Backup

15.1: 1.1
15.2: 1.0

16: Set Block Storage Size

16.1: 1.1
16.2: 1.0

17: Set Maintenance

17.1: 1.1
17.2: 1.0

18: Set Security Group Rules

18.1: 1.1
18.2: 1.0

19: Set Server Type

19.1: 1.1
19.2: 1.0

20: Show Cluster

20.1: 1.1
20.2: 1.0

21: Show Instance

21.1: 1.1

22: Show Request

22.1: 1.1
22.2: 1.0

23: Start Cluster

23.1: 1.1
23.2: 1.0

24: Stop Cluster

24.1: 1.1
24.2: 1.0

25: Synchronize Cluster State

25.1: 1.1
25.2: 1.0

26: Terminate Cluster

26.1: 1.1
26.2: 1.0

27: Unset Backup

27.1: 1.1
27.2: 1.0

28: Unset Maintenance

28.1: 1.1
28.2: 1.0

1 - Add Block Storages

1.1 - 1.1

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

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
instance_group_id required	string	Instance group ID	-
size_gb required	integer	Size in GB	`104`
role_type required	string	Role type	`OS`
volume_type optional	string	Volume type	-

Responses

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

1.2 - 1.0

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

Description

Add Block Storages.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
instance_group_id required	string	Instance group ID	-
size_gb required	integer	Size in GB	`104`
role_type required	string	Role type	`OS`
volume_type optional	string	Volume type	-

Responses

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

2 - Add Instances

2.1 - 1.1

scp-cli searchengine instance add
--cluster_id <value>
--service_ip_addresses <value>
--instance_count <value>
[--public_ip_ids <value>]

Description

Add Instances.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
service_ip_addresses required	array	User subnet IP address	-
instance_count required	integer	Instance Count	-
public_ip_ids optional	array	Public IP ID List	-

Responses

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

2.2 - 1.0

scp-cli searchengine instance add
--cluster_id <value>
--service_ip_addresses <value>
--instance_count <value>
[--public_ip_ids <value>]

Description

Add Instances.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-
service_ip_addresses required	array	User subnet IP address	-
instance_count required	integer	Instance Count	-
public_ip_ids optional	array	Public IP ID List	-

Responses

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

3 - Create Cluster

3.1 - 1.1

scp-cli searchengine cluster create
--starting_time_hour <value>
--retention_period_day <value>
--database_user_password <value>
--database_user_name <value>
--timezone <value>
--subnet_id <value>
--service_watch_log_collection <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--is_combined <value>]
[--license <value>]
[--nat_enabled <value>]
[--tags <value>]
[--database_port <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
starting_time_hour required	string	Backup starting time (hour)	-
retention_period_day required	string	Backup retention period (day)	-
database_user_password required	string	Database user password	`test123!`
database_user_name required	string	Database User Name	`mydatabaseusr`
timezone required	string	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint.	-
subnet_id required	string	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.	-
service_watch_log_collection required	boolean	ServiceWatch log collection	`True`
name required	string	Cluster name	-
instance_name_prefix required	string	Instance name prefix	-
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": "DATA", "service_ip_address": "192.168.10.10/32"}], "role_type": "DATA", "server_type_name": "ses1v2m4"}'`
dbaas_engine_version_id required	string	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint.	-
allowable_ip_addresses optional	array	Allowed IP addresses list	-
is_combined optional	boolean	Master Data server separation state	-
license optional	string	license	-
nat_enabled optional	boolean	NAT availability	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
database_port optional	integer	Database service port	`2866`
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.2 - 1.0

scp-cli searchengine cluster create
--starting_time_hour <value>
--retention_period_day <value>
--database_user_password <value>
--database_user_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>]
[--is_combined <value>]
[--license <value>]
[--nat_enabled <value>]
[--tags <value>]
[--database_port <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
starting_time_hour required	string	Backup starting time (hour)	-
retention_period_day required	string	Backup retention period (day)	-
database_user_password required	string	Database user password	`test123!`
database_user_name required	string	Database User Name	`mydatabaseusr`
timezone required	string	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint.	-
subnet_id required	string	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint.	-
name required	string	Cluster name	-
instance_name_prefix required	string	Instance name prefix	-
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": "DATA", "service_ip_address": "192.168.10.10/32"}], "role_type": "DATA", "server_type_name": "ses1v2m4"}'`
dbaas_engine_version_id required	string	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint.	-
allowable_ip_addresses optional	array	Allowed IP addresses list	-
is_combined optional	boolean	Master Data server separation state	-
license optional	string	license	-
nat_enabled optional	boolean	NAT availability	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
database_port optional	integer	Database service port	`2866`
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

4 - Create Restore Cluster

4.1 - 1.1

scp-cli searchengine restore create
--cluster_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--backup_history_number <value>
[--allowable_ip_addresses <value>]
[--license <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	-
name required	string	Cluster name	-
instance_name_prefix required	string	Instance name prefix	-
instance_groups required	array	Instance groups list	`'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "role_type": "ACTIVE"}'`
backup_history_number required	string	Backup id	-
allowable_ip_addresses optional	array	Allowed IP addresses list	-
license optional	string	license	-
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

4.2 - 1.0

scp-cli searchengine restore create
--cluster_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--backup_history_number <value>
[--allowable_ip_addresses <value>]
[--license <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	-
name required	string	Cluster name	-
instance_name_prefix required	string	Instance name prefix	-
instance_groups required	array	Instance groups list	`'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "role_type": "ACTIVE"}'`
backup_history_number required	string	Backup id	-
allowable_ip_addresses optional	array	Allowed IP addresses list	-
license optional	string	license	-
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

5 - List Backup Histories

5.1 - 1.1

scp-cli searchengine 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

5.2 - 1.0

scp-cli searchengine 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

6 - List Clusters

6.1 - 1.1

scp-cli searchengine 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

6.2 - 1.0

scp-cli searchengine 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

7 - List Engine Version Properties

7.1 - 1.1

scp-cli searchengine 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

7.2 - 1.0

scp-cli searchengine 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

8 - List Engine Versions

8.1 - 1.1

scp-cli searchengine 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

8.2 - 1.0

scp-cli searchengine 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

9 - List Server Types

9.1 - 1.1

scp-cli searchengine 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

9.2 - 1.0

scp-cli searchengine 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

10 - Manual Backup

10.1 - 1.1

scp-cli searchengine backup manual
--cluster_id <value>

Description

Manual Backup.

상태 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

11 - Patch Minor Version

11.1 - 1.1

scp-cli searchengine 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	-

11.2 - 1.0

scp-cli searchengine 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	-

12 - Remove Backup Histories

12.1 - 1.1

scp-cli searchengine 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	-

12.2 - 1.0

scp-cli searchengine 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	-

13 - Restart Cluster

13.1 - 1.1

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

Description

Restart Cluster.

상태 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

13.2 - 1.0

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

Description

Restart Cluster.

상태 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

14 - Restart Dashboard

14.1 - 1.1

scp-cli searchengine dashboard restart
--cluster_id <value>

Description

Restart Dashboard.

상태 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

14.2 - 1.0

scp-cli searchengine dashboard restart
--cluster_id <value>

Description

Restart Dashboard.

상태 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

15 - Set Backup

15.1 - 1.1

scp-cli searchengine 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 searchengine 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 searchengine 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 searchengine 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 searchengine 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	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 searchengine 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	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 Security Group Rules

18.1 - 1.1

scp-cli searchengine 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

18.2 - 1.0

scp-cli searchengine 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

19 - Set Server Type

19.1 - 1.1

scp-cli searchengine 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

19.2 - 1.0

scp-cli searchengine 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

20 - Show Cluster

20.1 - 1.1

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

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

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
init_config_option	DB initial configuration option
instance_count	Instance Count
instance_groups	Instance groups list	[]
is_combined	Master Data server separation state
license	Maintenance option	{}
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	Search Engine
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.

20.2 - 1.0

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

Description

Show Cluster.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

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
init_config_option	DB initial configuration option
instance_count	Instance Count
instance_groups	Instance groups list	[]
is_combined	Master Data server separation state
license	Maintenance option	{}
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	Search Engine
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.

21 - Show Instance

21.1 - 1.1

scp-cli searchengine 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

22 - Show Request

22.1 - 1.1

scp-cli searchengine 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

22.2 - 1.0

scp-cli searchengine 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

23 - Start Cluster

23.1 - 1.1

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

Description

Start Cluster.

상태 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

23.2 - 1.0

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

Description

Start Cluster.

상태 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

24 - Stop Cluster

24.1 - 1.1

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

Description

Stop Cluster.

상태 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

24.2 - 1.0

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

Description

Stop Cluster.

상태 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

25 - Synchronize Cluster State

25.1 - 1.1

scp-cli searchengine 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	-

Responses

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

25.2 - 1.0

scp-cli searchengine 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	-

Responses

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

26 - Terminate Cluster

26.1 - 1.1

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

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

26.2 - 1.0

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

Description

Terminate Cluster.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

27 - Unset Backup

27.1 - 1.1

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

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

27.2 - 1.0

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

Description

Unset Backup.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

28 - Unset Maintenance

28.1 - 1.1

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

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

28.2 - 1.0

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

Description

Unset Maintenance.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20261031

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-