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

이 페이지의 일반 화면으로 돌아가기.

Event Streams

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Event Streams 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20260531

CLI Version History

1.1

Event Streams CLI 버전 1.1이 출시되었습니다.

변경사항

  • [변경] eventstreams create cluster - 명령어가 변경되었습니다.
    • 요청 모델이 EventStreamsClusterCreateRequestV1Dot1 로 변경되었습니다.
    • 요청 시, 아래와 같은 필드가 추가됩니다.:
      • service_watch_log_collection
  • [변경] eventstreams show cluster - 명령어가 변경되었습니다.
    • 응답 모델이 EventStreamsClusterDetailResponseV1Dot1 로 변경되었습니다.
    • 응답 시, 아래와 같은 필드가 추가됩니다.:
      • service_watch_log_collection
  • [신규] eventstreams patch minor version - 명령어가 추가되었습니다.

1.0

Event Streams CLI가 출시되었습니다.

변경사항

  • [신규] eventstreams add instances - 명령어가 추가되었습니다.
  • [신규] eventstreams create cluster - 명령어가 추가되었습니다.
  • [신규] eventstreams delete cluster - 명령어가 추가되었습니다.
  • [신규] eventstreams list clusters - 명령어가 추가되었습니다.
  • [신규] eventstreams list engine version properties - 명령어가 추가되었습니다.
  • [신규] eventstreams list engine versions - 명령어가 추가되었습니다.
  • [신규] eventstreams list parameter groups - 명령어가 추가되었습니다.
  • [신규] eventstreams list parameter values - 명령어가 추가되었습니다.
  • [신규] eventstreams list parameters - 명령어가 추가되었습니다.
  • [신규] eventstreams list server types - 명령어가 추가되었습니다.
  • [신규] eventstreams restart cluster - 명령어가 추가되었습니다.
  • [신규] eventstreams set block storage size - 명령어가 추가되었습니다.
  • [신규] eventstreams set maintenance - 명령어가 추가되었습니다.
  • [신규] eventstreams set parameter values - 명령어가 추가되었습니다.
  • [신규] eventstreams set security group rules - 명령어가 추가되었습니다.
  • [신규] eventstreams set server type - 명령어가 추가되었습니다.
  • [신규] eventstreams show cluster - 명령어가 추가되었습니다.
  • [신규] eventstreams show request - 명령어가 추가되었습니다.
  • [신규] eventstreams start cluster - 명령어가 추가되었습니다.
  • [신규] eventstreams stop cluster - 명령어가 추가되었습니다.
  • [신규] eventstreams sync cluster state - 명령어가 추가되었습니다.
  • [신규] eventstreams sync parameter values - 명령어가 추가되었습니다.
  • [신규] eventstreams unset maintenance - 명령어가 추가되었습니다.

1 - CLIs

1.1 - Add Instances

1.1.1 - 1.1

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

Description

Add Instances.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-
service_ip_addresses
required		arrayUser subnet IP address-
instance_count
required		integerInstance Count-
public_ip_ids
optional		arrayPublic IP ID List-

Responses

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

1.1.2 - 1.0

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

Description

Add Instances.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-
service_ip_addresses
required		arrayUser subnet IP address-
instance_count
required		integerInstance Count-
public_ip_ids
optional		arrayPublic IP ID List-

Responses

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

1.2 - Create Cluster

1.2.1 - 1.1

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
zookeeper_sasl_password
required		stringzookeeper sasl password-
zookeeper_sasl_id
required		stringzookeeper sasl id-
broker_sasl_password
required		stringbroker sasl password-
broker_sasl_id
required		stringbroker sasl id-
timezone
required		stringTimezone-
subnet_id
required		stringSubnet ID-
service_watch_log_collection
required		booleanServiceWatch log collectionTrue
name
required		stringCluster name-
instance_name_prefix
required		stringInstance name prefix-
instance_groups
required		arrayInstance groups list'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}'
dbaas_engine_version_id
required		stringDBaaS engine version ID-
akhq_enabled
optional		booleanAKHQ availability-
allowable_ip_addresses
optional		arrayAllowed IP addresses list-
is_combined
optional		booleanHA availability-
nat_enabled
optional		booleanNAT availability-
tags
optional		arraytag'{"key": "", "value": ""}'
akhq_id
optional		stringakhq id-
akhq_password
optional		stringakhq password-
broker_port
optional		integerbroker port-
zookeeper_port
optional		integerzookeeper port-
period_hour
optional		stringPeriod in hours5
starting_day_of_week
optional		stringStarting day of weekMON
starting_time
optional		stringStarting time0000

Responses

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

1.2.2 - 1.0

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

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
zookeeper_sasl_password
required		stringzookeeper sasl password-
zookeeper_sasl_id
required		stringzookeeper sasl id-
broker_sasl_password
required		stringbroker sasl password-
broker_sasl_id
required		stringbroker sasl id-
timezone
required		stringTimezone-
subnet_id
required		stringSubnet ID-
name
required		stringCluster name-
instance_name_prefix
required		stringInstance name prefix-
instance_groups
required		arrayInstance groups list'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}'
dbaas_engine_version_id
required		stringDBaaS engine version ID-
akhq_enabled
optional		booleanAKHQ availability-
allowable_ip_addresses
optional		arrayAllowed IP addresses list-
is_combined
optional		booleanHA availability-
nat_enabled
optional		booleanNAT availability-
tags
optional		arraytag'{"key": "", "value": ""}'
akhq_id
optional		stringakhq id-
akhq_password
optional		stringakhq password-
broker_port
optional		integerbroker port-
zookeeper_port
optional		integerzookeeper port-
period_hour
optional		stringPeriod in hours5
starting_day_of_week
optional		stringStarting day of weekMON
starting_time
optional		stringStarting time0000

