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

Return to the regular view of this page.

CLIs

1: Add Instances

1.1: 1.1
1.2: 1.0

2: Create Cluster

2.1: 1.1
2.2: 1.0

3: List Clusters

3.1: 1.1
3.2: 1.0

4: List Engine Version Properties

4.1: 1.1
4.2: 1.0

5: List Engine Versions

5.1: 1.1
5.2: 1.0

6: List Parameter Groups

6.1: 1.1
6.2: 1.0

7: List Parameter Values

7.1: 1.1
7.2: 1.0

8: List Parameters

8.1: 1.1
8.2: 1.0

9: List Server Types

9.1: 1.1
9.2: 1.0

10: Patch Minor Version

10.1: 1.1
10.2: 1.0

11: Restart Cluster

11.1: 1.1
11.2: 1.0

12: Set Block Storage Size

12.1: 1.1
12.2: 1.0

13: Set Maintenance

13.1: 1.1
13.2: 1.0

14: Set Parameter Values

14.1: 1.1
14.2: 1.0

15: Set Security Group Rules

15.1: 1.1
15.2: 1.0

16: Set Server Type

16.1: 1.1
16.2: 1.0

17: Show Cluster

17.1: 1.1
17.2: 1.0

18: Show Request

18.1: 1.1
18.2: 1.0

19: Start Cluster

19.1: 1.1
19.2: 1.0

20: Stop Cluster

20.1: 1.1
20.2: 1.0

21: Synchronize Cluster State

21.1: 1.1
21.2: 1.0

22: Synchronize Parameter Values

22.1: 1.1
22.2: 1.0

23: Terminate Cluster

23.1: 1.1
23.2: 1.0

24: Unset Maintenance

24.1: 1.1
24.2: 1.0

1 - Add Instances

1.1 - 1.1

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

Description

Add Instances.

State ACTIVE (CURRENT)

Version	Not Before
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

1.2 - 1.0

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

Description

Add Instances.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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 - Create Cluster

2.1 - 1.1

scpcli eventstreams cluster create
--zookeeper_sasl_password <value>
--zookeeper_sasl_id <value>
--broker_sasl_password <value>
--broker_sasl_id <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>
[--akhq_enabled <value>]
[--allowable_ip_addresses <value>]
[--is_combined <value>]
[--nat_enabled <value>]
[--tags <value>]
[--akhq_id <value>]
[--akhq_password <value>]
[--broker_port <value>]
[--zookeeper_port <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
zookeeper_sasl_password required	string	zookeeper sasl password	-
zookeeper_sasl_id required	string	zookeeper sasl id	-
broker_sasl_password required	string	broker sasl password	-
broker_sasl_id required	string	broker sasl id	-
timezone required	string	Timezone	-
subnet_id required	string	Subnet ID	-
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": "", "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	-
akhq_enabled optional	boolean	AKHQ availability	-
allowable_ip_addresses optional	array	Allowed IP addresses list	-
is_combined optional	boolean	HA availability	-
nat_enabled optional	boolean	NAT availability	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
akhq_id optional	string	akhq id	-
akhq_password optional	string	akhq password	-
broker_port optional	integer	broker port	-
zookeeper_port optional	integer	zookeeper 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

2.2 - 1.0

scpcli eventstreams cluster create
--zookeeper_sasl_password <value>
--zookeeper_sasl_id <value>
--broker_sasl_password <value>
--broker_sasl_id <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--akhq_enabled <value>]
[--allowable_ip_addresses <value>]
[--is_combined <value>]
[--nat_enabled <value>]
[--tags <value>]
[--akhq_id <value>]
[--akhq_password <value>]
[--broker_port <value>]
[--zookeeper_port <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
zookeeper_sasl_password required	string	zookeeper sasl password	-
zookeeper_sasl_id required	string	zookeeper sasl id	-
broker_sasl_password required	string	broker sasl password	-
broker_sasl_id required	string	broker sasl id	-
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	-
akhq_enabled optional	boolean	AKHQ availability	-
allowable_ip_addresses optional	array	Allowed IP addresses list	-
is_combined optional	boolean	HA availability	-
nat_enabled optional	boolean	NAT availability	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
akhq_id optional	string	akhq id	-
akhq_password optional	string	akhq password	-
broker_port optional	integer	broker port	-
zookeeper_port optional	integer	zookeeper 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

3 - List Clusters

3.1 - 1.1

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

Description

List Clusters.

State ACTIVE (CURRENT)

Version	Not Before
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	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

3.2 - 1.0

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

Description

List Clusters.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

4 - List Engine Version Properties

4.1 - 1.1

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

Description

List Engine Version Properties.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

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

4.2 - 1.0

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

Description

List Engine Version Properties.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

5 - List Engine Versions

5.1 - 1.1

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

Description

List Engine Versions.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

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

5.2 - 1.0

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

Description

List Engine Versions.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

6 - List Parameter Groups

6.1 - 1.1

scpcli eventstreams parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]

