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
| Version | Status | Supported Until |
|---|
This is the multi-page printable view of this section. Click here to print.
Data Flow
- 1: CLIs
- 1.1: CheckClusterResourceSizeForDataFlowServiceCreate
- 1.2: CheckClusterResourceSizeForDataFlowServiceUpdate
- 1.3: CheckDataFlowNameDuplication
- 1.4: CheckDataFlowServiceNameDuplication
- 1.5: CreateDataFlow
- 1.6: CreateDataFlowService
- 1.7: DeleteDataFlow
- 1.8: DeleteDataFlowService
- 1.9: ListDataFlowImages
- 1.10: ListDataFlows
- 1.11: ListDataFlowService
- 1.12: ShowDataFlow
- 1.13: ShowDataFlowService
- 1.14: ShowDataFlowServiceSubVersions
- 1.15: UpdateDataFlow
- 1.16: UpdateDataFlowService
1 - CLIs
1.1 - CheckClusterResourceSizeForDataFlowServiceCreate
1.1.1 - 1.1
scpcli data-flow check cluster resource size for data flow service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Flow Service Creation.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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.2 - 1.0
scpcli data-flow check cluster resource size for data flow service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Flow Service Creation.
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 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.2 - CheckClusterResourceSizeForDataFlowServiceUpdate
1.2.1 - 1.1
scpcli data-flow check cluster resource size for data flow service update
--data_flow_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Flow Service Update.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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.2.2 - 1.0
scpcli data-flow check cluster resource size for data flow service update
--data_flow_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Flow Service Update.
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 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.3 - CheckDataFlowNameDuplication
1.3.1 - 1.1
scpcli data-flow check data flow name duplication
--data_flow_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Check Duplication Data Flow Name. (false: no duplicate value, true: duplicate value)
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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.3.2 - 1.0
scpcli data-flow check data flow name duplication
--data_flow_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Check Duplication Data Flow Name. (false: no duplicate value, true: duplicate value)
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 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.4 - CheckDataFlowServiceNameDuplication
1.4.1 - 1.1
scpcli data-flow check data flow service name duplication
--data_flow_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Check Duplication Data Flow Service Name. (false: no duplicate value, true: duplicate value)
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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.4.2 - 1.0
scpcli data-flow check data flow service name duplication
--data_flow_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Check Duplication Data Flow Service Name. (false: no duplicate value, true: duplicate value)
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 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.5 - CreateDataFlow
1.5.1 - 1.1
scpcli data-flow create data flow
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_flow_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
create data flow
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| ingress_controller_name required | string | ingress_controller_name | - |
| image_id required | string | image_id | - |
| host_alias_list required | array | host_alias_list | {'hostnames': [''], 'ip': ''} |
| domain required | string | domain | - |
| data_flow_name required | string | data_flow_name | - |
| cluster_id required | string | cluster_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| dsc_domain optional | string | dsc_domain | - |
| instance_id optional | string | instance_id | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
1.5.2 - 1.0
scpcli data-flow create data flow
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_flow_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
create data flow
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| ingress_controller_name required | string | ingress_controller_name | - |
| image_id required | string | image_id | - |
| host_alias_list required | array | host_alias_list | {'hostnames': [''], 'ip': ''} |
| domain required | string | domain | - |
| data_flow_name required | string | data_flow_name | - |
| cluster_id required | string | cluster_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| dsc_domain optional | string | dsc_domain | - |
| instance_id optional | string | instance_id | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
1.6 - CreateDataFlowService
1.6.1 - 1.1
scpcli data-flow create data flow service
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_flow_service_name <value>
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Create dataflow service console
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| service_workload required | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| host_alias required | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| domain required | string | description | - |
| data_flow_service_name required | string | data_flow_service_name | - |
| data_flow_id required | string | data_flow_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
1.6.2 - 1.0
scpcli data-flow create data flow service
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_flow_service_name <value>
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Create dataflow service console
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| service_workload required | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| host_alias required | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| domain required | string | description | - |
| data_flow_service_name required | string | data_flow_service_name | - |
| data_flow_id required | string | data_flow_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
1.7 - DeleteDataFlow
1.7.1 - 1.1
scpcli data-flow delete data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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.7.2 - 1.0
scpcli data-flow delete data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 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.8 - DeleteDataFlowService
1.8.1 - 1.1
scpcli data-flow delete data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete dataflow service console
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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.8.2 - 1.0
scpcli data-flow delete data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete dataflow service console
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 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.9 - ListDataFlowImages
1.9.1 - 1.1
scpcli data-flow list data flow images
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Get List of Data Flow Images.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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.9.2 - 1.0
scpcli data-flow list data flow images
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Get List of Data Flow Images.
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 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.10 - ListDataFlows
1.10.1 - 1.1
scpcli data-flow list data flow
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataflow_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_flow_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataflow list console v1.1
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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.10.2 - 1.0
scpcli data-flow list data flow
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataflow_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_flow_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataflow list console
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 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.11 - ListDataFlowService
1.11.1 - 1.1
scpcli data-flow list data flow service
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--state <value>]
[--data_flow_service_name <value>]
[--data_flow_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataflow service list console v1.1
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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.11.2 - 1.0
scpcli data-flow list data flow service
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--state <value>]
[--data_flow_service_name <value>]
[--data_flow_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataflow service list console
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 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.12 - ShowDataFlow
1.12.1 - 1.1
scpcli data-flow show data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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.12.2 - 1.0
scpcli data-flow show data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 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.13 - ShowDataFlowService
1.13.1 - 1.1
scpcli data-flow show data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
GET dataflow service console v1.1
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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.13.2 - 1.0
scpcli data-flow show data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
GET dataflow service console
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 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.14 - ShowDataFlowServiceSubVersions
1.14.1 - 1.1
scpcli data-flow show data flow service sub versions
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Get List of Data Flow Service Versions.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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.14.2 - 1.0
scpcli data-flow show data flow service sub versions
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Get List of Data Flow Service Versions.
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 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.15 - UpdateDataFlow
1.15.1 - 1.1
scpcli data-flow update data flow
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update data flow by flow id
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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.15.2 - 1.0
scpcli data-flow update data flow
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update data flow by flow id
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 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.16 - UpdateDataFlowService
1.16.1 - 1.1
scpcli data-flow update data flow service
--data_flow_service_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update dataflow service console
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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.16.2 - 1.0
scpcli data-flow update data flow service
--data_flow_service_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update dataflow service console
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 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 | - |