이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.
Data Analytics
- 1: Data Flow
- 1.1: CLIs
- 1.1.1: CheckClusterResourceSizeForDataFlowServiceCreate
- 1.1.2: CheckClusterResourceSizeForDataFlowServiceUpdate
- 1.1.3: CheckDataFlowNameDuplication
- 1.1.4: CheckDataFlowServiceNameDuplication
- 1.1.5: CreateDataFlow
- 1.1.6: CreateDataFlowService
- 1.1.7: DeleteDataFlow
- 1.1.8: DeleteDataFlowService
- 1.1.9: ListDataFlowImages
- 1.1.10: ListDataFlows
- 1.1.11: ListDataFlowService
- 1.1.12: ShowDataFlow
- 1.1.13: ShowDataFlowService
- 1.1.14: ShowDataFlowServiceSubVersions
- 1.1.15: UpdateDataFlow
- 1.1.16: UpdateDataFlowService
- 2: Data Ops
- 2.1: CLIs
- 2.1.1: CheckClusterResourceSizeForDataOpsServiceCreate
- 2.1.2: CheckClusterResourceSizeForDataOpsServiceUpdate
- 2.1.3: CheckDataOpsNameDuplication
- 2.1.4: CheckDataOpsServiceNameDuplication
- 2.1.5: CreateDataOps
- 2.1.6: CreateDataOpsService
- 2.1.7: DeleteDataOps
- 2.1.8: DeleteDataOpsService
- 2.1.9: ListDataOps
- 2.1.10: ListDataOpsImageVersions
- 2.1.11: ListDataOpsService
- 2.1.12: ShowDataOps
- 2.1.13: ShowDataOpsService
- 2.1.14: ShowDataOpsServiceSubVersion
- 2.1.15: UpdateDataOps
- 2.1.16: UpdateDataOpsService
- 3: Event Streams
- 3.1: CLIs
- 3.1.1: Add Instances
- 3.1.1.1: 1.0
- 3.1.2: Create Cluster
- 3.1.2.1: 1.0
- 3.1.3: List Clusters
- 3.1.3.1: 1.0
- 3.1.4: List Engine Version Properties
- 3.1.4.1: 1.0
- 3.1.5: List Engine Versions
- 3.1.5.1: 1.0
- 3.1.6: List Parameter Groups
- 3.1.6.1: 1.0
- 3.1.7: List Parameter Values
- 3.1.7.1: 1.0
- 3.1.8: List Parameters
- 3.1.8.1: 1.0
- 3.1.9: List Server Types
- 3.1.9.1: 1.0
- 3.1.10: Restart Cluster
- 3.1.10.1: 1.0
- 3.1.11: Set Block Storage Size
- 3.1.11.1: 1.0
- 3.1.12: Set Maintenance
- 3.1.12.1: 1.0
- 3.1.13: Set Parameter Values
- 3.1.13.1: 1.0
- 3.1.14: Set Security Group Rules
- 3.1.14.1: 1.0
- 3.1.15: Set Server Type
- 3.1.15.1: 1.0
- 3.1.16: Show Cluster
- 3.1.16.1: 1.0
- 3.1.17: Show Request
- 3.1.17.1: 1.0
- 3.1.18: Start Cluster
- 3.1.18.1: 1.0
- 3.1.19: Stop Cluster
- 3.1.19.1: 1.0
- 3.1.20: Synchronize Cluster State
- 3.1.20.1: 1.0
- 3.1.21: Synchronize Parameter Values
- 3.1.21.1: 1.0
- 3.1.22: Terminate Cluster
- 3.1.22.1: 1.0
- 3.1.23: Unset Maintenance
- 3.1.23.1: 1.0
- 4: Quick Query
- 4.1: CLIs
- 4.1.1: CheckClusterResourceSizeForQuickQuery
- 4.1.2: CheckDuplicationQuickQueryName
- 4.1.3: CreateQuickQuery
- 4.1.4: DeleteQuickQuery
- 4.1.5: ListQuickQuery
- 4.1.6: ListQuickQueryImages
- 4.1.7: ShowQuickQuery
- 4.1.8: UpdateQuickQueryDescription
- 4.1.9: UpdateQuickQueryDomain
- 4.1.10: UpdateQuickQueryDscDomain
- 4.1.11: UpdateQuickQueryEngine
- 4.1.12: UpdateQuickQueryHostAlias
- 5: Search Engine
- 5.1: CLIs
- 5.1.1: Add Block Storages
- 5.1.1.1: 1.0
- 5.1.2: Add Instances
- 5.1.2.1: 1.0
- 5.1.3: Create Cluster
- 5.1.3.1: 1.0
- 5.1.4: Create Restore Cluster
- 5.1.4.1: 1.0
- 5.1.5: List Backup Histories
- 5.1.5.1: 1.0
- 5.1.6: List Clusters
- 5.1.6.1: 1.0
- 5.1.7: List Engine Version Properties
- 5.1.7.1: 1.0
- 5.1.8: List Engine Versions
- 5.1.8.1: 1.0
- 5.1.9: List Server Types
- 5.1.9.1: 1.0
- 5.1.10: Remove Backup Histories
- 5.1.10.1: 1.0
- 5.1.11: Restart Cluster
- 5.1.11.1: 1.0
- 5.1.12: Set Backup
- 5.1.12.1: 1.0
- 5.1.13: Set Block Storage Size
- 5.1.13.1: 1.0
- 5.1.14: Set Maintenance
- 5.1.14.1: 1.0
- 5.1.15: Set Security Group Rules
- 5.1.15.1: 1.0
- 5.1.16: Set Server Type
- 5.1.16.1: 1.0
- 5.1.17: Show Cluster
- 5.1.17.1: 1.0
- 5.1.18: Show Request
- 5.1.18.1: 1.0
- 5.1.19: Start Cluster
- 5.1.19.1: 1.0
- 5.1.20: Stop Cluster
- 5.1.20.1: 1.0
- 5.1.21: Synchronize Cluster State
- 5.1.21.1: 1.0
- 5.1.22: Terminate Cluster
- 5.1.22.1: 1.0
- 5.1.23: Unset Backup
- 5.1.23.1: 1.0
- 5.1.24: Unset Maintenance
- 5.1.24.1: 1.0
- 6: Vertica(DBaaS)
- 6.1: CLIs
- 6.1.1: Add Block Storages
- 6.1.1.1: 1.0
- 6.1.2: Create Cluster
- 6.1.2.1: 1.0
- 6.1.3: Create Restore Cluster
- 6.1.3.1: 1.0
- 6.1.4: List Backup Histories
- 6.1.4.1: 1.0
- 6.1.5: List Clusters
- 6.1.5.1: 1.0
- 6.1.6: List Engine Version Properties
- 6.1.6.1: 1.0
- 6.1.7: List Engine Versions
- 6.1.7.1: 1.0
- 6.1.8: List Server Types
- 6.1.8.1: 1.0
- 6.1.9: Remove Backup Histories
- 6.1.9.1: 1.0
- 6.1.10: Restart Cluster
- 6.1.10.1: 1.0
- 6.1.11: Set Backup
- 6.1.11.1: 1.0
- 6.1.12: Set Block Storage Size
- 6.1.12.1: 1.0
- 6.1.13: Set Maintenance
- 6.1.13.1: 1.0
- 6.1.14: Set Security Group Rules
- 6.1.14.1: 1.0
- 6.1.15: Set Server Type
- 6.1.15.1: 1.0
- 6.1.16: Show Cluster
- 6.1.16.1: 1.0
- 6.1.17: Show Request
- 6.1.17.1: 1.0
- 6.1.18: Start Cluster
- 6.1.18.1: 1.0
- 6.1.19: Stop Cluster
- 6.1.19.1: 1.0
- 6.1.20: Synchronize Cluster State
- 6.1.20.1: 1.0
- 6.1.21: Terminate Cluster
- 6.1.21.1: 1.0
- 6.1.22: Unset Backup
- 6.1.22.1: 1.0
- 6.1.23: Unset Maintenance
- 6.1.23.1: 1.0
1 - Data Flow
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Data Flow 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|
1.1 - CLIs
1.1.1 - CheckClusterResourceSizeForDataFlowServiceCreate
1.1.1.1 - 1.1
scpcli data-flow check cluster resource size for data flow service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Flow Service Creation.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| service_workload required | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
1.1.1.2 - 1.0
scpcli data-flow check cluster resource size for data flow service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Flow Service Creation.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| service_workload required | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
1.1.2 - CheckClusterResourceSizeForDataFlowServiceUpdate
1.1.2.1 - 1.1
scpcli data-flow check cluster resource size for data flow service update
--data_flow_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Flow Service Update.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| service_workload required | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
1.1.2.2 - 1.0
scpcli data-flow check cluster resource size for data flow service update
--data_flow_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Flow Service Update.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| service_workload required | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
1.1.3 - CheckDataFlowNameDuplication
1.1.3.1 - 1.1
scpcli data-flow check data flow name duplication
--data_flow_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Check Duplication Data Flow Name. (false: no duplicate value, true: duplicate value)
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_name required | string | Data flow name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | Data flow check result |
1.1.3.2 - 1.0
scpcli data-flow check data flow name duplication
--data_flow_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Check Duplication Data Flow Name. (false: no duplicate value, true: duplicate value)
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_name required | string | Data flow name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | Data flow check result |
1.1.4 - CheckDataFlowServiceNameDuplication
1.1.4.1 - 1.1
scpcli data-flow check data flow service name duplication
--data_flow_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Check Duplication Data Flow Service Name. (false: no duplicate value, true: duplicate value)
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_name required | string | Data flow service name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | Data flow service check result |
1.1.4.2 - 1.0
scpcli data-flow check data flow service name duplication
--data_flow_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Check Duplication Data Flow Service Name. (false: no duplicate value, true: duplicate value)
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_name required | string | Data flow service name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | Data flow service check result |
1.1.5 - CreateDataFlow
1.1.5.1 - 1.1
scpcli data-flow create data flow
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_flow_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
create data flow
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| ingress_controller_name required | string | ingress_controller_name | - |
| image_id required | string | image_id | - |
| host_alias_list required | array | host_alias_list | {'hostnames': [''], 'ip': ''} |
| domain required | string | domain | - |
| data_flow_name required | string | data_flow_name | - |
| cluster_id required | string | cluster_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| dsc_domain optional | string | dsc_domain | - |
| instance_id optional | string | instance_id | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
1.1.5.2 - 1.0
scpcli data-flow create data flow
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_flow_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
create data flow
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| ingress_controller_name required | string | ingress_controller_name | - |
| image_id required | string | image_id | - |
| host_alias_list required | array | host_alias_list | {'hostnames': [''], 'ip': ''} |
| domain required | string | domain | - |
| data_flow_name required | string | data_flow_name | - |
| cluster_id required | string | cluster_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| dsc_domain optional | string | dsc_domain | - |
| instance_id optional | string | instance_id | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
1.1.6 - CreateDataFlowService
1.1.6.1 - 1.1
scpcli data-flow create data flow service
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_flow_service_name <value>
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Create dataflow service console
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| service_workload required | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| host_alias required | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| domain required | string | description | - |
| data_flow_service_name required | string | data_flow_service_name | - |
| data_flow_id required | string | data_flow_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
1.1.6.2 - 1.0
scpcli data-flow create data flow service
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_flow_service_name <value>
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Create dataflow service console
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| service_workload required | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| host_alias required | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| domain required | string | description | - |
| data_flow_service_name required | string | data_flow_service_name | - |
| data_flow_id required | string | data_flow_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
1.1.7 - DeleteDataFlow
1.1.7.1 - 1.1
scpcli data-flow delete data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241s |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
1.1.7.2 - 1.0
scpcli data-flow delete data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241s |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
1.1.8 - DeleteDataFlowService
1.1.8.1 - 1.1
scpcli data-flow delete data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete dataflow service console
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
1.1.8.2 - 1.0
scpcli data-flow delete data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete dataflow service console
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
1.1.9 - ListDataFlowImages
1.1.9.1 - 1.1
scpcli data-flow list data flow images
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Get List of Data Flow Images.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| image_id | Image ID | |
| image_name | Image name | |
| version | Version |
1.1.9.2 - 1.0
scpcli data-flow list data flow images
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Get List of Data Flow Images.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| image_id | Image ID | |
| image_name | Image name | |
| version | Version |
1.1.10 - ListDataFlows
1.1.10.1 - 1.1
scpcli data-flow list data flow
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataflow_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_flow_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataflow list console v1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sort optional | string | sort | created_dt:desc |
| cluster_name optional | string | cluster_name | - |
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| dataflow_version optional | string | version | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| cluster_id optional | string | cluster_id | - |
| data_flow_name optional | string | data_flow_name | - |
| region optional | string | region | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| image_id | image_id | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| namespace_name | namespace_name | |
| state | state | |
| version | version |
1.1.10.2 - 1.0
scpcli data-flow list data flow
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataflow_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_flow_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataflow list console
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sort optional | string | sort | created_dt:desc |
| cluster_name optional | string | cluster_name | - |
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| dataflow_version optional | string | version | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| cluster_id optional | string | cluster_id | - |
| data_flow_name optional | string | data_flow_name | - |
| region optional | string | region | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| image_id | image_id | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| namespace_name | namespace_name | |
| state | state | |
| version | version |
1.1.11 - ListDataFlowService
1.1.11.1 - 1.1
scpcli data-flow list data flow service
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--state <value>]
[--data_flow_service_name <value>]
[--data_flow_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataflow service list console v1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | - |
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| data_flow_service_name optional | string | data_flow_service_name | - |
| data_flow_name optional | string | data_flow_name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| data_flow_service_id | data_flow_service_id | |
| data_flow_service_name | data_flow_service_name | |
| description | description | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| state | state | |
| version | version |
1.1.11.2 - 1.0
scpcli data-flow list data flow service
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--state <value>]
[--data_flow_service_name <value>]
[--data_flow_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataflow service list console
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | - |
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| data_flow_service_name optional | string | data_flow_service_name | - |
| data_flow_name optional | string | data_flow_name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| data_flow_service_id | data_flow_service_id | |
| data_flow_service_name | data_flow_service_name | |
| description | description | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| state | state | |
| version | version |
1.1.12 - ShowDataFlow
1.1.12.1 - 1.1
scpcli data-flow show data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241s |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| count_data_flow_service | count_data_flow_service | |
| created_dt | created_dt | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| description | description | |
| domain | domain | |
| host_alias_list | host_alias | [{‘hostnames’: [’’], ‘ip’: ‘’}] |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url | web_url |
1.1.12.2 - 1.0
scpcli data-flow show data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241s |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| count_data_flow_service | count_data_flow_service | |
| created_dt | created_dt | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| description | description | |
| domain | domain | |
| host_alias_list | host_alias | [{‘hostnames’: [’’], ‘ip’: ‘’}] |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url | web_url |
1.1.13 - ShowDataFlowService
1.1.13.1 - 1.1
scpcli data-flow show data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
GET dataflow service console v1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| data_flow_service_id | data_flow_service_id | |
| data_flow_service_name | data_flow_service_name | |
| description | description | |
| domain | domain | |
| host_alias | host_alias | {’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]} |
| host_file_registry | host_file_registry | |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| service_workload | service_workload | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url_nifi | web_url_nifi | |
| web_url_registry | web_url_registry |
1.1.13.2 - 1.0
scpcli data-flow show data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
GET dataflow service console
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| data_flow_service_id | data_flow_service_id | |
| data_flow_service_name | data_flow_service_name | |
| description | description | |
| domain | domain | |
| host_alias | host_alias | {’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]} |
| host_file_registry | host_file_registry | |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| service_workload | service_workload | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url_nifi | web_url_nifi | |
| web_url_registry | web_url_registry |
1.1.14 - ShowDataFlowServiceSubVersions
1.1.14.1 - 1.1
scpcli data-flow show data flow service sub versions
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Get List of Data Flow Service Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Data flow ID | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| data_flow_service_count | DataFlowService count | |
| versions | image versions |
1.1.14.2 - 1.0
scpcli data-flow show data flow service sub versions
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Get List of Data Flow Service Versions.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Data flow ID | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| data_flow_service_count | DataFlowService count | |
| versions | image versions |
1.1.15 - UpdateDataFlow
1.1.15.1 - 1.1
scpcli data-flow update data flow
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update data flow by flow id
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241s |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias_list optional | array | host_alias | {'hostnames': [''], 'ip': ''} |
| node_selector optional | string | node_selector | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
1.1.15.2 - 1.0
scpcli data-flow update data flow
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update data flow by flow id
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241s |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias_list optional | array | host_alias | {'hostnames': [''], 'ip': ''} |
| node_selector optional | string | node_selector | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
1.1.16 - UpdateDataFlowService
1.1.16.1 - 1.1
scpcli data-flow update data flow service
--data_flow_service_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update dataflow service console
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias optional | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| node_selector optional | string | node_selector | - |
| service_workload optional | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
1.1.16.2 - 1.0
scpcli data-flow update data flow service
--data_flow_service_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update dataflow service console
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias optional | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| node_selector optional | string | node_selector | - |
| service_workload optional | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
2 - Data Ops
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Data Ops 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|
2.1 - CLIs
2.1.1 - CheckClusterResourceSizeForDataOpsServiceCreate
2.1.1.1 - 1.1
scpcli data-ops check cluster resource size for data ops service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Ops Service Creation.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| service_workload required | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
2.1.1.2 - 1.0
scpcli data-ops check cluster resource size for data ops service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Ops Service Creation.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| service_workload required | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
2.1.2 - CheckClusterResourceSizeForDataOpsServiceUpdate
2.1.2.1 - 1.1
scpcli data-ops check cluster resource size for data ops service update
--data_ops_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Ops Service Update.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| service_workload required | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
2.1.2.2 - 1.0
scpcli data-ops check cluster resource size for data ops service update
--data_ops_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Ops Service Update.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| service_workload required | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
2.1.3 - CheckDataOpsNameDuplication
2.1.3.1 - 1.1
scpcli data-ops check data ops name duplication
--data_ops_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
check duplication controller
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_name required | string | data ops name | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
2.1.3.2 - 1.0
scpcli data-ops check data ops name duplication
--data_ops_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
check duplication controller
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_name required | string | data ops name | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
2.1.4 - CheckDataOpsServiceNameDuplication
2.1.4.1 - 1.1
scpcli data-ops check data ops service name duplication
--data_ops_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
check duplication controller
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_name required | string | data ops service name | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
2.1.4.2 - 1.0
scpcli data-ops check data ops service name duplication
--data_ops_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
check duplication controller
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_name required | string | data ops service name | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
2.1.5 - CreateDataOps
2.1.5.1 - 1.1
scpcli data-ops create data ops
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_ops_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
create dataops
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| ingress_controller_name required | string | ingress_controller_name | - |
| image_id required | string | image_id | - |
| host_alias_list required | array | host_alias_list | {'hostnames': [''], 'ip': ''} |
| domain required | string | domain | - |
| data_ops_name required | string | data_ops_name | - |
| cluster_id required | string | cluster_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| dsc_domain optional | string | dsc_domain | - |
| instance_id optional | string | instance_id | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
2.1.5.2 - 1.0
scpcli data-ops create data ops
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_ops_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
create dataops
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| ingress_controller_name required | string | ingress_controller_name | - |
| image_id required | string | image_id | - |
| host_alias_list required | array | host_alias_list | {'hostnames': [''], 'ip': ''} |
| domain required | string | domain | - |
| data_ops_name required | string | data_ops_name | - |
| cluster_id required | string | cluster_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| dsc_domain optional | string | dsc_domain | - |
| instance_id optional | string | instance_id | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
2.1.6 - CreateDataOpsService
2.1.6.1 - 1.1
scpcli data-ops create data ops service
--worker_type <value>
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_ops_service_name <value>
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
create dataops service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| worker_type required | string | worker_type | - |
| storage_class_name required | string | storage_class_name | - |
| service_workload required | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| host_alias required | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| domain required | string | description | - |
| data_ops_service_name required | string | data_ops_service_name | - |
| data_ops_id required | string | data_ops_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
2.1.6.2 - 1.0
scpcli data-ops create data ops service
--worker_type <value>
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_ops_service_name <value>
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
create dataops service
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| worker_type required | string | worker_type | - |
| storage_class_name required | string | storage_class_name | - |
| service_workload required | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| host_alias required | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| domain required | string | description | - |
| data_ops_service_name required | string | data_ops_service_name | - |
| data_ops_id required | string | data_ops_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
2.1.7 - DeleteDataOps
2.1.7.1 - 1.1
scpcli data-ops delete data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete dataops v1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
2.1.7.2 - 1.0
scpcli data-ops delete data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete dataops v1
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
2.1.8 - DeleteDataOpsService
2.1.8.1 - 1.1
scpcli data-ops delete data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete data ops service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
2.1.8.2 - 1.0
scpcli data-ops delete data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete data ops service
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
2.1.9 - ListDataOps
2.1.9.1 - 1.1
scpcli data-ops list data ops
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataops_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_ops_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
{aianalytics.GetDataOpsListConsole.notes} v1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sort optional | string | sort | created_dt:desc |
| cluster_name optional | string | cluster_name | - |
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| dataops_version optional | string | version | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| cluster_id optional | string | cluster_id | - |
| data_ops_name optional | string | data_ops_name | - |
| region optional | string | region | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| image_id | image_id | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| namespace_name | namespace_name | |
| state | state | |
| version | version |
2.1.9.2 - 1.0
scpcli data-ops list data ops
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataops_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_ops_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
{aianalytics.GetDataOpsListConsole.notes}
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sort optional | string | sort | created_dt:desc |
| cluster_name optional | string | cluster_name | - |
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| dataops_version optional | string | version | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| cluster_id optional | string | cluster_id | - |
| data_ops_name optional | string | data_ops_name | - |
| region optional | string | region | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| image_id | image_id | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| namespace_name | namespace_name | |
| state | state | |
| version | version |
2.1.10 - ListDataOpsImageVersions
2.1.10.1 - 1.1
scpcli data-ops list data ops image versions
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataops image version v1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| image_attr | image_attr | |
| image_id | image_id | |
| image_name | image_name | |
| version | version |
2.1.10.2 - 1.0
scpcli data-ops list data ops image versions
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataops image version v1
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| image_attr | image_attr | |
| image_id | image_id | |
| image_name | image_name | |
| version | version |
2.1.11 - ListDataOpsService
2.1.11.1 - 1.1
scpcli data-ops list data ops service
[--created_by <value>]
[--state <value>]
[--sort <value>]
[--size <value>]
[--page <value>]
[--data_ops_service_name <value>]
[--data_ops_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
GetDataOpsServiceListConsole v1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| sort optional | string | sort | created_dt:desc |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| data_ops_service_name optional | string | data_ops_service_name | - |
| data_ops_name optional | string | data_ops_name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| data_ops_service_id | data_ops_service_id | |
| data_ops_service_name | data_ops_service_name | |
| description | description | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| state | state | |
| version | version |
2.1.11.2 - 1.0
scpcli data-ops list data ops service
[--created_by <value>]
[--state <value>]
[--sort <value>]
[--size <value>]
[--page <value>]
[--data_ops_service_name <value>]
[--data_ops_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
GetDataOpsServiceListConsole
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| sort optional | string | sort | created_dt:desc |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| data_ops_service_name optional | string | data_ops_service_name | - |
| data_ops_name optional | string | data_ops_name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| data_ops_service_id | data_ops_service_id | |
| data_ops_service_name | data_ops_service_name | |
| description | description | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| state | state | |
| version | version |
2.1.12 - ShowDataOps
2.1.12.1 - 1.1
scpcli data-ops show data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataops detail v1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| description | description | |
| domain | domain | |
| host_alias_list | host_alias | [{‘hostnames’: [’’], ‘ip’: ‘’}] |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url | web_url |
2.1.12.2 - 1.0
scpcli data-ops show data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataops detail
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| description | description | |
| domain | domain | |
| host_alias_list | host_alias | [{‘hostnames’: [’’], ‘ip’: ‘’}] |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url | web_url |
2.1.13 - ShowDataOpsService
2.1.13.1 - 1.1
scpcli data-ops show data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data ops service v1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| data_ops_service_id | data_ops_service_id | |
| data_ops_service_name | data_ops_service_name | |
| description | description | |
| domain | domain | |
| host_alias | host_alias | {’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]} |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| service_workload | service_workload | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url | web_url |
2.1.13.2 - 1.0
scpcli data-ops show data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data ops service
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| data_ops_service_id | data_ops_service_id | |
| data_ops_service_name | data_ops_service_name | |
| description | description | |
| domain | domain | |
| host_alias | host_alias | {’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]} |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| service_workload | service_workload | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url | web_url |
2.1.14 - ShowDataOpsServiceSubVersion
2.1.14.1 - 1.1
scpcli data-ops show data ops service sub version
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data ops sub version
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| data_ops_service_count | DataOpsService count | |
| versions | image versions |
2.1.14.2 - 1.0
scpcli data-ops show data ops service sub version
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data ops sub version
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| data_ops_service_count | DataOpsService count | |
| versions | image versions |
2.1.15 - UpdateDataOps
2.1.15.1 - 1.1
scpcli data-ops update data ops
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update dataops v1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias_list optional | array | host_alias | {'hostnames': [''], 'ip': ''} |
| node_selector optional | string | node_selector | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
2.1.15.2 - 1.0
scpcli data-ops update data ops
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update dataops v1
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias_list optional | array | host_alias | {'hostnames': [''], 'ip': ''} |
| node_selector optional | string | node_selector | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
2.1.16 - UpdateDataOpsService
2.1.16.1 - 1.1
scpcli data-ops update data ops service
--data_ops_service_id <value>
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--worker_type <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update data ops service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias optional | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| node_selector optional | string | node_selector | - |
| service_workload optional | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| worker_type optional | string | worker_type | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
2.1.16.2 - 1.0
scpcli data-ops update data ops service
--data_ops_service_id <value>
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--worker_type <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update data ops service
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias optional | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| node_selector optional | string | node_selector | - |
| service_workload optional | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| worker_type optional | string | worker_type | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
3 - Event Streams
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Event Streams 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
3.1 - CLIs
3.1.1 - Add Instances
3.1.1.1 - 1.0
scpcli eventstreams instance add
--cluster_id <value>
--service_ip_addresses <value>
--instance_count <value>
[--public_ip_ids <value>]
Description
Add Instances.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| service_ip_addresses required | array | User subnet IP address | - |
| instance_count required | integer | Instance Count | - |
| public_ip_ids optional | array | Public IP ID List | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.2 - Create Cluster
3.1.2.1 - 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.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
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.1.3 - List Clusters
3.1.3.1 - 1.0
scpcli eventstreams cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
Description
List Clusters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Cluster name | - |
| service_state optional | string | Service state | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | 생성 시간 | 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.1.4 - List Engine Version Properties
3.1.4.1 - 1.0
scpcli eventstreams engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
3.1.5 - List Engine Versions
3.1.5.1 - 1.0
scpcli eventstreams engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version |
3.1.6 - List Parameter Groups
3.1.6.1 - 1.0
scpcli eventstreams parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
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 |
3.1.7 - List Parameter Values
3.1.7.1 - 1.0
scpcli eventstreams parameter value list
--cluster_id <value>
Description
List Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
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 |
3.1.8 - List Parameters
3.1.8.1 - 1.0
scpcli eventstreams parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
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 |
3.1.9 - List Server Types
3.1.9.1 - 1.0
scpcli eventstreams engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu_core | Server type cpu core | |
| description | Server type description | |
| memory_gb | Server type memory | |
| name | Server type name | |
| product_image_type | Product image type | |
| product_type | Product type | |
| purpose | Server type purpose | |
| type | Server type class |
3.1.10 - Restart Cluster
3.1.10.1 - 1.0
scpcli eventstreams cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.11 - Set Block Storage Size
3.1.11.1 - 1.0
scpcli eventstreams block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.12 - Set Maintenance
3.1.12.1 - 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.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| term_hour required | string | term_hour | - |
| start_time required | string | start_time | - |
| start_minute required | string | start_minute | - |
| start_day_of_week required | string | start_day_of_week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.13 - Set Parameter Values
3.1.13.1 - 1.0
scpcli eventstreams parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
3.1.14 - Set Security Group Rules
3.1.14.1 - 1.0
scpcli eventstreams security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| add_ip_addresses optional | array | Allowed IP addresses list | - |
| del_ip_addresses optional | array | Allowed IP addresses list | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.15 - Set Server Type
3.1.15.1 - 1.0
scpcli eventstreams server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.16 - Show Cluster
3.1.16.1 - 1.0
scpcli eventstreams cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| block_storage_groups | Block storage groups list | |
| instances | Instances list | |
| role_type | Role type | |
| server_type_name | Server type name |
3.1.17 - Show Request
3.1.17.1 - 1.0
scpcli eventstreams request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
3.1.18 - Start Cluster
3.1.18.1 - 1.0
scpcli eventstreams cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.19 - Stop Cluster
3.1.19.1 - 1.0
scpcli eventstreams cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.20 - Synchronize Cluster State
3.1.20.1 - 1.0
scpcli eventstreams cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.21 - Synchronize Parameter Values
3.1.21.1 - 1.0
scpcli eventstreams parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.22 - Terminate Cluster
3.1.22.1 - 1.0
scpcli eventstreams cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
3.1.23 - Unset Maintenance
3.1.23.1 - 1.0
scpcli eventstreams maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
4 - Quick Query
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Quick Query 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|
4.1 - CLIs
4.1.1 - CheckClusterResourceSizeForQuickQuery
4.1.1.1 - 1.1
scpcli quick-query check resource validation
--node_pool_validation_request <value>
[--cluster_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--is_engine_type_private <value>]
[--memory <value>]
[--replica <value>]
Description
Check if resource is verified to be modified/created
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| node_pool_validation_request required | array | node_pool_validation_request | '{"auto_scale": "", "desired_node_count": "", "max_node_count": "", "min_node_count": "", "scale_name": ""}' |
| cluster_id optional | string | cluster_id | - |
| auto_scale optional | boolean | auto_scale | - |
| cluster_size optional | string | cluster_size | - |
| cpu optional | string | cpu | - |
| is_engine_type_private optional | boolean | is_engine_type_private | - |
| memory optional | string | memory | - |
| replica optional | string | replica | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | cpu | |
| is_node_pool_auto_scalable | is_node_pool_auto_scalable | |
| memory | memory | |
| replica | replica |
4.1.1.2 - 1.0
scpcli quick-query check resource validation
--node_pool_validation_request <value>
[--cluster_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--is_engine_type_private <value>]
[--memory <value>]
[--replica <value>]
Description
Check if resource is verified to be modified/created
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| node_pool_validation_request required | array | node_pool_validation_request | '{"auto_scale": "", "desired_node_count": "", "max_node_count": "", "min_node_count": "", "scale_name": ""}' |
| cluster_id optional | string | cluster_id | - |
| auto_scale optional | boolean | auto_scale | - |
| cluster_size optional | string | cluster_size | - |
| cpu optional | string | cpu | - |
| is_engine_type_private optional | boolean | is_engine_type_private | - |
| memory optional | string | memory | - |
| replica optional | string | replica | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | cpu | |
| is_node_pool_auto_scalable | is_node_pool_auto_scalable | |
| memory | memory | |
| replica | replica |
4.1.2 - CheckDuplicationQuickQueryName
4.1.2.1 - 1.1
scpcli quick-query check quick query duplication
--quick_query_name <value>
Description
Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_name required | string | quick query name | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | check result |
4.1.2.2 - 1.0
scpcli quick-query check quick query duplication
--quick_query_name <value>
Description
Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_name required | string | quick query name | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | check result |
4.1.3 - CreateQuickQuery
4.1.3.1 - 1.1
scpcli quick-query create quick query
--quickquery_version <value>
--quick_query_name <value>
--max_query <value>
--is_engine_type_private <value>
--image_id <value>
--dsc_domain <value>
--domain <value>
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--kubernetes_engine_name <value>
--k8s_version <value>
--cloud_logging_enabled <value>
--node_pool_create_requests <value>
[--tags <value>]
[--cifs_volume_id <value>]
[--lb_id <value>]
[--public_acl_ip_address <value>]
[--description <value>]
[--dsc_console_ip <value>]
[--host_alias_list <value>]
[--instance_id <value>]
[--product_group_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--memory <value>]
[--replica <value>]
Description
Create Quick Query.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quickquery_version required | string | version | - |
| quick_query_name required | string | quick_query_name | - |
| max_query required | string | max_query | - |
| is_engine_type_private required | boolean | is_engine_type_private | - |
| image_id required | string | image_id | - |
| dsc_domain required | string | dsc_domain | - |
| domain required | string | domain | - |
| vpc_id required | string | vpc_id | - |
| volume_id required | string | volume_id | - |
| subnet_id required | string | subnet_id | - |
| security_group_id_list required | array | security_group_id_list | - |
| kubernetes_engine_name required | string | kubernetes_engine_name | - |
| k8s_version required | string | k8s_version | - |
| cloud_logging_enabled required | boolean | cloud_logging_enabled | - |
| node_pool_create_requests required | array | node_pool_create_requests | '{"auto_recovery": false, "auto_scale": false, "desired_node_count": "", "image_os": "", "image_os_version": "", "k8s_version": "", "keypair_name": "", "max_node_count": "", "min_node_count": "", "name": "", "scale_name": "", "volume_size": "", "volume_type_name": ""}' |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| cifs_volume_id optional | string | cifs_volume_id | - |
| lb_id optional | string | lb_id | - |
| public_acl_ip_address optional | string | public_acl_ip_address | - |
| description optional | string | description | - |
| dsc_console_ip optional | string | dsc_console_ip | - |
| host_alias_list optional | array | host_alias_list | '{"hostnames": "", "ip": ""}' |
| instance_id optional | string | instance_id | - |
| product_group_id optional | string | product_group_id | - |
| auto_scale optional | boolean | auto_scale | - |
| cluster_size optional | string | cluster_size | - |
| cpu optional | string | cpu | - |
| memory optional | string | memory | - |
| replica optional | string | replica | - |
Responses
| Name | Description | Example |
|---|---|---|
| project_id | Project ID | 10a599e031e749b7b260868f441e862b |
| request_id | Request ID | 10a599e031e749b7b260868f441e862b |
| resource_id | Resource ID | 10a599e031e749b7b260868f441e862b |
4.1.3.2 - 1.0
scpcli quick-query create quick query
--quickquery_version <value>
--quick_query_name <value>
--max_query <value>
--is_engine_type_private <value>
--image_id <value>
--dsc_domain <value>
--domain <value>
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--kubernetes_engine_name <value>
--k8s_version <value>
--cloud_logging_enabled <value>
--node_pool_create_requests <value>
[--tags <value>]
[--cifs_volume_id <value>]
[--lb_id <value>]
[--public_acl_ip_address <value>]
[--description <value>]
[--dsc_console_ip <value>]
[--host_alias_list <value>]
[--instance_id <value>]
[--product_group_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--memory <value>]
[--replica <value>]
Description
Create Quick Query.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quickquery_version required | string | version | - |
| quick_query_name required | string | quick_query_name | - |
| max_query required | string | max_query | - |
| is_engine_type_private required | boolean | is_engine_type_private | - |
| image_id required | string | image_id | - |
| dsc_domain required | string | dsc_domain | - |
| domain required | string | domain | - |
| vpc_id required | string | vpc_id | - |
| volume_id required | string | volume_id | - |
| subnet_id required | string | subnet_id | - |
| security_group_id_list required | array | security_group_id_list | - |
| kubernetes_engine_name required | string | kubernetes_engine_name | - |
| k8s_version required | string | k8s_version | - |
| cloud_logging_enabled required | boolean | cloud_logging_enabled | - |
| node_pool_create_requests required | array | node_pool_create_requests | '{"auto_recovery": false, "auto_scale": false, "desired_node_count": "", "image_os": "", "image_os_version": "", "k8s_version": "", "keypair_name": "", "max_node_count": "", "min_node_count": "", "name": "", "scale_name": "", "volume_size": "", "volume_type_name": ""}' |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| cifs_volume_id optional | string | cifs_volume_id | - |
| lb_id optional | string | lb_id | - |
| public_acl_ip_address optional | string | public_acl_ip_address | - |
| description optional | string | description | - |
| dsc_console_ip optional | string | dsc_console_ip | - |
| host_alias_list optional | array | host_alias_list | '{"hostnames": "", "ip": ""}' |
| instance_id optional | string | instance_id | - |
| product_group_id optional | string | product_group_id | - |
| auto_scale optional | boolean | auto_scale | - |
| cluster_size optional | string | cluster_size | - |
| cpu optional | string | cpu | - |
| memory optional | string | memory | - |
| replica optional | string | replica | - |
Responses
| Name | Description | Example |
|---|---|---|
| project_id | Project ID | 10a599e031e749b7b260868f441e862b |
| request_id | Request ID | 10a599e031e749b7b260868f441e862b |
| resource_id | Resource ID | 10a599e031e749b7b260868f441e862b |
4.1.4 - DeleteQuickQuery
4.1.4.1 - 1.1
scpcli quick-query delete quick query
--quick_query_id <value>
Description
delete quick query
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
4.1.4.2 - 1.0
scpcli quick-query delete quick query
--quick_query_id <value>
Description
delete quick query
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
4.1.5 - ListQuickQuery
4.1.5.1 - 1.1
scpcli quick-query list quick query
--page <value>
--size <value>
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--quick_query_state <value>]
[--quickquery_version <value>]
[--quick_query_name <value>]
Description
get quick query list console
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| page required | integer | page | 0 |
| size required | integer | size | 20 |
| sort optional | string | sort | created_at:desc |
| cluster_name optional | string | cluster_name | - |
| created_by optional | string | created_by | - |
| quick_query_state optional | **** | state | - |
| quickquery_version optional | string | version | - |
| quick_query_name optional | string | quick_query_name | - |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| quick_query_id | quick_query_id | |
| quick_query_name | quick_query_name | |
| quick_query_state | quick_query_state | |
| quick_query_version | quick_query_version |
4.1.5.2 - 1.0
scpcli quick-query list quick query
--page <value>
--size <value>
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--quick_query_state <value>]
[--quickquery_version <value>]
[--quick_query_name <value>]
Description
get quick query list console
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| page required | integer | page | 0 |
| size required | integer | size | 20 |
| sort optional | string | sort | created_at:desc |
| cluster_name optional | string | cluster_name | - |
| created_by optional | string | created_by | - |
| quick_query_state optional | **** | state | - |
| quickquery_version optional | string | version | - |
| quick_query_name optional | string | quick_query_name | - |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| quick_query_id | quick_query_id | |
| quick_query_name | quick_query_name | |
| quick_query_state | quick_query_state | |
| quick_query_version | quick_query_version |
4.1.6 - ListQuickQueryImages
4.1.6.1 - 1.1
scpcli quick-query list quick query images
Description
get quick query image versions
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|---|---|
| image_attr | image_attr | |
| image_id | image_id | |
| image_name | image_name | |
| version | version |
4.1.6.2 - 1.0
scpcli quick-query list quick query images
Description
get quick query image versions
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Responses
| Name | Description | Example |
|---|---|---|
| image_attr | image_attr | |
| image_id | image_id | |
| image_name | image_name | |
| version | version |
4.1.7 - ShowQuickQuery
4.1.7.1 - 1.1
scpcli quick-query show quick query
--quick_query_id <value>
Description
Get Quick Query details.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
Responses
| Name | Description | Example |
|---|---|---|
| age | age | |
| cluster_id | cluster id | |
| container_version | Container Version | |
| created_at | created at | |
| external_ip_address | External IP Address | |
| gpu_name | GPU Name | |
| ip | IP | |
| kernel_version | Kernel Version | |
| kubernetes_version | Kubernetes Version | |
| name | name | |
| node_capacities | Node Capacities | |
| node_status | node status | |
| number_of_allocated_pods | Number of allocated pods | |
| number_of_gpu | Number of GPU | |
| os_image | OS Image | |
| uid | uid |
4.1.7.2 - 1.0
scpcli quick-query show quick query
--quick_query_id <value>
Description
Get Quick Query details.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
Responses
| Name | Description | Example |
|---|---|---|
| age | age | |
| cluster_id | cluster id | |
| container_version | Container Version | |
| created_at | created at | |
| external_ip_address | External IP Address | |
| gpu_name | GPU Name | |
| ip | IP | |
| kernel_version | Kernel Version | |
| kubernetes_version | Kubernetes Version | |
| name | name | |
| node_capacities | Node Capacities | |
| node_status | node status | |
| number_of_allocated_pods | Number of allocated pods | |
| number_of_gpu | Number of GPU | |
| os_image | OS Image | |
| uid | uid |
4.1.8 - UpdateQuickQueryDescription
4.1.8.1 - 1.1
scpcli quick-query update quick query description
--quick_query_id <value>
--description <value>
Description
update quick query description
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| description required | string | description | - |
4.1.8.2 - 1.0
scpcli quick-query update quick query description
--quick_query_id <value>
--description <value>
Description
update quick query description
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| description required | string | description | - |
4.1.9 - UpdateQuickQueryDomain
4.1.9.1 - 1.1
scpcli quick-query update quick query domain
--quick_query_id <value>
--domain <value>
Description
update quick query domain
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| domain required | string | domain | - |
4.1.9.2 - 1.0
scpcli quick-query update quick query domain
--quick_query_id <value>
--domain <value>
Description
update quick query domain
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| domain required | string | domain | - |
4.1.10 - UpdateQuickQueryDscDomain
4.1.10.1 - 1.1
scpcli quick-query update quick query dsc domain
--quick_query_id <value>
--dsc_domain <value>
Description
update quick query dsc domain
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| dsc_domain required | string | dsc_domain | - |
4.1.10.2 - 1.0
scpcli quick-query update quick query dsc domain
--quick_query_id <value>
--dsc_domain <value>
Description
update quick query dsc domain
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| dsc_domain required | string | dsc_domain | - |
4.1.11 - UpdateQuickQueryEngine
4.1.11.1 - 1.1
scpcli quick-query update quick query engine
--quick_query_id <value>
--replica <value>
--memory <value>
--cpu <value>
[--cluster_size <value>]
Description
update quick query engine
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| replica required | string | replica | - |
| memory required | string | memory | - |
| cpu required | string | cpu | - |
| cluster_size optional | string | cluster_size | - |
4.1.11.2 - 1.0
scpcli quick-query update quick query engine
--quick_query_id <value>
--replica <value>
--memory <value>
--cpu <value>
[--cluster_size <value>]
Description
update quick query engine
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| replica required | string | replica | - |
| memory required | string | memory | - |
| cpu required | string | cpu | - |
| cluster_size optional | string | cluster_size | - |
4.1.12 - UpdateQuickQueryHostAlias
4.1.12.1 - 1.1
scpcli quick-query update quick query host alias
--quick_query_id <value>
[--host_alias_list <value>]
Description
update quick query host alias
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| host_alias_list optional | array | host_alias_list | '{"hostnames": "", "ip": ""}' |
4.1.12.2 - 1.0
scpcli quick-query update quick query host alias
--quick_query_id <value>
[--host_alias_list <value>]
Description
update quick query host alias
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| host_alias_list optional | array | host_alias_list | '{"hostnames": "", "ip": ""}' |
5 - Search Engine
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Search Engine 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
5.1 - CLIs
5.1.1 - Add Block Storages
5.1.1.1 - 1.0
scpcli searchengine block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| size_gb required | integer | Size in GB | 104 |
| role_type required | string | Role type | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.2 - Add Instances
5.1.2.1 - 1.0
scpcli searchengine instance add
--cluster_id <value>
--service_ip_addresses <value>
--instance_count <value>
[--public_ip_ids <value>]
Description
Add Instances.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| service_ip_addresses required | array | User subnet IP address | - |
| instance_count required | integer | Instance Count | - |
| public_ip_ids optional | array | Public IP ID List | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.3 - Create Cluster
5.1.3.1 - 1.0
scpcli searchengine cluster create
--starting_time_hour <value>
--retention_period_day <value>
--database_user_password <value>
--database_user_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--is_combined <value>]
[--license <value>]
[--nat_enabled <value>]
[--tags <value>]
[--database_port <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| is_combined optional | boolean | Master Data server separation state | - |
| license optional | string | license | - |
| nat_enabled optional | boolean | NAT availability | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| database_port optional | integer | Database service port | - |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.4 - Create Restore Cluster
5.1.4.1 - 1.0
scpcli searchengine restore create
--cluster_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--backup_history_number <value>
[--allowable_ip_addresses <value>]
[--license <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Restore Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "role_type": "ACTIVE"}' |
| backup_history_number required | string | Backup id | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| license optional | string | license | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.5 - List Backup Histories
5.1.5.1 - 1.0
scpcli searchengine backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| limit optional | integer | Number of backup lists | - |
| page optional | integer | Backup list page | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_at | Backup end time | |
| backup_history_number | Backup id | |
| backup_size_gb | Backup amount(GB) | |
| backup_start_at | Backup start time | |
| backup_state | Backup state | |
| backup_state_detail | Backup detail state | |
| software_version | Software version |
5.1.6 - List Clusters
5.1.6.1 - 1.0
scpcli searchengine cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
Description
List Clusters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Cluster name | - |
| service_state optional | string | Service state | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | 생성 시간 | 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 |
5.1.7 - List Engine Version Properties
5.1.7.1 - 1.0
scpcli searchengine engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
5.1.8 - List Engine Versions
5.1.8.1 - 1.0
scpcli searchengine engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version |
5.1.9 - List Server Types
5.1.9.1 - 1.0
scpcli searchengine engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu_core | Server type cpu core | |
| description | Server type description | |
| memory_gb | Server type memory | |
| name | Server type name | |
| product_image_type | Product image type | |
| product_type | Product type | |
| purpose | Server type purpose | |
| type | Server type class |
5.1.10 - Remove Backup Histories
5.1.10.1 - 1.0
scpcli searchengine backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
5.1.11 - Restart Cluster
5.1.11.1 - 1.0
scpcli searchengine cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.12 - Set Backup
5.1.12.1 - 1.0
scpcli searchengine backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
Description
Set Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.13 - Set Block Storage Size
5.1.13.1 - 1.0
scpcli searchengine block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.14 - Set Maintenance
5.1.14.1 - 1.0
scpcli searchengine maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| term_hour required | string | term_hour | - |
| start_time required | string | start_time | - |
| start_minute required | string | start_minute | - |
| start_day_of_week required | string | start_day_of_week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.15 - Set Security Group Rules
5.1.15.1 - 1.0
scpcli searchengine security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| add_ip_addresses optional | array | Allowed IP addresses list | - |
| del_ip_addresses optional | array | Allowed IP addresses list | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.16 - Set Server Type
5.1.16.1 - 1.0
scpcli searchengine server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.17 - Show Cluster
5.1.17.1 - 1.0
scpcli searchengine cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| block_storage_groups | Block storage groups list | |
| instances | Instances list | |
| role_type | Role type | |
| server_type_name | Server type name |
5.1.18 - Show Request
5.1.18.1 - 1.0
scpcli searchengine request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
5.1.19 - Start Cluster
5.1.19.1 - 1.0
scpcli searchengine cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.20 - Stop Cluster
5.1.20.1 - 1.0
scpcli searchengine cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.21 - Synchronize Cluster State
5.1.21.1 - 1.0
scpcli searchengine cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.22 - Terminate Cluster
5.1.22.1 - 1.0
scpcli searchengine cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
5.1.23 - Unset Backup
5.1.23.1 - 1.0
scpcli searchengine backup unset
--cluster_id <value>
Description
Unset Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
5.1.24 - Unset Maintenance
5.1.24.1 - 1.0
scpcli searchengine maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6 - Vertica(DBaaS)
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Vertica(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
6.1 - CLIs
6.1.1 - Add Block Storages
6.1.1.1 - 1.0
scpcli vertica block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| size_gb required | integer | Size in GB | 104 |
| role_type required | string | Role type | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.2 - Create Cluster
6.1.2.1 - 1.0
scpcli vertica cluster create
--starting_time_hour <value>
--retention_period_day <value>
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--license <value>]
[--nat_enabled <value>]
[--tags <value>]
[--database_locale <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_name required | string | Database Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| license optional | string | license | - |
| nat_enabled optional | boolean | NAT availability | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| database_locale optional | string | Database locale information | - |
| 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 |
6.1.3 - Create Restore Cluster
6.1.3.1 - 1.0
scpcli vertica restore create
--cluster_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--backup_history_number <value>
[--allowable_ip_addresses <value>]
[--license <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Restore Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "role_type": "ACTIVE", "server_type_name": ""}' |
| backup_history_number required | string | Backup id | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| license optional | string | license | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.4 - List Backup Histories
6.1.4.1 - 1.0
scpcli vertica backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| limit optional | integer | Number of backup lists | - |
| page optional | integer | Backup list page | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_at | Backup end time | |
| backup_history_number | Backup id | |
| backup_size_gb | Backup amount(GB) | |
| backup_start_at | Backup start time | |
| backup_state | Backup state | |
| backup_state_detail | Backup detail state | |
| software_version | Software version |
6.1.5 - List Clusters
6.1.5.1 - 1.0
scpcli vertica cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
Description
List Clusters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Cluster name | - |
| service_state optional | string | Service state | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| console_included | Management Console included state | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| database_name | Database Name | |
| instance_count | Instance Count | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| nat_enabled | NAT availability | |
| role_type | Role type | |
| service_state | Service state |
6.1.6 - List Engine Version Properties
6.1.6.1 - 1.0
scpcli vertica engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
6.1.7 - List Engine Versions
6.1.7.1 - 1.0
scpcli vertica engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version |
6.1.8 - List Server Types
6.1.8.1 - 1.0
scpcli vertica engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu_core | Server type cpu core | |
| description | Server type description | |
| memory_gb | Server type memory | |
| name | Server type name | |
| product_image_type | Product image type | |
| product_type | Product type | |
| purpose | Server type purpose | |
| type | Server type class |
6.1.9 - Remove Backup Histories
6.1.9.1 - 1.0
scpcli vertica backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
6.1.10 - Restart Cluster
6.1.10.1 - 1.0
scpcli vertica cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.11 - Set Backup
6.1.11.1 - 1.0
scpcli vertica backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
Description
Set Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.12 - Set Block Storage Size
6.1.12.1 - 1.0
scpcli vertica block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.13 - Set Maintenance
6.1.13.1 - 1.0
scpcli vertica 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.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| term_hour required | string | term_hour | - |
| start_time required | string | start_time | - |
| start_minute required | string | start_minute | - |
| start_day_of_week required | string | start_day_of_week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.14 - Set Security Group Rules
6.1.14.1 - 1.0
scpcli vertica security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| add_ip_addresses optional | array | Allowed IP addresses list | - |
| del_ip_addresses optional | array | Allowed IP addresses list | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.15 - Set Server Type
6.1.15.1 - 1.0
scpcli vertica server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.16 - Show Cluster
6.1.16.1 - 1.0
scpcli vertica cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| block_storage_groups | Block storage groups list | |
| instances | Instances list | |
| role_type | Role type | |
| server_type_name | Server type name |
6.1.17 - Show Request
6.1.17.1 - 1.0
scpcli vertica request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
6.1.18 - Start Cluster
6.1.18.1 - 1.0
scpcli vertica cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.19 - Stop Cluster
6.1.19.1 - 1.0
scpcli vertica cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.20 - Synchronize Cluster State
6.1.20.1 - 1.0
scpcli vertica cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.21 - Terminate Cluster
6.1.21.1 - 1.0
scpcli vertica cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.1.22 - Unset Backup
6.1.22.1 - 1.0
scpcli vertica backup unset
--cluster_id <value>
Description
Unset Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |