This is the multi-page printable view of this section. Click here to print.
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.2: Create Cluster
- 3.1.3: List Clusters
- 3.1.4: List Engine Version Properties
- 3.1.5: List Engine Versions
- 3.1.6: List Parameter Groups
- 3.1.7: List Parameter Values
- 3.1.8: List Parameters
- 3.1.9: List Server Types
- 3.1.10: Patch Minor Version
- 3.1.11: Restart Cluster
- 3.1.12: Set Block Storage Size
- 3.1.13: Set Maintenance
- 3.1.14: Set Parameter Values
- 3.1.15: Set Security Group Rules
- 3.1.16: Set Server Type
- 3.1.17: Show Cluster
- 3.1.18: Show Request
- 3.1.19: Start Cluster
- 3.1.20: Stop Cluster
- 3.1.21: Synchronize Cluster State
- 3.1.22: Synchronize Parameter Values
- 3.1.23: Terminate Cluster
- 3.1.24: Unset Maintenance
- 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: Patch Minor Version
- 5.1.10.1: 1.0
- 5.1.11: Remove Backup Histories
- 5.1.11.1: 1.0
- 5.1.12: Restart Cluster
- 5.1.12.1: 1.0
- 5.1.13: Restart Dashboard
- 5.1.13.1: 1.0
- 5.1.14: Set Backup
- 5.1.14.1: 1.0
- 5.1.15: Set Block Storage Size
- 5.1.15.1: 1.0
- 5.1.16: Set Maintenance
- 5.1.16.1: 1.0
- 5.1.17: Set Security Group Rules
- 5.1.17.1: 1.0
- 5.1.18: Set Server Type
- 5.1.18.1: 1.0
- 5.1.19: Show Cluster
- 5.1.19.1: 1.0
- 5.1.20: Show Request
- 5.1.20.1: 1.0
- 5.1.21: Start Cluster
- 5.1.21.1: 1.0
- 5.1.22: Stop Cluster
- 5.1.22.1: 1.0
- 5.1.23: Synchronize Cluster State
- 5.1.23.1: 1.0
- 5.1.24: Terminate Cluster
- 5.1.24.1: 1.0
- 5.1.25: Unset Backup
- 5.1.25.1: 1.0
- 5.1.26: Unset Maintenance
- 5.1.26.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
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Data Flow service and how to call CLI.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | SUPPORTED | 20260701 |
1.1 - CLIs
1.1.1 - CheckClusterResourceSizeForDataFlowServiceCreate
1.1.1.1 - 1.1
scp-cli 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.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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)
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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)
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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)
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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)
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | '{"key": "Key", "value": "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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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 | '{"key": "Key", "value": "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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | '{"key": "Key", "value": "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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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 | '{"key": "Key", "value": "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
scp-cli data-flow delete data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli data-flow delete data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli data-flow list data flow images
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Get List of Data Flow Images.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli data-flow list data flow images
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Get List of Data Flow Images.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | - |
| created_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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli data-flow show data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli data-flow show data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Data Ops service and how to call CLI.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | SUPPORTED | 20260701 |
2.1 - CLIs
2.1.1 - CheckClusterResourceSizeForDataOpsServiceCreate
2.1.1.1 - 1.1
scp-cli 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.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli data-ops check data ops name duplication
--data_ops_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
check duplication controller
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli data-ops check data ops name duplication
--data_ops_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
check duplication controller
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | '{"key": "Key", "value": "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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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 | '{"key": "Key", "value": "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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | '{"key": "Key", "value": "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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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 | '{"key": "Key", "value": "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
scp-cli data-ops delete data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete dataops v1
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli data-ops delete data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete dataops v1
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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}
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli data-ops list data ops image versions
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataops image version v1
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli data-ops list data ops image versions
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataops image version v1
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli data-ops show data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataops detail v1.1
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli data-ops show data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataops detail
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Event Streams service and how to call CLI.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | DEPRECATED | 20260531 |
CLI Version History
1.1
CLI version 1.1 release for Event Streams
Changes
- [Changed]
eventstreams create cluster- command has been changed.- Request model has been changed to
EventStreamsClusterCreateRequestV1Dot1. - The following fields are added to the request:
service_watch_log_collection
- Request model has been changed to
- [Changed]
eventstreams show cluster- command has been changed.- Response model has been changed to
EventStreamsClusterDetailResponseV1Dot1. - The following fields are added to the response:
service_watch_log_collection
- Response model has been changed to
- [New]
eventstreams patch minor version- command has been added.
1.0
Initial CLI release for Event Streams
Changes
- [New]
eventstreams add instances- command has been added. - [New]
eventstreams create cluster- command has been added. - [New]
eventstreams delete cluster- command has been added. - [New]
eventstreams list clusters- command has been added. - [New]
eventstreams list engine version properties- command has been added. - [New]
eventstreams list engine versions- command has been added. - [New]
eventstreams list parameter groups- command has been added. - [New]
eventstreams list parameter values- command has been added. - [New]
eventstreams list parameters- command has been added. - [New]
eventstreams list server types- command has been added. - [New]
eventstreams restart cluster- command has been added. - [New]
eventstreams set block storage size- command has been added. - [New]
eventstreams set maintenance- command has been added. - [New]
eventstreams set parameter values- command has been added. - [New]
eventstreams set security group rules- command has been added. - [New]
eventstreams set server type- command has been added. - [New]
eventstreams show cluster- command has been added. - [New]
eventstreams show request- command has been added. - [New]
eventstreams start cluster- command has been added. - [New]
eventstreams stop cluster- command has been added. - [New]
eventstreams sync cluster state- command has been added. - [New]
eventstreams sync parameter values- command has been added. - [New]
eventstreams unset maintenance- command has been added.
3.1 - CLIs
3.1.1 - Add Instances
3.1.1.1 - 1.1
scp-cli eventstreams instance add
--cluster_id <value>
--service_ip_addresses <value>
--instance_count <value>
[--public_ip_ids <value>]
Description
Add Instances.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| service_ip_addresses required | array | User subnet IP address | - |
| instance_count required | integer | Instance Count | - |
| public_ip_ids optional | array | Public IP ID List | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.1.2 - 1.0
scp-cli eventstreams instance add
--cluster_id <value>
--service_ip_addresses <value>
--instance_count <value>
[--public_ip_ids <value>]
Description
Add Instances.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| service_ip_addresses required | array | User subnet IP address | - |
| instance_count required | integer | Instance Count | - |
| public_ip_ids optional | array | Public IP ID List | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.2 - Create Cluster
3.1.2.1 - 1.1
scp-cli eventstreams cluster create
--zookeeper_sasl_password <value>
--zookeeper_sasl_id <value>
--broker_sasl_password <value>
--broker_sasl_id <value>
--timezone <value>
--subnet_id <value>
--service_watch_log_collection <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--akhq_enabled <value>]
[--allowable_ip_addresses <value>]
[--is_combined <value>]
[--nat_enabled <value>]
[--tags <value>]
[--akhq_id <value>]
[--akhq_password <value>]
[--broker_port <value>]
[--zookeeper_port <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| zookeeper_sasl_password required | string | zookeeper sasl password | - |
| zookeeper_sasl_id required | string | zookeeper sasl id | - |
| broker_sasl_password required | string | broker sasl password | - |
| broker_sasl_id required | string | broker sasl id | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| service_watch_log_collection required | boolean | ServiceWatch log collection | True |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | 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 | 5 |
| starting_day_of_week optional | string | Starting day of week | MON |
| starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.2.2 - 1.0
scp-cli eventstreams cluster create
--zookeeper_sasl_password <value>
--zookeeper_sasl_id <value>
--broker_sasl_password <value>
--broker_sasl_id <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--akhq_enabled <value>]
[--allowable_ip_addresses <value>]
[--is_combined <value>]
[--nat_enabled <value>]
[--tags <value>]
[--akhq_id <value>]
[--akhq_password <value>]
[--broker_port <value>]
[--zookeeper_port <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| zookeeper_sasl_password required | string | zookeeper sasl password | - |
| zookeeper_sasl_id required | string | zookeeper sasl id | - |
| broker_sasl_password required | string | broker sasl password | - |
| broker_sasl_id required | string | broker sasl id | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | 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 | 5 |
| starting_day_of_week optional | string | Starting day of week | MON |
| starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.3 - List Clusters
3.1.3.1 - 1.1
scp-cli eventstreams cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
Description
List Clusters.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Cluster name | - |
| service_state optional | string | Service state | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ha_enabled | HA availability | |
| instance_count | Instance Count | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| role_type | Role type | |
| service_state | Service state |
3.1.3.2 - 1.0
scp-cli eventstreams cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
Description
List Clusters.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Cluster name | - |
| service_state optional | string | Service state | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ha_enabled | HA availability | |
| instance_count | Instance Count | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| role_type | Role type | |
| service_state | Service state |
3.1.4 - List Engine Version Properties
3.1.4.1 - 1.1
scp-cli eventstreams engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
3.1.4.2 - 1.0
scp-cli eventstreams engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
3.1.5 - List Engine Versions
3.1.5.1 - 1.1
scp-cli eventstreams engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version |
3.1.5.2 - 1.0
scp-cli eventstreams engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version |
3.1.6 - List Parameter Groups
3.1.6.1 - 1.1
scp-cli eventstreams parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| major_version optional | string | Software major version | - |
| product_image_type optional | string | Product image type | - |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter group ID | |
| major_version | Software major version | |
| name | Parameter group name | |
| product_image_type | Product image type | |
| product_type | Product type |
3.1.6.2 - 1.0
scp-cli eventstreams parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| major_version optional | string | Software major version | - |
| product_image_type optional | string | Product image type | - |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter group ID | |
| major_version | Software major version | |
| name | Parameter group name | |
| product_image_type | Product image type | |
| product_type | Product type |
3.1.7 - List Parameter Values
3.1.7.1 - 1.1
scp-cli eventstreams parameter value list
--cluster_id <value>
Description
List Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| allows_value | Parameter allows value | |
| applied_value | Parameter applied value | |
| apply_type | Parameter apply type | |
| data_type | Parameter data type | |
| default_value | Parameter default value | |
| description | Parameter description | |
| is_modifiable | Parameter is_modifiable | |
| name | Parameter name | |
| software_type | Parameter software type |
3.1.7.2 - 1.0
scp-cli eventstreams parameter value list
--cluster_id <value>
Description
List Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| allows_value | Parameter allows value | |
| applied_value | Parameter applied value | |
| apply_type | Parameter apply type | |
| data_type | Parameter data type | |
| default_value | Parameter default value | |
| description | Parameter description | |
| is_modifiable | Parameter is_modifiable | |
| name | Parameter name | |
| software_type | Parameter software type |
3.1.8 - List Parameters
3.1.8.1 - 1.1
scp-cli eventstreams parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_parameter_group_id required | string | Parameter group ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| dbaas_parameter_group_id | Parameter id | |
| default_value | Parameter default value | |
| description | Parameter description | |
| name | Parameter name | |
| software_type | Parameter software type |
3.1.8.2 - 1.0
scp-cli eventstreams parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_parameter_group_id required | string | Parameter group ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| dbaas_parameter_group_id | Parameter id | |
| default_value | Parameter default value | |
| description | Parameter description | |
| name | Parameter name | |
| software_type | Parameter software type |
3.1.9 - List Server Types
3.1.9.1 - 1.1
scp-cli eventstreams engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu_core | Server type cpu core | |
| description | Server type description | |
| memory_gb | Server type memory | |
| name | Server type name | |
| product_image_type | Product image type | |
| product_type | Product type | |
| purpose | Server type purpose | |
| type | Server type class |
3.1.9.2 - 1.0
scp-cli eventstreams engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu_core | Server type cpu core | |
| description | Server type description | |
| memory_gb | Server type memory | |
| name | Server type name | |
| product_image_type | Product image type | |
| product_type | Product type | |
| purpose | Server type purpose | |
| type | Server type class |
3.1.10 - Patch Minor Version
3.1.10.1 - 1.1
scp-cli eventstreams minor version patch
--cluster_id <value>
--software_version <value>
--dbaas_engine <value>
Description
Patch Minor Version.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| dbaas_engine required | string | dbaas_engine | - |
3.1.10.2 - 1.0
scp-cli eventstreams minor version patch
--cluster_id <value>
--software_version <value>
--dbaas_engine <value>
Description
Patch Minor Version.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| dbaas_engine required | string | dbaas_engine | - |
3.1.11 - Restart Cluster
3.1.11.1 - 1.1
scp-cli eventstreams cluster restart
--cluster_id <value>
Description
Restart Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.11.2 - 1.0
scp-cli eventstreams cluster restart
--cluster_id <value>
Description
Restart Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.12 - Set Block Storage Size
3.1.12.1 - 1.1
scp-cli eventstreams block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.12.2 - 1.0
scp-cli eventstreams block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.13 - Set Maintenance
3.1.13.1 - 1.1
scp-cli eventstreams maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| term_hour required | string | term_hour | - |
| start_time required | string | start_time | - |
| start_minute required | string | start_minute | - |
| start_day_of_week required | string | start_day_of_week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.13.2 - 1.0
scp-cli eventstreams maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| term_hour required | string | term_hour | - |
| start_time required | string | start_time | - |
| start_minute required | string | start_minute | - |
| start_day_of_week required | string | start_day_of_week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.14 - Set Parameter Values
3.1.14.1 - 1.1
scp-cli eventstreams parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
3.1.14.2 - 1.0
scp-cli eventstreams parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
3.1.15 - Set Security Group Rules
3.1.15.1 - 1.1
scp-cli eventstreams security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| add_ip_addresses optional | array | Allowed IP addresses list | - |
| del_ip_addresses optional | array | Allowed IP addresses list | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.15.2 - 1.0
scp-cli eventstreams security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| add_ip_addresses optional | array | Allowed IP addresses list | - |
| del_ip_addresses optional | array | Allowed IP addresses list | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.16 - Set Server Type
3.1.16.1 - 1.1
scp-cli eventstreams server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.16.2 - 1.0
scp-cli eventstreams server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.17 - Show Cluster
3.1.17.1 - 1.1
scp-cli eventstreams cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| allowable_ip_addresses | Allowed IP addresses list | [] |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| dbaas_engine | DBaaS engine | |
| dbaas_engine_version_name | DBaaS engine version name | |
| init_config_option | DB initial configuration option | |
| instance_count | Instance Count | |
| instance_groups | Instance groups list | [] |
| is_combined | Master Data server separation state | |
| maintenance_option | Maintenance option | {} |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| nat_enabled | NAT availability | |
| product_image_type | Product image type | |
| product_type | Product type | Event Streams |
| role_type | Role type | {} |
| service_state | Service state | |
| service_watch_log_collection | ServiceWatch log collection | |
| software_version | Software version | |
| subnet_id | Subnet ID | |
| timezone | Timezone |
3.1.17.2 - 1.0
scp-cli eventstreams cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| allowable_ip_addresses | Allowed IP addresses list | [] |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| dbaas_engine | DBaaS engine | |
| dbaas_engine_version_name | DBaaS engine version name | |
| init_config_option | DB initial configuration option | |
| instance_count | Instance Count | |
| instance_groups | Instance groups list | [] |
| is_combined | Master Data server separation state | |
| maintenance_option | Maintenance option | {} |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| nat_enabled | NAT availability | |
| product_image_type | Product image type | |
| product_type | Product type | Event Streams |
| role_type | Role type | {} |
| service_state | Service state | |
| software_version | Software version | |
| subnet_id | Subnet ID | |
| timezone | Timezone |
3.1.18 - Show Request
3.1.18.1 - 1.1
scp-cli eventstreams request show
--request_id <value>
Description
Show Request.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
3.1.18.2 - 1.0
scp-cli eventstreams request show
--request_id <value>
Description
Show Request.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
3.1.19 - Start Cluster
3.1.19.1 - 1.1
scp-cli eventstreams cluster start
--cluster_id <value>
Description
Start Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.19.2 - 1.0
scp-cli eventstreams cluster start
--cluster_id <value>
Description
Start Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.20 - Stop Cluster
3.1.20.1 - 1.1
scp-cli eventstreams cluster stop
--cluster_id <value>
Description
Stop Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.20.2 - 1.0
scp-cli eventstreams cluster stop
--cluster_id <value>
Description
Stop Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.21 - Synchronize Cluster State
3.1.21.1 - 1.1
scp-cli eventstreams cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.21.2 - 1.0
scp-cli eventstreams cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.22 - Synchronize Parameter Values
3.1.22.1 - 1.1
scp-cli eventstreams parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.22.2 - 1.0
scp-cli eventstreams parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.23 - Terminate Cluster
3.1.23.1 - 1.1
scp-cli eventstreams cluster delete
--cluster_id <value>
Description
Terminate Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
3.1.23.2 - 1.0
scp-cli eventstreams cluster delete
--cluster_id <value>
Description
Terminate Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
3.1.24 - Unset Maintenance
3.1.24.1 - 1.1
scp-cli eventstreams maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
3.1.24.2 - 1.0
scp-cli eventstreams maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
4 - Quick Query
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Quick Query service and how to call CLI.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | SUPPORTED | 20260701 |
4.1 - CLIs
4.1.1 - CheckClusterResourceSizeForQuickQuery
4.1.1.1 - 1.1
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 |
|---|---|---|
| min_spec_node_pool | min_spec_node_pool | [] |
| result | result |
4.1.1.2 - 1.0
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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 |
|---|---|---|
| min_spec_node_pool | min_spec_node_pool | [] |
| result | result |
4.1.2 - CheckDuplicationQuickQueryName
4.1.2.1 - 1.1
scp-cli quick-query check quick query duplication
--quick_query_name <value>
Description
Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_name required | string | quick query name | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | result |
4.1.2.2 - 1.0
scp-cli quick-query check quick query duplication
--quick_query_name <value>
Description
Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_name required | string | quick query name | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | result |
4.1.3 - CreateQuickQuery
4.1.3.1 - 1.1
scp-cli 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>
[--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>]
[--tags <value>]
[--kubernetes_engine_create_request_tags <value>]
Description
Create Quick Query.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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": ""}' |
| 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 | - |
| tags optional | array | tags | '{"key": "Key", "value": "Value"}' |
| kubernetes_engine_create_request_tags optional | array | tags | '{"key": "Key", "value": "Value"}' |
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
scp-cli 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>
[--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>]
[--tags <value>]
[--kubernetes_engine_create_request_tags <value>]
Description
Create Quick Query.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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": ""}' |
| 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 | - |
| tags optional | array | tags | '{"key": "Key", "value": "Value"}' |
| kubernetes_engine_create_request_tags optional | array | tags | '{"key": "Key", "value": "Value"}' |
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
scp-cli quick-query delete quick query
--quick_query_id <value>
Description
delete quick query
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
4.1.4.2 - 1.0
scp-cli quick-query delete quick query
--quick_query_id <value>
Description
delete quick query
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli 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
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli quick-query list quick query images
Description
get quick query image versions
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli quick-query list quick query images
Description
get quick query image versions
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli quick-query show quick query
--quick_query_id <value>
Description
Get Quick Query details.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | {} |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| description | description | |
| domain | domain | |
| dsc_console_domain | dsc_console_domain | |
| dsc_domain | dsc_domain | |
| dsc_oidc_domain | dsc_oidc_domain | |
| host_alias_list | domain | [] |
| hosts_file | hosts_file | |
| is_active_image | is_active_image | |
| is_engine_type_private | is_engine_type_private | |
| max_query | max_query | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_information | node_information | [] |
| provisioning_state | provisioning_state | |
| query_engine_spec | query_engine_spec | {} |
| 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.7.2 - 1.0
scp-cli quick-query show quick query
--quick_query_id <value>
Description
Get Quick Query details.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | {} |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| description | description | |
| domain | domain | |
| dsc_console_domain | dsc_console_domain | |
| dsc_domain | dsc_domain | |
| dsc_oidc_domain | dsc_oidc_domain | |
| host_alias_list | domain | [] |
| hosts_file | hosts_file | |
| is_active_image | is_active_image | |
| is_engine_type_private | is_engine_type_private | |
| max_query | max_query | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_information | node_information | [] |
| provisioning_state | provisioning_state | |
| query_engine_spec | query_engine_spec | {} |
| 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.8 - UpdateQuickQueryDescription
4.1.8.1 - 1.1
scp-cli quick-query update quick query description
--quick_query_id <value>
--description <value>
Description
update quick query description
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli quick-query update quick query description
--quick_query_id <value>
--description <value>
Description
update quick query description
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli quick-query update quick query domain
--quick_query_id <value>
--domain <value>
Description
update quick query domain
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli quick-query update quick query domain
--quick_query_id <value>
--domain <value>
Description
update quick query domain
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli quick-query update quick query dsc domain
--quick_query_id <value>
--dsc_domain <value>
Description
update quick query dsc domain
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli quick-query update quick query dsc domain
--quick_query_id <value>
--dsc_domain <value>
Description
update quick query dsc domain
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli quick-query update quick query engine
--quick_query_id <value>
--replica <value>
--memory <value>
--cpu <value>
[--cluster_size <value>]
Description
update quick query engine
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli quick-query update quick query engine
--quick_query_id <value>
--replica <value>
--memory <value>
--cpu <value>
[--cluster_size <value>]
Description
update quick query engine
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
scp-cli quick-query update quick query host alias
--quick_query_id <value>
[--host_alias_list <value>]
Description
update quick query host alias
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli quick-query update quick query host alias
--quick_query_id <value>
[--host_alias_list <value>]
Description
update quick query host alias
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 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
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Search Engine service and how to call CLI.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.0 | CURRENT | - |
CLI Version History
1.0
Initial CLI release for Search Engine
Changes
- [New]
searchengine add block storages- command has been added. - [New]
searchengine add instances- command has been added. - [New]
searchengine create cluster- command has been added. - [New]
searchengine create restore- command has been added. - [New]
searchengine delete cluster- command has been added. - [New]
searchengine list backup histories- command has been added. - [New]
searchengine list clusters- command has been added. - [New]
searchengine list engine version properties- command has been added. - [New]
searchengine list engine versions- command has been added. - [New]
searchengine list server types- command has been added. - [New]
searchengine remove backup histories- command has been added. - [New]
searchengine restart cluster- command has been added. - [New]
searchengine restart dashboard- command has been added. - [New]
searchengine set backup- command has been added. - [New]
searchengine set block storage size- command has been added. - [New]
searchengine set maintenance- command has been added. - [New]
searchengine set security group rules- command has been added. - [New]
searchengine set server type- command has been added. - [New]
searchengine show cluster- command has been added. - [New]
searchengine show request- command has been added. - [New]
searchengine start cluster- command has been added. - [New]
searchengine stop cluster- command has been added. - [New]
searchengine sync cluster state- command has been added. - [New]
searchengine unset backup- command has been added. - [New]
searchengine unset maintenance- command has been added.
5.1 - CLIs
5.1.1 - Add Block Storages
5.1.1.1 - 1.0
scp-cli searchengine block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | OS |
| 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
scp-cli searchengine instance add
--cluster_id <value>
--service_ip_addresses <value>
--instance_count <value>
[--public_ip_ids <value>]
Description
Add Instances.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.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
scp-cli searchengine cluster create
--starting_time_hour <value>
--retention_period_day <value>
--database_user_password <value>
--database_user_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--is_combined <value>]
[--license <value>]
[--nat_enabled <value>]
[--tags <value>]
[--database_port <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | 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 | 5 |
| starting_day_of_week optional | string | Starting day of week | MON |
| starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.4 - Create Restore Cluster
5.1.4.1 - 1.0
scp-cli searchengine restore create
--cluster_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--backup_history_number <value>
[--allowable_ip_addresses <value>]
[--license <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Restore Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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": "OS", "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 | 5 |
| starting_day_of_week optional | string | Starting day of week | MON |
| starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.5 - List Backup Histories
5.1.5.1 - 1.0
scp-cli searchengine backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli searchengine cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
Description
List Clusters.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Cluster name | - |
| service_state optional | string | Service state | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ha_enabled | HA availability | |
| instance_count | Instance Count | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| role_type | Role type | |
| service_state | Service state |
5.1.7 - List Engine Version Properties
5.1.7.1 - 1.0
scp-cli searchengine engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli searchengine engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli searchengine engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 - Patch Minor Version
5.1.10.1 - 1.0
scp-cli searchengine minor version patch
--cluster_id <value>
--software_version <value>
--dbaas_engine <value>
Description
Patch Minor Version.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| dbaas_engine required | string | dbaas_engine | - |
5.1.11 - Remove Backup Histories
5.1.11.1 - 1.0
scp-cli searchengine backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
5.1.12 - Restart Cluster
5.1.12.1 - 1.0
scp-cli searchengine cluster restart
--cluster_id <value>
Description
Restart Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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.13 - Restart Dashboard
5.1.13.1 - 1.0
scp-cli searchengine dashboard restart
--cluster_id <value>
Description
Restart Dashboard.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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.14 - Set Backup
5.1.14.1 - 1.0
scp-cli searchengine backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
Description
Set Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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.15 - Set Block Storage Size
5.1.15.1 - 1.0
scp-cli searchengine block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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.16 - Set Maintenance
5.1.16.1 - 1.0
scp-cli searchengine maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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.17 - Set Security Group Rules
5.1.17.1 - 1.0
scp-cli searchengine security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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.18 - Set Server Type
5.1.18.1 - 1.0
scp-cli searchengine server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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.19 - Show Cluster
5.1.19.1 - 1.0
scp-cli searchengine cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| allowable_ip_addresses | Allowed IP addresses list | [] |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| dbaas_engine | DBaaS engine | |
| dbaas_engine_version_name | DBaaS engine version name | |
| init_config_option | DB initial configuration option | |
| instance_count | Instance Count | |
| instance_groups | Instance groups list | [] |
| is_combined | Master Data server separation state | |
| license | Maintenance option | {} |
| maintenance_option | Maintenance option | {} |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| nat_enabled | NAT availability | |
| product_image_type | Product image type | |
| product_type | Product type | Search Engine |
| service_state | Service state | |
| software_version | Software version | |
| subnet_id | Subnet ID | |
| timezone | Timezone |
5.1.20 - Show Request
5.1.20.1 - 1.0
scp-cli searchengine request show
--request_id <value>
Description
Show Request.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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.21 - Start Cluster
5.1.21.1 - 1.0
scp-cli searchengine cluster start
--cluster_id <value>
Description
Start Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 - Stop Cluster
5.1.22.1 - 1.0
scp-cli searchengine cluster stop
--cluster_id <value>
Description
Stop Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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.23 - Synchronize Cluster State
5.1.23.1 - 1.0
scp-cli searchengine cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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.24 - Terminate Cluster
5.1.24.1 - 1.0
scp-cli searchengine cluster delete
--cluster_id <value>
Description
Terminate Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
5.1.25 - Unset Backup
5.1.25.1 - 1.0
scp-cli searchengine backup unset
--cluster_id <value>
Description
Unset Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
5.1.26 - Unset Maintenance
5.1.26.1 - 1.0
scp-cli searchengine maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6 - Vertica(DBaaS)
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Vertica(DBaaS) service and how to call CLI.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.0 | CURRENT | - |
CLI Version History
1.0
Initial CLI release for Vertica(DBaaS)
Changes
- [New]
vertica add block storages- command has been added. - [New]
vertica create cluster- command has been added. - [New]
vertica create restore- command has been added. - [New]
vertica delete cluster- command has been added. - [New]
vertica list backup histories- command has been added. - [New]
vertica list clusters- command has been added. - [New]
vertica list engine version properties- command has been added. - [New]
vertica list engine versions- command has been added. - [New]
vertica list server types- command has been added. - [New]
vertica remove backup histories- command has been added. - [New]
vertica restart cluster- command has been added. - [New]
vertica set backup- command has been added. - [New]
vertica set block storage size- command has been added. - [New]
vertica set maintenance- command has been added. - [New]
vertica set security group rules- command has been added. - [New]
vertica set server type- command has been added. - [New]
vertica show cluster- command has been added. - [New]
vertica show request- command has been added. - [New]
vertica start cluster- command has been added. - [New]
vertica stop cluster- command has been added. - [New]
vertica sync cluster state- command has been added. - [New]
vertica unset backup- command has been added. - [New]
vertica unset maintenance- command has been added.
6.1 - CLIs
6.1.1 - Add Block Storages
6.1.1.1 - 1.0
scp-cli vertica block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | OS |
| 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
scp-cli 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.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | 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 | 5 |
| starting_day_of_week optional | string | Starting day of week | MON |
| starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.3 - Create Restore Cluster
6.1.3.1 - 1.0
scp-cli 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.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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": "OS", "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 | 5 |
| starting_day_of_week optional | string | Starting day of week | MON |
| starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.4 - List Backup Histories
6.1.4.1 - 1.0
scp-cli vertica backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli vertica cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
Description
List Clusters.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| database_name | Database Name | |
| instance_count | Instance Count | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | 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
scp-cli vertica engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli vertica engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli vertica engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli vertica backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli vertica cluster restart
--cluster_id <value>
Description
Restart Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli vertica backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
Description
Set Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli vertica block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli vertica maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.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
scp-cli vertica security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.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
scp-cli vertica server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli vertica cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| allowable_ip_addresses | Allowed IP addresses list | [] |
| console_included | Management Console included state | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| dbaas_engine | DBaaS engine | Vertica |
| dbaas_engine_version_name | DBaaS engine version name | 09c2fe88089040ffa035604e38f7e4e9 |
| init_config_option | DB initial configuration option | |
| instance_count | Instance Count | |
| instance_groups | Instance groups list | [] |
| maintenance_option | Maintenance option | {} |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| nat_enabled | NAT availability | |
| product_type | Product type | Vertica |
| role_type | Role type | {} |
| service_state | Service state | |
| software_version | Software version | |
| subnet_id | Subnet ID | |
| timezone | Timezone |
6.1.17 - Show Request
6.1.17.1 - 1.0
scp-cli vertica request show
--request_id <value>
Description
Show Request.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli vertica cluster start
--cluster_id <value>
Description
Start Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli vertica cluster stop
--cluster_id <value>
Description
Stop Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli vertica cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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
scp-cli vertica cluster delete
--cluster_id <value>
Description
Terminate Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.1.22 - Unset Backup
6.1.22.1 - 1.0
scp-cli vertica backup unset
--cluster_id <value>
Description
Unset Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |