This is the multi-page printable view of this section. Click here to print.
Models
- 1: ClusterResourceCheckResponse
- 2: DataFlowBodyCreate
- 3: DataFlowBodyUpdate
- 4: DataFlowCheckDuplicationResponse
- 5: DataFlowDetailResponse
- 6: DataFlowDetailResponseV1Dot1
- 7: DataFlowImageListResponse
- 8: DataFlowImageResponse
- 9: DataFlowsConsoleResponse
- 10: DataFlowsConsoleResponseV1Dot1
- 11: DataFlowServiceCheckDuplicationResponse
- 12: DataFlowServiceCreateRequest
- 13: DataFlowServiceDetailResponse
- 14: DataFlowServiceDetailResponseV1Dot1
- 15: DataFlowServiceImageResponse
- 16: DataFlowServicesResponse
- 17: DataFlowServicesResponseV1Dot1
- 18: DataFlowServiceSubVersionResponse
- 19: DataFlowServicesUpdateRequest
- 20: DataFlowServiceUpdateResponse
- 21: DataFlowServiceValidateResourceRequest
- 22: DataFlowUpdateResponse
- 23: ListDataFlowsConsoleResponse
- 24: ListDataFlowsConsoleResponseV1Dot1
- 25: ListDataFlowServicesConsoleResponse
- 26: ListDataFlowServicesConsoleResponseV1Dot1
- 27: Tag
1 - ClusterResourceCheckResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| cpu optional | Example : CPU | object | CPU |
| err_code required | Error code Example : | string | |
| memory optional | Example : Memory | object | Memory |
| result required | Cluster resource check result Example : | boolean |
2 - DataFlowBodyCreate
| Name | Description | Schema | Default |
|---|---|---|---|
| account optional | account Example : {'account_id': '', 'account_password': ''} | any of [object, null] | |
| cluster_id required | cluster_id Example : | string | |
| data_flow_name required | data_flow_name Example : Minimum length : 3Maximum length : 30 | string | |
| description optional | description Example : | any of [string, null] | |
| domain required | domain Example : Minimum length : 3Maximum length : 50 | string | |
| dsc_domain optional | dsc_domain Example : | any of [string, null] | |
| host_alias_list required | host_alias_list Example : [{'hostnames': [''], 'ip': ''}] | array[object] | |
| image_id required | image_id Example : | string | |
| ingress_controller_name required | ingress_controller_name Example : | string | |
| instance_id optional | instance_id Example : | any of [string, null] | |
| node_selector optional | node_selector Example : | any of [string, null] | |
| storage_class_name required | storage_class_name Example : | string | |
| tags optional | tags | array[Tag] |
3 - DataFlowBodyUpdate
| Name | Description | Schema | Default |
|---|---|---|---|
| account optional | account Example : {'account_id': '', 'account_password': ''} | any of [object, null] | |
| description optional | description Example : | any of [string, null] | |
| domain optional | domain Example : | any of [string, null] | |
| host_alias_list optional | host_alias Example : [{'hostnames': [''], 'ip': ''}] | any of [array[object], null] | |
| node_selector optional | node_selector Example : | any of [string, null] |
4 - DataFlowCheckDuplicationResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| result required | Data flow check result Example : | boolean |
5 - DataFlowDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account optional | account Example : {'account_id': '', 'account_password': ''} | any of [object, null] | |
| cluster_id required | cluster_id Example : | string | |
| cluster_name optional | cluster_name Example : | string | |
| cluster_permission optional | cluster_permission Example : | any of [object, null] | |
| cluster_request_failed optional | cluster_request_failed Example : False | boolean | |
| count_data_flow_service optional | count_data_flow_service Example : | integer | |
| created_dt required | created_dt Example : | string (date-time) | |
| data_flow_id required | data_flow_id Example : | string | |
| data_flow_name required | data_flow_name Example : | string | |
| description optional | description Example : | any of [string, null] | |
| domain optional | domain Example : | any of [string, null] | |
| host_alias_list optional | host_alias Example : [{'hostnames': [''], 'ip': ''}] | any of [array[object], null] | |
| hosts_file optional | hosts_file Example : | any of [string, null] | |
| http_port optional | http_port Example : | any of [integer, null] | |
| https_port optional | https_port Example : | any of [integer, null] | |
| image_id required | image_id Example : | string | |
| ingress_class_name optional | ingress_class_name Example : | any of [string, null] | |
| instance_id required | instance_id Example : | any of [string, null] | |
| is_active_image optional | is_active_image Example : | any of [boolean, null] | |
| modified_dt required | modified_dt Example : | string (date-time) | |
| namespace_name required | namespace_name Example : | string | |
| node_selector optional | node_selector Example : | any of [string, null] | |
| state required | state Example : | string | |
| storage_class_name required | storage_class_name Example : | string | |
| version required | version Example : | string | |
| web_url optional | web_url Example : | any of [string, null] |
6 - DataFlowDetailResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account optional | account Example : {'account_id': '', 'account_password': ''} | any of [object, null] | |
| account_id required | account_id Example : | string | |
| cluster_id required | cluster_id Example : | string | |
| cluster_name optional | cluster_name Example : | string | |
| cluster_permission optional | cluster_permission Example : | any of [object, null] | |
| cluster_request_failed optional | cluster_request_failed Example : False | boolean | |
| count_data_flow_service optional | count_data_flow_service Example : | integer | |
| created_dt required | created_dt Example : | string (date-time) | |
| data_flow_id required | data_flow_id Example : | string | |
| data_flow_name required | data_flow_name Example : | string | |
| description optional | description Example : | any of [string, null] | |
| domain optional | domain Example : | any of [string, null] | |
| host_alias_list optional | host_alias Example : [{'hostnames': [''], 'ip': ''}] | any of [array[object], null] | |
| hosts_file optional | hosts_file Example : | any of [string, null] | |
| http_port optional | http_port Example : | any of [integer, null] | |
| https_port optional | https_port Example : | any of [integer, null] | |
| image_id required | image_id Example : | string | |
| ingress_class_name optional | ingress_class_name Example : | any of [string, null] | |
| instance_id required | instance_id Example : | any of [string, null] | |
| is_active_image optional | is_active_image Example : | any of [boolean, null] | |
| modified_dt required | modified_dt Example : | string (date-time) | |
| namespace_name required | namespace_name Example : | string | |
| node_selector optional | node_selector Example : | any of [string, null] | |
| state required | state Example : | string | |
| storage_class_name required | storage_class_name Example : | string | |
| version required | version Example : | string | |
| web_url optional | web_url Example : | any of [string, null] |
7 - DataFlowImageListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | List of DataFlowImage | array[DataFlowImageResponse] | |
| total_count optional | total_count Example : | integer |
8 - DataFlowImageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| image_id required | Image ID Example : | string | |
| image_name required | Image name Example : | string | |
| version required | Version Example : | string |
9 - DataFlowsConsoleResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| cluster_id required | cluster_id Example : | string | |
| cluster_name optional | cluster_name Example : | string | |
| cluster_permission optional | cluster_permission Example : | object | |
| cluster_request_failed optional | cluster_request_failed Example : False | boolean | |
| created_by required | created_by Example : | string | |
| created_dt required | created_at Example : | string (date-time) | |
| data_flow_id required | data_flow_id Example : | string | |
| data_flow_name required | data_flow_name Example : | string | |
| image_id required | image_id Example : | string | |
| instance_id required | instance_id Example : | any of [string, null] | |
| is_active_image required | is_active_image Example : | boolean | |
| modified_by required | modified_by Example : | string | |
| modified_dt required | modified_at Example : | string (date-time) | |
| namespace_name required | namespace_name Example : | string | |
| state required | state Example : | string | |
| version required | version Example : | string |
10 - DataFlowsConsoleResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | account_id Example : | string | |
| cluster_id required | cluster_id Example : | string | |
| cluster_name optional | cluster_name Example : | string | |
| cluster_permission optional | cluster_permission Example : | object | |
| cluster_request_failed optional | cluster_request_failed Example : False | boolean | |
| created_by required | created_by Example : | string | |
| created_dt required | created_at Example : | string (date-time) | |
| data_flow_id required | data_flow_id Example : | string | |
| data_flow_name required | data_flow_name Example : | string | |
| image_id required | image_id Example : | string | |
| instance_id required | instance_id Example : | any of [string, null] | |
| is_active_image required | is_active_image Example : | boolean | |
| modified_by required | modified_by Example : | string | |
| modified_dt required | modified_at Example : | string (date-time) | |
| namespace_name required | namespace_name Example : | string | |
| state required | state Example : | string | |
| version required | version Example : | string |
11 - DataFlowServiceCheckDuplicationResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| result required | Data flow service check result Example : | boolean |
12 - DataFlowServiceCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| account optional | account Example : {'account_id': '', 'account_password': ''} | any of [object, null] | |
| data_flow_id required | data_flow_id Example : | string | |
| data_flow_service_name required | data_flow_service_name Example : Pattern : ^[a-z][a-z0-9\-]*[a-z0-9]$Minimum length : 3Maximum length : 30 | string | |
| description optional | description Example : | any of [string, null] | |
| domain required | description Example : Minimum length : 3Maximum length : 50 | string | |
| host_alias required | host_alias Example : {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} | object | |
| node_selector optional | node_selector Example : | any of [string, null] | |
| service_workload required | service_workload Example : {'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'}} | object | |
| storage_class_name required | storage_class_name Example : | string | |
| tags optional | tags | array[Tag] |
13 - DataFlowServiceDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account optional | account Example : {'account_id': '', 'account_password': ''} | any of [object, null] | |
| cluster_id required | cluster_id Example : | string | |
| cluster_name optional | cluster_name Example : | string | |
| cluster_permission optional | cluster_permission Example : | any of [object, null] | |
| cluster_request_failed optional | cluster_request_failed Example : False | boolean | |
| created_dt required | created_dt Example : | string (date-time) | |
| data_flow_id required | data_flow_id Example : | string | |
| data_flow_name required | data_flow_name Example : | string | |
| data_flow_service_id required | data_flow_service_id Example : | string | |
| data_flow_service_name required | data_flow_service_name Example : | string | |
| description optional | description Example : | any of [string, null] | |
| domain optional | domain Example : | any of [string, null] | |
| host_alias optional | host_alias Example : {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} | any of [object, null] | |
| host_file_registry optional | host_file_registry Example : | any of [string, null] | |
| hosts_file optional | hosts_file Example : | any of [string, null] | |
| http_port optional | http_port Example : | any of [integer, null] | |
| https_port optional | https_port Example : | any of [integer, null] | |
| image_id required | image_id Example : | string | |
| ingress_class_name optional | ingress_class_name Example : | any of [string, null] | |
| instance_id required | instance_id Example : | any of [string, null] | |
| is_active_image optional | is_active_image Example : | any of [boolean, null] | |
| modified_dt required | modified_dt Example : | string (date-time) | |
| namespace_name required | namespace_name Example : | string | |
| node_selector optional | node_selector Example : | any of [string, null] | |
| service_workload optional | service_workload Example : | any of [object, null] | |
| state required | state Example : | string | |
| storage_class_name required | storage_class_name Example : | string | |
| version required | version Example : | string | |
| web_url_nifi optional | web_url_nifi Example : | any of [string, null] | |
| web_url_registry optional | web_url_registry Example : | any of [string, null] |
14 - DataFlowServiceDetailResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account optional | account Example : {'account_id': '', 'account_password': ''} | any of [object, null] | |
| account_id required | account_id Example : | string | |
| cluster_id required | cluster_id Example : | string | |
| cluster_name optional | cluster_name Example : | string | |
| cluster_permission optional | cluster_permission Example : | any of [object, null] | |
| cluster_request_failed optional | cluster_request_failed Example : False | boolean | |
| created_dt required | created_dt Example : | string (date-time) | |
| data_flow_id required | data_flow_id Example : | string | |
| data_flow_name required | data_flow_name Example : | string | |
| data_flow_service_id required | data_flow_service_id Example : | string | |
| data_flow_service_name required | data_flow_service_name Example : | string | |
| description optional | description Example : | any of [string, null] | |
| domain optional | domain Example : | any of [string, null] | |
| host_alias optional | host_alias Example : {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} | any of [object, null] | |
| host_file_registry optional | host_file_registry Example : | any of [string, null] | |
| hosts_file optional | hosts_file Example : | any of [string, null] | |
| http_port optional | http_port Example : | any of [integer, null] | |
| https_port optional | https_port Example : | any of [integer, null] | |
| image_id required | image_id Example : | string | |
| ingress_class_name optional | ingress_class_name Example : | any of [string, null] | |
| instance_id required | instance_id Example : | any of [string, null] | |
| is_active_image optional | is_active_image Example : | any of [boolean, null] | |
| modified_dt required | modified_dt Example : | string (date-time) | |
| namespace_name required | namespace_name Example : | string | |
| node_selector optional | node_selector Example : | any of [string, null] | |
| service_workload optional | service_workload Example : | any of [object, null] | |
| state required | state Example : | string | |
| storage_class_name required | storage_class_name Example : | string | |
| version required | version Example : | string | |
| web_url_nifi optional | web_url_nifi Example : | any of [string, null] | |
| web_url_registry optional | web_url_registry Example : | any of [string, null] |
15 - DataFlowServiceImageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| data_flow_service_count optional | DataFlowService count Example : | integer | |
| versions optional | image versions | DataFlowServiceSubVersionResponse |
16 - DataFlowServicesResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| cluster_id required | cluster_id Example : | string | |
| cluster_name optional | cluster_name Example : | string | |
| cluster_permission optional | cluster_permission Example : | any of [object, null] | |
| cluster_request_failed optional | cluster_request_failed Example : False | boolean | |
| created_by required | created_by Example : | string | |
| created_dt required | created_at Example : | string (date-time) | |
| data_flow_id required | data_flow_id Example : | string | |
| data_flow_name required | data_flow_name Example : | string | |
| data_flow_service_id required | data_flow_service_id Example : | string | |
| data_flow_service_name required | data_flow_service_name Example : | string | |
| description optional | description Example : | any of [string, null] | |
| modified_by required | modified_by Example : | string | |
| modified_dt required | modified_at Example : | string (date-time) | |
| state required | state Example : | string | |
| version required | version Example : | string |
17 - DataFlowServicesResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | account_id Example : | string | |
| cluster_id required | cluster_id Example : | string | |
| cluster_name optional | cluster_name Example : | string | |
| cluster_permission optional | cluster_permission Example : | any of [object, null] | |
| cluster_request_failed optional | cluster_request_failed Example : False | boolean | |
| created_by required | created_by Example : | string | |
| created_dt required | created_at Example : | string (date-time) | |
| data_flow_id required | data_flow_id Example : | string | |
| data_flow_name required | data_flow_name Example : | string | |
| data_flow_service_id required | data_flow_service_id Example : | string | |
| data_flow_service_name required | data_flow_service_name Example : | string | |
| description optional | description Example : | any of [string, null] | |
| modified_by required | modified_by Example : | string | |
| modified_dt required | modified_at Example : | string (date-time) | |
| state required | state Example : | string | |
| version required | version Example : | string |
18 - DataFlowServiceSubVersionResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| nifi required | nifi Example : | string | |
| nifiregistry required | nifiregistry Example : | string | |
| zookeeper required | zookeeper Example : | string |
19 - DataFlowServicesUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| account optional | account Example : {'account_id': '', 'account_password': ''} | object | |
| description optional | description Example : | any of [string, null] | |
| domain optional | domain Example : | any of [string, null] | |
| host_alias optional | host_alias Example : {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} | any of [object, null] | |
| node_selector optional | node_selector Example : | any of [string, null] | |
| service_workload optional | service_workload Example : {'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'}} | object |
20 - DataFlowServiceUpdateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account optional | account Example : {'account_id': '', 'account_password': ''} | any of [object, null] | |
| cluster_id required | cluster_id Example : | string | |
| cluster_name optional | cluster_name Example : | string | |
| cluster_permission optional | cluster_permission Example : | any of [object, null] | |
| cluster_request_failed optional | cluster_request_failed Example : False | boolean | |
| created_dt required | created_dt Example : | string (date-time) | |
| data_flow_id required | data_flow_id Example : | string | |
| data_flow_name required | data_flow_name Example : | string | |
| data_flow_service_id required | data_flow_service_id Example : | string | |
| data_flow_service_name required | data_flow_service_name Example : | string | |
| description optional | description Example : | any of [string, null] | |
| domain optional | domain Example : | any of [string, null] | |
| host_alias optional | host_alias Example : {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} | any of [object, null] | |
| host_file_registry optional | host_file_registry Example : | any of [string, null] | |
| hosts_file optional | hosts_file Example : | any of [string, null] | |
| http_port optional | http_port Example : | any of [integer, null] | |
| https_port optional | https_port Example : | any of [integer, null] | |
| image_id required | image_id Example : | string | |
| ingress_class_name optional | ingress_class_name Example : | any of [string, null] | |
| instance_id required | instance_id Example : | any of [string, null] | |
| modified_dt required | modified_dt Example : | string (date-time) | |
| namespace_name required | namespace_name Example : | string | |
| node_selector optional | node_selector Example : | any of [string, null] | |
| service_workload optional | service_workload Example : | any of [object, null] | |
| state required | state Example : | string | |
| storage_class_name required | storage_class_name Example : | string | |
| version required | version Example : | string | |
| web_url_nifi optional | web_url_nifi Example : | any of [string, null] | |
| web_url_registry optional | web_url_registry Example : | any of [string, null] |
21 - DataFlowServiceValidateResourceRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| service_workload required | service_workload Example : {'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'}} | object |
22 - DataFlowUpdateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account optional | account Example : {'account_id': '', 'account_password': ''} | any of [object, null] | |
| cluster_id required | cluster_id Example : | string | |
| cluster_name optional | cluster_name Example : | string | |
| cluster_permission optional | cluster_permission Example : | any of [object, null] | |
| cluster_request_failed optional | cluster_request_failed Example : False | boolean | |
| count_data_flow_service optional | count_data_flow_service Example : | integer | |
| created_dt required | created_dt Example : | string (date-time) | |
| data_flow_id required | data_flow_id Example : | string | |
| data_flow_name required | data_flow_name Example : | string | |
| description optional | description Example : | any of [string, null] | |
| domain optional | domain Example : | any of [string, null] | |
| host_alias_list optional | host_alias Example : [{'hostnames': [''], 'ip': ''}] | any of [array[object], null] | |
| hosts_file optional | hosts_file Example : | any of [string, null] | |
| http_port optional | http_port Example : | any of [integer, null] | |
| https_port optional | https_port Example : | any of [integer, null] | |
| image_id required | image_id Example : | string | |
| ingress_class_name optional | ingress_class_name Example : | any of [string, null] | |
| instance_id required | instance_id Example : | any of [string, null] | |
| modified_dt required | modified_dt Example : | string (date-time) | |
| namespace_name required | namespace_name Example : | string | |
| node_selector optional | node_selector Example : | any of [string, null] | |
| state required | state Example : | string | |
| storage_class_name required | storage_class_name Example : | string | |
| version required | version Example : | string | |
| web_url optional | web_url Example : | any of [string, null] |
23 - ListDataFlowsConsoleResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | contents | array[DataFlowsConsoleResponse] | |
| total_count optional | total_count Example : | integer |
24 - ListDataFlowsConsoleResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | contents | array[DataFlowsConsoleResponseV1Dot1] | |
| total_count optional | total_count Example : | integer |
25 - ListDataFlowServicesConsoleResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | array[DataFlowServicesResponse] | ||
| total_count required | total_count Example : | integer |
26 - ListDataFlowServicesConsoleResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | array[DataFlowServicesResponseV1Dot1] | ||
| total_count required | total_count Example : | integer |
27 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| tag_key required | tag_key Example : Pattern : ^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]*$Maximum length : 128 | string | |
| tag_value optional | tag_value Example : Pattern : ^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]*$Maximum length : 256 | string |