Responses

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

1.3 - List Clusters

1.3.1 - 1.1

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

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

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

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

1.3.2 - 1.0

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

Description

List Clusters.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

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

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

1.4 - List Engine Version Properties

1.4.1 - 1.1

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

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required		stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

1.4.2 - 1.0

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

Description

List Engine Version Properties.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required		stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

1.5 - List Engine Versions

1.5.1 - 1.1

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

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

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

Responses

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

1.5.2 - 1.0

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

Description

List Engine Versions.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

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

Responses

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

1.6 - List Parameter Groups

1.6.1 - 1.1

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

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

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

Responses

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

1.6.2 - 1.0

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

Description

List Parameter Groups.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

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

Responses

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

1.7 - List Parameter Values

1.7.1 - 1.1

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

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.7.2 - 1.0

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

Description

List Parameter Values.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.8 - List Parameters

1.8.1 - 1.1

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

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

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

Responses

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

1.8.2 - 1.0

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

Description

List Parameters.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

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

Responses

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

1.9 - List Server Types

1.9.1 - 1.1

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

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

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

Responses

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

1.9.2 - 1.0

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

Description

List Server Types.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

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

Responses

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

1.10 - Patch Minor Version

1.10.1 - 1.1

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

Description

Patch Minor Version.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

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

1.10.2 - 1.0

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

Description

Patch Minor Version.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

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

1.11 - Restart Cluster

1.11.1 - 1.1

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

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.11.2 - 1.0

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

Description

Restart Cluster.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.12 - Set Block Storage Size

1.12.1 - 1.1

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

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

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

Responses

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

1.12.2 - 1.0

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

Description

Set Block Storage Size.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

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

Responses

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

1.13 - Set Maintenance

1.13.1 - 1.1

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

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-
term_hour
required		stringterm_hour-
start_time
required		stringstart_time-
start_minute
required		stringstart_minute-
start_day_of_week
required		stringstart_day_of_week-

Responses

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

1.13.2 - 1.0

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

Description

Set Maintenance.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-
term_hour
required		stringterm_hour-
start_time
required		stringstart_time-
start_minute
required		stringstart_minute-
start_day_of_week
required		stringstart_day_of_week-

Responses

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

1.14 - Set Parameter Values

1.14.1 - 1.1

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

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

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

1.14.2 - 1.0

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

Description

Set Parameter Values.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

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

1.15 - Set Security Group Rules

1.15.1 - 1.1

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

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

Responses

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

1.15.2 - 1.0

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

Description

Set Security Group Rules.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

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

Responses

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

1.16 - Set Server Type

1.16.1 - 1.1

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

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

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

Responses

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

1.16.2 - 1.0

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

Description

Set Server Type.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

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

Responses

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

1.17 - Show Cluster

1.17.1 - 1.1

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

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
allowable_ip_addressesAllowed IP addresses list[]
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engineDBaaS engine
dbaas_engine_version_nameDBaaS engine version name
init_config_optionDB initial configuration option
instance_countInstance Count
instance_groupsInstance groups list[]
is_combinedMaster Data server separation state
maintenance_optionMaintenance option{}
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
nat_enabledNAT availability
product_image_typeProduct image type
product_typeProduct typeEvent Streams
role_typeRole type{}
service_stateService state
service_watch_log_collectionServiceWatch log collection
software_versionSoftware version
subnet_idSubnet ID
timezoneTimezone

1.17.2 - 1.0

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

Description

Show Cluster.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
allowable_ip_addressesAllowed IP addresses list[]
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engineDBaaS engine
dbaas_engine_version_nameDBaaS engine version name
init_config_optionDB initial configuration option
instance_countInstance Count
instance_groupsInstance groups list[]
is_combinedMaster Data server separation state
maintenance_optionMaintenance option{}
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
nat_enabledNAT availability
product_image_typeProduct image type
product_typeProduct typeEvent Streams
role_typeRole type{}
service_stateService state
software_versionSoftware version
subnet_idSubnet ID
timezoneTimezone

1.18 - Show Request

1.18.1 - 1.1

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

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
request_id
required		stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

1.18.2 - 1.0

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

Description

Show Request.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
request_id
required		stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

1.19 - Start Cluster

1.19.1 - 1.1

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

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.19.2 - 1.0

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

Description

Start Cluster.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.20 - Stop Cluster

1.20.1 - 1.1

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

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.20.2 - 1.0

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

Description

Stop Cluster.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.21 - Synchronize Cluster State

1.21.1 - 1.1

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

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.21.2 - 1.0

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

Description

Synchronize Cluster State.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.22 - Synchronize Parameter Values

1.22.1 - 1.1

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

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.22.2 - 1.0

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

Description

Synchronize Parameter Values.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

Responses

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

1.23 - Terminate Cluster

1.23.1 - 1.1

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

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

1.23.2 - 1.0

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

Description

Terminate Cluster.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

1.24 - Unset Maintenance

1.24.1 - 1.1

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

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-

1.24.2 - 1.0

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

Description

Unset Maintenance.

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
cluster_id
required		stringCluster ID-