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

Return to the regular view of this page.

Search Engine

1: CLIs

1.1: Add Block Storages

1.1.1: 1.0

1.2: Add Instances

1.2.1: 1.0

1.3: Create Cluster

1.3.1: 1.0

1.4: Create Restore Cluster

1.4.1: 1.0

1.5: List Backup Histories

1.5.1: 1.0

1.6: List Clusters

1.6.1: 1.0

1.7: List Engine Version Properties

1.7.1: 1.0

1.8: List Engine Versions

1.8.1: 1.0

1.9: List Server Types

1.9.1: 1.0

1.10: Remove Backup Histories

1.10.1: 1.0

1.11: Restart Cluster

1.11.1: 1.0

1.12: Set Backup

1.12.1: 1.0

1.13: Set Block Storage Size

1.13.1: 1.0

1.14: Set Maintenance

1.14.1: 1.0

1.15: Set Security Group Rules

1.15.1: 1.0

1.16: Set Server Type

1.16.1: 1.0

1.17: Show Cluster

1.17.1: 1.0

1.18: Show Request

1.18.1: 1.0

1.19: Start Cluster

1.19.1: 1.0

1.20: Stop Cluster

1.20.1: 1.0

1.21: Synchronize Cluster State

1.21.1: 1.0

1.22: Terminate Cluster

1.22.1: 1.0

1.23: Unset Backup

1.23.1: 1.0

1.24: Unset Maintenance

1.24.1: 1.0

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 Search Engine service and how to call CLI.

Version

Version	Status	Supported Until
1.0	CURRENT	-

1 - CLIs

1.1 - Add Block Storages

1.1.1 - 1.0

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

Description

Add Block Storages.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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	-
volume_type optional	string	Volume type	-

Responses

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

1.2 - Add Instances

1.2.1 - 1.0

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

Description

Add Instances.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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

1.3 - Create Cluster

1.3.1 - 1.0

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

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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	-
database_user_name required	string	Database User Name	-
timezone required	string	Timezone	-
subnet_id required	string	Subnet 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": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}'`
dbaas_engine_version_id required	string	DBaaS engine version ID	-
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	-
period_hour optional	string	Period in hours	-
starting_day_of_week optional	string	Starting day of week	-
starting_time optional	string	Starting time	-

Responses

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

1.4 - Create Restore Cluster

1.4.1 - 1.0

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

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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": "", "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	-
starting_day_of_week optional	string	Starting day of week	-
starting_time optional	string	Starting time	-

Responses

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

1.5 - List Backup Histories

1.5.1 - 1.0

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

Description

List Backup Histories.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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

1.6 - List Clusters

1.6.1 - 1.0

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

Description

List Clusters.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
ha_enabled	HA availability
instance_count	Instance Count
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster name
role_type	Role type
service_state	Service state

1.7 - List Engine Version Properties

1.7.1 - 1.0

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

Description

List Engine Version Properties.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
dbaas_engine_version_id required	string	DBaaS engine version ID	-

Responses

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

1.8 - List Engine Versions

1.8.1 - 1.0

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

Description

List Engine Versions.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
id optional	string	DBaaS engine version ID	-
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

1.9 - List Server Types

1.9.1 - 1.0

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

Description

List Server Types.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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

1.10 - Remove Backup Histories

1.10.1 - 1.0

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

Description

Remove Backup Histories.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

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

1.11 - Restart Cluster

1.11.1 - 1.0

scpcli searchengine cluster restart
--cluster_id <value>

Description

Restart Cluster.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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

1.12 - Set Backup

1.12.1 - 1.0

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

Description

Set Backup.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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

1.13 - Set Block Storage Size

1.13.1 - 1.0

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

Description

Set Block Storage Size.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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

1.14 - Set Maintenance

1.14.1 - 1.0

scpcli searchengine 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)

Version	Supported Until
1.0	-

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

1.15 - Set Security Group Rules

1.15.1 - 1.0

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

Description

Set Security Group Rules.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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

1.16 - Set Server Type

1.16.1 - 1.0

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

Description

Set Server Type.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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

1.17 - Show Cluster

1.17.1 - 1.0

scpcli searchengine cluster show
--cluster_id <value>

Description

Show Cluster.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

Responses

Name	Description	Example
id	ID
block_storage_groups	Block storage groups list
instances	Instances list
role_type	Role type
server_type_name	Server type name

1.18 - Show Request

1.18.1 - 1.0

scpcli searchengine request show
--request_id <value>

Description

Show Request.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
request_id required	string	Request ID	-

Responses

Name	Description	Example
request_id	Request ID
state	Request state

1.19 - Start Cluster

1.19.1 - 1.0

scpcli searchengine cluster start
--cluster_id <value>

Description

Start Cluster.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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

1.20 - Stop Cluster

1.20.1 - 1.0

scpcli searchengine cluster stop
--cluster_id <value>

Description

Stop Cluster.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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

1.21 - Synchronize Cluster State

1.21.1 - 1.0

scpcli searchengine cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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

1.22 - Terminate Cluster

1.22.1 - 1.0

scpcli searchengine cluster delete
--cluster_id <value>

Description

Terminate Cluster.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

1.23 - Unset Backup

1.23.1 - 1.0

scpcli searchengine backup unset
--cluster_id <value>

Description

Unset Backup.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

1.24 - Unset Maintenance

1.24.1 - 1.0

scpcli searchengine maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-