Description

List Parameter Groups.

State ACTIVE (CURRENT)

Version	Not Before
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

6.2 - 1.0

scpcli eventstreams parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]

Description

List Parameter Groups.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

7 - List Parameter Values

7.1 - 1.1

scpcli eventstreams parameter value list
--cluster_id <value>

Description

List Parameter Values.

State ACTIVE (CURRENT)

Version	Not Before
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

7.2 - 1.0

scpcli eventstreams parameter value list
--cluster_id <value>

Description

List Parameter Values.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

8 - List Parameters

8.1 - 1.1

scpcli eventstreams parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List Parameters.

State ACTIVE (CURRENT)

Version	Not Before
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

8.2 - 1.0

scpcli eventstreams parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List Parameters.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

9 - List Server Types

9.1 - 1.1

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

Description

List Server Types.

State ACTIVE (CURRENT)

Version	Not Before
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

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

Description

List Server Types.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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 - Patch Minor Version

10.1 - 1.1

scpcli eventstreams minor version patch
--cluster_id <value>
--software_version <value>
--dbaas_engine <value>

Description

Patch Minor Version.

State ACTIVE (CURRENT)

Version	Not Before
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	-

10.2 - 1.0

scpcli eventstreams minor version patch
--cluster_id <value>
--software_version <value>
--dbaas_engine <value>

Description

Patch Minor Version.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

11.1 - 1.1

scpcli eventstreams cluster restart
--cluster_id <value>

Description

Restart Cluster.

State ACTIVE (CURRENT)

Version	Not Before
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.2 - 1.0

scpcli eventstreams cluster restart
--cluster_id <value>

Description

Restart Cluster.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

12 - Set Block Storage Size

12.1 - 1.1

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

Description

Set Block Storage Size.

State ACTIVE (CURRENT)

Version	Not Before
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

12.2 - 1.0

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

Description

Set Block Storage Size.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

13 - Set Maintenance

13.1 - 1.1

scpcli eventstreams 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	Not Before
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

13.2 - 1.0

scpcli eventstreams maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

14 - Set Parameter Values

14.1 - 1.1

scpcli eventstreams parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

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

14.2 - 1.0

scpcli eventstreams parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

Parameters

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

15 - Set Security Group Rules

15.1 - 1.1

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

Description

Set Security Group Rules.

State ACTIVE (CURRENT)

Version	Not Before
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

15.2 - 1.0

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

Description

Set Security Group Rules.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

16 - Set Server Type

16.1 - 1.1

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

Description

Set Server Type.

State ACTIVE (CURRENT)

Version	Not Before
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

16.2 - 1.0

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

Description

Set Server Type.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

17 - Show Cluster

17.1 - 1.1

scpcli eventstreams cluster show
--cluster_id <value>

Description

Show Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

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

17.2 - 1.0

scpcli eventstreams cluster show
--cluster_id <value>

Description

Show Cluster.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

18 - Show Request

18.1 - 1.1

scpcli eventstreams request show
--request_id <value>

Description

Show Request.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
request_id required	string	Request ID	-

Responses

Name	Description	Example
request_id	Request ID
state	Request state

18.2 - 1.0

scpcli eventstreams request show
--request_id <value>

Description

Show Request.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
request_id required	string	Request ID	-

Responses

Name	Description	Example
request_id	Request ID
state	Request state

19 - Start Cluster

19.1 - 1.1

scpcli eventstreams cluster start
--cluster_id <value>

Description

Start Cluster.

State ACTIVE (CURRENT)

Version	Not Before
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

19.2 - 1.0

scpcli eventstreams cluster start
--cluster_id <value>

Description

Start Cluster.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

20 - Stop Cluster

20.1 - 1.1

scpcli eventstreams cluster stop
--cluster_id <value>

Description

Stop Cluster.

State ACTIVE (CURRENT)

Version	Not Before
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

20.2 - 1.0

scpcli eventstreams cluster stop
--cluster_id <value>

Description

Stop Cluster.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

21 - Synchronize Cluster State

21.1 - 1.1

scpcli eventstreams cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

State ACTIVE (CURRENT)

Version	Not Before
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

21.2 - 1.0

scpcli eventstreams cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

22 - Synchronize Parameter Values

22.1 - 1.1

scpcli eventstreams parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

State ACTIVE (CURRENT)

Version	Not Before
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

22.2 - 1.0

scpcli eventstreams parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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

23.1 - 1.1

scpcli eventstreams cluster delete
--cluster_id <value>

Description

Terminate Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

23.2 - 1.0

scpcli eventstreams cluster delete
--cluster_id <value>

Description

Terminate Cluster.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

24 - Unset Maintenance

24.1 - 1.1

scpcli eventstreams maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-

24.2 - 1.0

scpcli eventstreams maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	-