이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.
CLIs
- 1: Add Instances
- 2: Create Cluster
- 3: List Clusters
- 4: List Engine Version Properties
- 5: List Engine Versions
- 6: List Parameter Groups
- 7: List Parameter Values
- 8: List Parameters
- 9: List Server Types
- 10: Patch Minor Version
- 11: Restart Cluster
- 12: Set Block Storage Size
- 13: Set Maintenance
- 14: Set Parameter Values
- 15: Set Security Group Rules
- 16: Set Server Type
- 17: Show Cluster
- 18: Show Instance
- 18.1: 1.2
- 19: Show Request
- 20: Start Cluster
- 21: Stop Cluster
- 22: Synchronize Cluster State
- 23: Synchronize Parameter Values
- 24: Terminate Cluster
- 25: Unset Maintenance
1 - Add Instances
1.1 - 1.2
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.2 | - |
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.1
scp-cli eventstreams instance add
--cluster_id <value>
--service_ip_addresses <value>
--instance_count <value>
[--public_ip_ids <value>]
Description
Add Instances.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 |
1.3 - 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.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.2
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.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| zookeeper_sasl_password required | string | zookeeper sasl password | zkpass123 |
| zookeeper_sasl_id required | string | zookeeper sasl id | zkadmin |
| broker_sasl_password required | string | broker sasl password | brokerpass123 |
| broker_sasl_id required | string | broker sasl id | brokeradmin |
| 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": "BROKER", "service_ip_address": "192.168.10.10/32"}], "role_type": "BROKER", "server_type_name": "ess1v2m4"}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint. | - |
| 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 | 5 |
| starting_day_of_week optional | string | Starting day of week | MON |
| starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.2 - 1.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 (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20261031 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| zookeeper_sasl_password required | string | zookeeper sasl password | zkpass123 |
| zookeeper_sasl_id required | string | zookeeper sasl id | zkadmin |
| broker_sasl_password required | string | broker sasl password | brokerpass123 |
| broker_sasl_id required | string | broker sasl id | brokeradmin |
| 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": "BROKER", "service_ip_address": "192.168.10.10/32"}], "role_type": "BROKER", "server_type_name": "ess1v2m4"}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint. | - |
| 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 | 5 |
| starting_day_of_week optional | string | Starting day of week | MON |
| starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.3 - 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.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| zookeeper_sasl_password required | string | zookeeper sasl password | zkpass123 |
| zookeeper_sasl_id required | string | zookeeper sasl id | zkadmin |
| broker_sasl_password required | string | broker sasl password | brokerpass123 |
| broker_sasl_id required | string | broker sasl id | brokeradmin |
| 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": "BROKER", "service_ip_address": "192.168.10.10/32"}], "role_type": "BROKER", "server_type_name": "ess1v2m4"}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint. | - |
| 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 | 5 |
| starting_day_of_week optional | string | Starting day of week | MON |
| starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3 - List Clusters
3.1 - 1.2
scp-cli eventstreams cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
Description
List Clusters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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 |
3.2 - 1.1
scp-cli eventstreams cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
Description
List Clusters.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 |
3.3 - 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.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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| ha_enabled | HA availability | |
| instance_count | Instance Count | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| role_type | Role type | |
| service_state | Service state |
4 - List Engine Version Properties
4.1 - 1.2
scp-cli eventstreams engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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 |
4.2 - 1.1
scp-cli eventstreams engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 |
4.3 - 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.0 | 20260531 |
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 |
5 - List Engine Versions
5.1 - 1.2
scp-cli eventstreams engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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 |
5.2 - 1.1
scp-cli eventstreams engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 |
5.3 - 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.0 | 20260531 |
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 |
6 - List Parameter Groups
6.1 - 1.2
scp-cli eventstreams parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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.1
scp-cli eventstreams parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20261031 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| major_version optional | string | Software major version | - |
| product_image_type optional | string | Product image type | - |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter group ID | |
| major_version | Software major version | |
| name | Parameter group name | |
| product_image_type | Product image type | |
| product_type | Product type |
6.3 - 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.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.2
scp-cli eventstreams parameter value list
--cluster_id <value>
Description
List Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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.1
scp-cli eventstreams parameter value list
--cluster_id <value>
Description
List Parameter Values.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20261031 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| allows_value | Parameter allows value | |
| applied_value | Parameter applied value | |
| apply_type | Parameter apply type | |
| data_type | Parameter data type | |
| default_value | Parameter default value | |
| description | Parameter description | |
| is_modifiable | Parameter is_modifiable | |
| name | Parameter name | |
| software_type | Parameter software type |
7.3 - 1.0
scp-cli eventstreams parameter value list
--cluster_id <value>
Description
List Parameter Values.
상태 ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
| 버전 | 최소 지원 보장일 |
|---|---|
| 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.2
scp-cli eventstreams parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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.1
scp-cli eventstreams parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20261031 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_parameter_group_id required | string | Parameter group ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| dbaas_parameter_group_id | Parameter id | |
| default_value | Parameter default value | |
| description | Parameter description | |
| name | Parameter name | |
| software_type | Parameter software type |
8.3 - 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.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.2
scp-cli eventstreams engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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.1
scp-cli eventstreams engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 |
9.3 - 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.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.2
scp-cli eventstreams minor version patch
--cluster_id <value>
--software_version <value>
--dbaas_engine <value>
Description
Patch Minor Version.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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.1
scp-cli eventstreams minor version patch
--cluster_id <value>
--software_version <value>
--dbaas_engine <value>
Description
Patch Minor Version.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 | - |
10.3 - 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.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.2
scp-cli eventstreams cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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.1
scp-cli eventstreams cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 |
11.3 - 1.0
scp-cli eventstreams cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
| 버전 | 최소 지원 보장일 |
|---|---|
| 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.2
scp-cli eventstreams block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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.1
scp-cli eventstreams block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 |
12.3 - 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.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.2
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.2 | - |
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.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 (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 |
13.3 - 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.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.2
scp-cli eventstreams parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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.1
scp-cli eventstreams parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20261031 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
14.3 - 1.0
scp-cli eventstreams parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
상태 ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
| 버전 | 최소 지원 보장일 |
|---|---|
| 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.2
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.2 | - |
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.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 (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 |
15.3 - 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.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.2
scp-cli eventstreams server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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.1
scp-cli eventstreams server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 |
16.3 - 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.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.2
scp-cli eventstreams cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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 | |
| 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 | Event Streams |
| role_type | Role type | {} |
| service_state | Service state | |
| service_watch_log_collection | ServiceWatch log collection | |
| software_version | Software version | |
| subnet_id | Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. | |
| timezone | Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. |
17.2 - 1.1
scp-cli eventstreams cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 | |
| 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 | Event Streams |
| role_type | Role type | {} |
| service_state | Service state | |
| service_watch_log_collection | ServiceWatch log collection | |
| software_version | Software version | |
| subnet_id | Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. | |
| timezone | Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. |
17.3 - 1.0
scp-cli eventstreams cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
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 | |
| 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 | Event Streams |
| role_type | Role type | {} |
| service_state | Service state | |
| software_version | Software version | |
| subnet_id | Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. | |
| timezone | Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. |
18 - Show Instance
18.1 - 1.2
scp-cli eventstreams instance show
--instance_name <value>
--cluster_id <value>
Description
Show Instance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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 |
19 - Show Request
19.1 - 1.2
scp-cli eventstreams request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
19.2 - 1.1
scp-cli eventstreams request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20261031 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
19.3 - 1.0
scp-cli eventstreams request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
20 - Start Cluster
20.1 - 1.2
scp-cli eventstreams cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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.1
scp-cli eventstreams cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 |
20.3 - 1.0
scp-cli eventstreams cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 - Stop Cluster
21.1 - 1.2
scp-cli eventstreams cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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.1
scp-cli eventstreams cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 |
21.3 - 1.0
scp-cli eventstreams cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 Cluster State
22.1 - 1.2
scp-cli eventstreams cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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.1
scp-cli eventstreams cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 |
22.3 - 1.0
scp-cli eventstreams cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 - Synchronize Parameter Values
23.1 - 1.2
scp-cli eventstreams parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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.1
scp-cli eventstreams parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 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 |
23.3 - 1.0
scp-cli eventstreams parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
상태 ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
24 - Terminate Cluster
24.1 - 1.2
scp-cli eventstreams cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
24.2 - 1.1
scp-cli eventstreams cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20261031 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
24.3 - 1.0
scp-cli eventstreams cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
25 - Unset Maintenance
25.1 - 1.2
scp-cli eventstreams maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |