Data Analytics

1 - Data Flow

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Data Flow 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until

1.1 - CLIs

1.1.1 - CheckClusterResourceSizeForDataFlowServiceCreate

1.1.1.1 - 1.1

scpcli data-flow check cluster resource size for data flow service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Flow Service Creation.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
service_workload
required
objectservice_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
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

1.1.1.2 - 1.0

scpcli data-flow check cluster resource size for data flow service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Flow Service Creation.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
service_workload
required
objectservice_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
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

1.1.2 - CheckClusterResourceSizeForDataFlowServiceUpdate

1.1.2.1 - 1.1

scpcli data-flow check cluster resource size for data flow service update
--data_flow_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Flow Service Update.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
service_workload
required
objectservice_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
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

1.1.2.2 - 1.0

scpcli data-flow check cluster resource size for data flow service update
--data_flow_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Flow Service Update.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
service_workload
required
objectservice_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
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

1.1.3 - CheckDataFlowNameDuplication

1.1.3.1 - 1.1

scpcli data-flow check data flow name duplication
--data_flow_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Check Duplication Data Flow Name. (false: no duplicate value, true: duplicate value)

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_name
required
stringData flow name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
resultData flow check result

1.1.3.2 - 1.0

scpcli data-flow check data flow name duplication
--data_flow_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Check Duplication Data Flow Name. (false: no duplicate value, true: duplicate value)

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_name
required
stringData flow name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
resultData flow check result

1.1.4 - CheckDataFlowServiceNameDuplication

1.1.4.1 - 1.1

scpcli data-flow check data flow service name duplication
--data_flow_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Check Duplication Data Flow Service Name. (false: no duplicate value, true: duplicate value)

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_service_name
required
stringData flow service name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
resultData flow service check result

1.1.4.2 - 1.0

scpcli data-flow check data flow service name duplication
--data_flow_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Check Duplication Data Flow Service Name. (false: no duplicate value, true: duplicate value)

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_service_name
required
stringData flow service name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
resultData flow service check result

1.1.5 - CreateDataFlow

1.1.5.1 - 1.1

scpcli data-flow create data flow
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_flow_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

create data flow

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
storage_class_name
required
stringstorage_class_name-
ingress_controller_name
required
stringingress_controller_name-
image_id
required
stringimage_id-
host_alias_list
required
arrayhost_alias_list{'hostnames': [''], 'ip': ''}
domain
required
stringdomain-
data_flow_name
required
stringdata_flow_name-
cluster_id
required
stringcluster_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
dsc_domain
optional
stringdsc_domain-
instance_id
optional
stringinstance_id-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

1.1.5.2 - 1.0

scpcli data-flow create data flow
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_flow_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

create data flow

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
storage_class_name
required
stringstorage_class_name-
ingress_controller_name
required
stringingress_controller_name-
image_id
required
stringimage_id-
host_alias_list
required
arrayhost_alias_list{'hostnames': [''], 'ip': ''}
domain
required
stringdomain-
data_flow_name
required
stringdata_flow_name-
cluster_id
required
stringcluster_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
dsc_domain
optional
stringdsc_domain-
instance_id
optional
stringinstance_id-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

1.1.6 - CreateDataFlowService

1.1.6.1 - 1.1

scpcli data-flow create data flow service
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_flow_service_name <value>
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Create dataflow service console

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
storage_class_name
required
stringstorage_class_name-
service_workload
required
objectservice_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
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
domain
required
stringdescription-
data_flow_service_name
required
stringdata_flow_service_name-
data_flow_id
required
stringdata_flow_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

1.1.6.2 - 1.0

scpcli data-flow create data flow service
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_flow_service_name <value>
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Create dataflow service console

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
storage_class_name
required
stringstorage_class_name-
service_workload
required
objectservice_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
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
domain
required
stringdescription-
data_flow_service_name
required
stringdata_flow_service_name-
data_flow_id
required
stringdata_flow_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

1.1.7 - DeleteDataFlow

1.1.7.1 - 1.1

scpcli data-flow delete data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data flow

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241s
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

1.1.7.2 - 1.0

scpcli data-flow delete data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data flow

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241s
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

1.1.8 - DeleteDataFlowService

1.1.8.1 - 1.1

scpcli data-flow delete data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

delete dataflow service console

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

1.1.8.2 - 1.0

scpcli data-flow delete data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

delete dataflow service console

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

1.1.9 - ListDataFlowImages

1.1.9.1 - 1.1

scpcli data-flow list data flow images
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Get List of Data Flow Images.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
image_idImage ID
image_nameImage name
versionVersion

1.1.9.2 - 1.0

scpcli data-flow list data flow images
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Get List of Data Flow Images.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
image_idImage ID
image_nameImage name
versionVersion

1.1.10 - ListDataFlows

1.1.10.1 - 1.1

scpcli data-flow list data flow
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataflow_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_flow_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataflow list console v1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
sort
optional
stringsortcreated_dt:desc
cluster_name
optional
stringcluster_name-
created_by
optional
stringcreated_by-
state
optional
****state-
dataflow_version
optional
stringversion-
size
optional
integersize20
page
optional
integerpage0
cluster_id
optional
stringcluster_id-
data_flow_name
optional
stringdata_flow_name-
region
optional
stringregion-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_flow_iddata_flow_id
data_flow_namedata_flow_name
image_idimage_id
instance_idinstance_id
is_active_imageis_active_image
modified_bymodified_by
modified_dtmodified_at
namespace_namenamespace_name
statestate
versionversion

1.1.10.2 - 1.0

scpcli data-flow list data flow
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataflow_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_flow_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataflow list console

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
sort
optional
stringsortcreated_dt:desc
cluster_name
optional
stringcluster_name-
created_by
optional
stringcreated_by-
state
optional
****state-
dataflow_version
optional
stringversion-
size
optional
integersize20
page
optional
integerpage0
cluster_id
optional
stringcluster_id-
data_flow_name
optional
stringdata_flow_name-
region
optional
stringregion-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_flow_iddata_flow_id
data_flow_namedata_flow_name
image_idimage_id
instance_idinstance_id
is_active_imageis_active_image
modified_bymodified_by
modified_dtmodified_at
namespace_namenamespace_name
statestate
versionversion

1.1.11 - ListDataFlowService

1.1.11.1 - 1.1

scpcli data-flow list data flow service
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--state <value>]
[--data_flow_service_name <value>]
[--data_flow_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataflow service list console v1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsort-
created_by
optional
stringcreated_by-
state
optional
****state-
data_flow_service_name
optional
stringdata_flow_service_name-
data_flow_name
optional
stringdata_flow_name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_flow_iddata_flow_id
data_flow_namedata_flow_name
data_flow_service_iddata_flow_service_id
data_flow_service_namedata_flow_service_name
descriptiondescription
modified_bymodified_by
modified_dtmodified_at
statestate
versionversion

1.1.11.2 - 1.0

scpcli data-flow list data flow service
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--state <value>]
[--data_flow_service_name <value>]
[--data_flow_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataflow service list console

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsort-
created_by
optional
stringcreated_by-
state
optional
****state-
data_flow_service_name
optional
stringdata_flow_service_name-
data_flow_name
optional
stringdata_flow_name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_flow_iddata_flow_id
data_flow_namedata_flow_name
data_flow_service_iddata_flow_service_id
data_flow_service_namedata_flow_service_name
descriptiondescription
modified_bymodified_by
modified_dtmodified_at
statestate
versionversion

1.1.12 - ShowDataFlow

1.1.12.1 - 1.1

scpcli data-flow show data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data flow

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241s
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
count_data_flow_servicecount_data_flow_service
created_dtcreated_dt
data_flow_iddata_flow_id
data_flow_namedata_flow_name
descriptiondescription
domaindomain
host_alias_listhost_alias[{‘hostnames’: [’’], ‘ip’: ‘’}]
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
statestate
storage_class_namestorage_class_name
versionversion
web_urlweb_url

1.1.12.2 - 1.0

scpcli data-flow show data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data flow

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241s
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
count_data_flow_servicecount_data_flow_service
created_dtcreated_dt
data_flow_iddata_flow_id
data_flow_namedata_flow_name
descriptiondescription
domaindomain
host_alias_listhost_alias[{‘hostnames’: [’’], ‘ip’: ‘’}]
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
statestate
storage_class_namestorage_class_name
versionversion
web_urlweb_url

1.1.13 - ShowDataFlowService

1.1.13.1 - 1.1

scpcli data-flow show data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

GET dataflow service console v1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_dtcreated_dt
data_flow_iddata_flow_id
data_flow_namedata_flow_name
data_flow_service_iddata_flow_service_id
data_flow_service_namedata_flow_service_name
descriptiondescription
domaindomain
host_aliashost_alias{’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]}
host_file_registryhost_file_registry
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
service_workloadservice_workload
statestate
storage_class_namestorage_class_name
versionversion
web_url_nifiweb_url_nifi
web_url_registryweb_url_registry

1.1.13.2 - 1.0

scpcli data-flow show data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

GET dataflow service console

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_dtcreated_dt
data_flow_iddata_flow_id
data_flow_namedata_flow_name
data_flow_service_iddata_flow_service_id
data_flow_service_namedata_flow_service_name
descriptiondescription
domaindomain
host_aliashost_alias{’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]}
host_file_registryhost_file_registry
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
service_workloadservice_workload
statestate
storage_class_namestorage_class_name
versionversion
web_url_nifiweb_url_nifi
web_url_registryweb_url_registry

1.1.14 - ShowDataFlowServiceSubVersions

1.1.14.1 - 1.1

scpcli data-flow show data flow service sub versions
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Get List of Data Flow Service Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringData flow ID-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
data_flow_service_countDataFlowService count
versionsimage versions

1.1.14.2 - 1.0

scpcli data-flow show data flow service sub versions
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Get List of Data Flow Service Versions.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringData flow ID-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
data_flow_service_countDataFlowService count
versionsimage versions

1.1.15 - UpdateDataFlow

1.1.15.1 - 1.1

scpcli data-flow update data flow
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update data flow by flow id

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241s
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias_list
optional
arrayhost_alias{'hostnames': [''], 'ip': ''}
node_selector
optional
stringnode_selector-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

1.1.15.2 - 1.0

scpcli data-flow update data flow
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update data flow by flow id

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241s
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias_list
optional
arrayhost_alias{'hostnames': [''], 'ip': ''}
node_selector
optional
stringnode_selector-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

1.1.16 - UpdateDataFlowService

1.1.16.1 - 1.1

scpcli data-flow update data flow service
--data_flow_service_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update dataflow service console

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias
optional
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
node_selector
optional
stringnode_selector-
service_workload
optional
objectservice_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
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

1.1.16.2 - 1.0

scpcli data-flow update data flow service
--data_flow_service_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update dataflow service console

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias
optional
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
node_selector
optional
stringnode_selector-
service_workload
optional
objectservice_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
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

2 - Data Ops

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Data Ops 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until

2.1 - CLIs

2.1.1 - CheckClusterResourceSizeForDataOpsServiceCreate

2.1.1.1 - 1.1

scpcli data-ops check cluster resource size for data ops service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Ops Service Creation.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
service_workload
required
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

2.1.1.2 - 1.0

scpcli data-ops check cluster resource size for data ops service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Ops Service Creation.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
service_workload
required
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

2.1.2 - CheckClusterResourceSizeForDataOpsServiceUpdate

2.1.2.1 - 1.1

scpcli data-ops check cluster resource size for data ops service update
--data_ops_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Ops Service Update.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
service_workload
required
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

2.1.2.2 - 1.0

scpcli data-ops check cluster resource size for data ops service update
--data_ops_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Ops Service Update.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
service_workload
required
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

2.1.3 - CheckDataOpsNameDuplication

2.1.3.1 - 1.1

scpcli data-ops check data ops name duplication
--data_ops_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

check duplication controller

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_name
required
stringdata ops name2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

2.1.3.2 - 1.0

scpcli data-ops check data ops name duplication
--data_ops_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

check duplication controller

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_name
required
stringdata ops name2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

2.1.4 - CheckDataOpsServiceNameDuplication

2.1.4.1 - 1.1

scpcli data-ops check data ops service name duplication
--data_ops_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

check duplication controller

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_service_name
required
stringdata ops service name2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

2.1.4.2 - 1.0

scpcli data-ops check data ops service name duplication
--data_ops_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

check duplication controller

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_service_name
required
stringdata ops service name2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

2.1.5 - CreateDataOps

2.1.5.1 - 1.1

scpcli data-ops create data ops
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_ops_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

create dataops

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
storage_class_name
required
stringstorage_class_name-
ingress_controller_name
required
stringingress_controller_name-
image_id
required
stringimage_id-
host_alias_list
required
arrayhost_alias_list{'hostnames': [''], 'ip': ''}
domain
required
stringdomain-
data_ops_name
required
stringdata_ops_name-
cluster_id
required
stringcluster_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
dsc_domain
optional
stringdsc_domain-
instance_id
optional
stringinstance_id-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

2.1.5.2 - 1.0

scpcli data-ops create data ops
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_ops_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

create dataops

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
storage_class_name
required
stringstorage_class_name-
ingress_controller_name
required
stringingress_controller_name-
image_id
required
stringimage_id-
host_alias_list
required
arrayhost_alias_list{'hostnames': [''], 'ip': ''}
domain
required
stringdomain-
data_ops_name
required
stringdata_ops_name-
cluster_id
required
stringcluster_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
dsc_domain
optional
stringdsc_domain-
instance_id
optional
stringinstance_id-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

2.1.6 - CreateDataOpsService

2.1.6.1 - 1.1

scpcli data-ops create data ops service
--worker_type <value>
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_ops_service_name <value>
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

create dataops service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
worker_type
required
stringworker_type-
storage_class_name
required
stringstorage_class_name-
service_workload
required
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
host_alias
required
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
domain
required
stringdescription-
data_ops_service_name
required
stringdata_ops_service_name-
data_ops_id
required
stringdata_ops_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

2.1.6.2 - 1.0

scpcli data-ops create data ops service
--worker_type <value>
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_ops_service_name <value>
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

create dataops service

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
worker_type
required
stringworker_type-
storage_class_name
required
stringstorage_class_name-
service_workload
required
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
host_alias
required
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
domain
required
stringdescription-
data_ops_service_name
required
stringdata_ops_service_name-
data_ops_id
required
stringdata_ops_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

2.1.7 - DeleteDataOps

2.1.7.1 - 1.1

scpcli data-ops delete data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

delete dataops v1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

2.1.7.2 - 1.0

scpcli data-ops delete data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

delete dataops v1

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

2.1.8 - DeleteDataOpsService

2.1.8.1 - 1.1

scpcli data-ops delete data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

delete data ops service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

2.1.8.2 - 1.0

scpcli data-ops delete data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

delete data ops service

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

2.1.9 - ListDataOps

2.1.9.1 - 1.1

scpcli data-ops list data ops
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataops_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_ops_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

{aianalytics.GetDataOpsListConsole.notes} v1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
sort
optional
stringsortcreated_dt:desc
cluster_name
optional
stringcluster_name-
created_by
optional
stringcreated_by-
state
optional
****state-
dataops_version
optional
stringversion-
size
optional
integersize20
page
optional
integerpage0
cluster_id
optional
stringcluster_id-
data_ops_name
optional
stringdata_ops_name-
region
optional
stringregion-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_ops_iddata_ops_id
data_ops_namedata_ops_name
image_idimage_id
instance_idinstance_id
is_active_imageis_active_image
modified_bymodified_by
modified_dtmodified_at
namespace_namenamespace_name
statestate
versionversion

2.1.9.2 - 1.0

scpcli data-ops list data ops
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataops_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_ops_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

{aianalytics.GetDataOpsListConsole.notes}

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
sort
optional
stringsortcreated_dt:desc
cluster_name
optional
stringcluster_name-
created_by
optional
stringcreated_by-
state
optional
****state-
dataops_version
optional
stringversion-
size
optional
integersize20
page
optional
integerpage0
cluster_id
optional
stringcluster_id-
data_ops_name
optional
stringdata_ops_name-
region
optional
stringregion-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_ops_iddata_ops_id
data_ops_namedata_ops_name
image_idimage_id
instance_idinstance_id
is_active_imageis_active_image
modified_bymodified_by
modified_dtmodified_at
namespace_namenamespace_name
statestate
versionversion

2.1.10 - ListDataOpsImageVersions

2.1.10.1 - 1.1

scpcli data-ops list data ops image versions
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataops image version v1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
image_attrimage_attr
image_idimage_id
image_nameimage_name
versionversion

2.1.10.2 - 1.0

scpcli data-ops list data ops image versions
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataops image version v1

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
image_attrimage_attr
image_idimage_id
image_nameimage_name
versionversion

2.1.11 - ListDataOpsService

2.1.11.1 - 1.1

scpcli data-ops list data ops service
[--created_by <value>]
[--state <value>]
[--sort <value>]
[--size <value>]
[--page <value>]
[--data_ops_service_name <value>]
[--data_ops_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

GetDataOpsServiceListConsole v1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
created_by
optional
stringcreated_by-
state
optional
****state-
sort
optional
stringsortcreated_dt:desc
size
optional
integersize20
page
optional
integerpage0
data_ops_service_name
optional
stringdata_ops_service_name-
data_ops_name
optional
stringdata_ops_name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_ops_iddata_ops_id
data_ops_namedata_ops_name
data_ops_service_iddata_ops_service_id
data_ops_service_namedata_ops_service_name
descriptiondescription
modified_bymodified_by
modified_dtmodified_at
statestate
versionversion

2.1.11.2 - 1.0

scpcli data-ops list data ops service
[--created_by <value>]
[--state <value>]
[--sort <value>]
[--size <value>]
[--page <value>]
[--data_ops_service_name <value>]
[--data_ops_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

GetDataOpsServiceListConsole

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
created_by
optional
stringcreated_by-
state
optional
****state-
sort
optional
stringsortcreated_dt:desc
size
optional
integersize20
page
optional
integerpage0
data_ops_service_name
optional
stringdata_ops_service_name-
data_ops_name
optional
stringdata_ops_name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_ops_iddata_ops_id
data_ops_namedata_ops_name
data_ops_service_iddata_ops_service_id
data_ops_service_namedata_ops_service_name
descriptiondescription
modified_bymodified_by
modified_dtmodified_at
statestate
versionversion

2.1.12 - ShowDataOps

2.1.12.1 - 1.1

scpcli data-ops show data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataops detail v1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_dtcreated_dt
data_ops_iddata_ops_id
data_ops_namedata_ops_name
descriptiondescription
domaindomain
host_alias_listhost_alias[{‘hostnames’: [’’], ‘ip’: ‘’}]
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
statestate
storage_class_namestorage_class_name
versionversion
web_urlweb_url

2.1.12.2 - 1.0

scpcli data-ops show data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataops detail

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_dtcreated_dt
data_ops_iddata_ops_id
data_ops_namedata_ops_name
descriptiondescription
domaindomain
host_alias_listhost_alias[{‘hostnames’: [’’], ‘ip’: ‘’}]
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
statestate
storage_class_namestorage_class_name
versionversion
web_urlweb_url

2.1.13 - ShowDataOpsService

2.1.13.1 - 1.1

scpcli data-ops show data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data ops service v1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_dtcreated_dt
data_ops_iddata_ops_id
data_ops_namedata_ops_name
data_ops_service_iddata_ops_service_id
data_ops_service_namedata_ops_service_name
descriptiondescription
domaindomain
host_aliashost_alias{’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]}
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
service_workloadservice_workload
statestate
storage_class_namestorage_class_name
versionversion
web_urlweb_url

2.1.13.2 - 1.0

scpcli data-ops show data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data ops service

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_dtcreated_dt
data_ops_iddata_ops_id
data_ops_namedata_ops_name
data_ops_service_iddata_ops_service_id
data_ops_service_namedata_ops_service_name
descriptiondescription
domaindomain
host_aliashost_alias{’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]}
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
service_workloadservice_workload
statestate
storage_class_namestorage_class_name
versionversion
web_urlweb_url

2.1.14 - ShowDataOpsServiceSubVersion

2.1.14.1 - 1.1

scpcli data-ops show data ops service sub version
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data ops sub version

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
data_ops_service_countDataOpsService count
versionsimage versions

2.1.14.2 - 1.0

scpcli data-ops show data ops service sub version
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data ops sub version

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
data_ops_service_countDataOpsService count
versionsimage versions

2.1.15 - UpdateDataOps

2.1.15.1 - 1.1

scpcli data-ops update data ops
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update dataops v1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias_list
optional
arrayhost_alias{'hostnames': [''], 'ip': ''}
node_selector
optional
stringnode_selector-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

2.1.15.2 - 1.0

scpcli data-ops update data ops
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update dataops v1

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias_list
optional
arrayhost_alias{'hostnames': [''], 'ip': ''}
node_selector
optional
stringnode_selector-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

2.1.16 - UpdateDataOpsService

2.1.16.1 - 1.1

scpcli data-ops update data ops service
--data_ops_service_id <value>
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--worker_type <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update data ops service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias
optional
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
node_selector
optional
stringnode_selector-
service_workload
optional
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
worker_type
optional
stringworker_type-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

2.1.16.2 - 1.0

scpcli data-ops update data ops service
--data_ops_service_id <value>
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--worker_type <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update data ops service

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias
optional
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
node_selector
optional
stringnode_selector-
service_workload
optional
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
worker_type
optional
stringworker_type-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

3 - Event Streams

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Event Streams 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

3.1 - CLIs

3.1.1 - Add Instances

3.1.1.1 - 1.0

scpcli eventstreams instance add
--cluster_id <value>
--service_ip_addresses <value>
--instance_count <value>
[--public_ip_ids <value>]

Description

Add Instances.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
service_ip_addresses
required
arrayUser subnet IP address-
instance_count
required
integerInstance Count-
public_ip_ids
optional
arrayPublic IP ID List-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

3.1.2 - Create Cluster

3.1.2.1 - 1.0

scpcli eventstreams cluster create
--zookeeper_sasl_password <value>
--zookeeper_sasl_id <value>
--broker_sasl_password <value>
--broker_sasl_id <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--akhq_enabled <value>]
[--allowable_ip_addresses <value>]
[--is_combined <value>]
[--nat_enabled <value>]
[--tags <value>]
[--akhq_id <value>]
[--akhq_password <value>]
[--broker_port <value>]
[--zookeeper_port <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
zookeeper_sasl_password
required
stringzookeeper sasl password-
zookeeper_sasl_id
required
stringzookeeper sasl id-
broker_sasl_password
required
stringbroker sasl password-
broker_sasl_id
required
stringbroker sasl id-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}'
dbaas_engine_version_id
required
stringDBaaS engine version ID-
akhq_enabled
optional
booleanAKHQ availability-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
is_combined
optional
booleanHA availability-
nat_enabled
optional
booleanNAT availability-
tags
optional
arraytag'{"key": "", "value": ""}'
akhq_id
optional
stringakhq id-
akhq_password
optional
stringakhq password-
broker_port
optional
integerbroker port-
zookeeper_port
optional
integerzookeeper port-
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

3.1.3 - List Clusters

3.1.3.1 - 1.0

scpcli eventstreams cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

3.1.4 - List Engine Version Properties

3.1.4.1 - 1.0

scpcli eventstreams engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

3.1.5 - List Engine Versions

3.1.5.1 - 1.0

scpcli eventstreams engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

3.1.6 - List Parameter Groups

3.1.6.1 - 1.0

scpcli eventstreams parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
major_version
optional
stringSoftware major version-
product_image_type
optional
stringProduct image type-
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter group ID
major_versionSoftware major version
nameParameter group name
product_image_typeProduct image type
product_typeProduct type

3.1.7 - List Parameter Values

3.1.7.1 - 1.0

scpcli eventstreams parameter value list
--cluster_id <value>

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idParameter id
allows_valueParameter allows value
applied_valueParameter applied value
apply_typeParameter apply type
data_typeParameter data type
default_valueParameter default value
descriptionParameter description
is_modifiableParameter is_modifiable
nameParameter name
software_typeParameter software type

3.1.8 - List Parameters

3.1.8.1 - 1.0

scpcli eventstreams parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_parameter_group_id
required
stringParameter group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter id
dbaas_parameter_group_idParameter id
default_valueParameter default value
descriptionParameter description
nameParameter name
software_typeParameter software type

3.1.9 - List Server Types

3.1.9.1 - 1.0

scpcli eventstreams engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

3.1.10 - Restart Cluster

3.1.10.1 - 1.0

scpcli eventstreams cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

3.1.11 - Set Block Storage Size

3.1.11.1 - 1.0

scpcli eventstreams block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

3.1.12 - Set Maintenance

3.1.12.1 - 1.0

scpcli eventstreams maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

3.1.13 - Set Parameter Values

3.1.13.1 - 1.0

scpcli eventstreams parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
parameters
required
arrayParameter request list'{"id": "", "new_value": "", "old_value": ""}'

3.1.14 - Set Security Group Rules

3.1.14.1 - 1.0

scpcli eventstreams security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

3.1.15 - Set Server Type

3.1.15.1 - 1.0

scpcli eventstreams server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

3.1.16 - Show Cluster

3.1.16.1 - 1.0

scpcli eventstreams cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID
block_storage_groupsBlock storage groups list
instancesInstances list
role_typeRole type
server_type_nameServer type name

3.1.17 - Show Request

3.1.17.1 - 1.0

scpcli eventstreams request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

3.1.18 - Start Cluster

3.1.18.1 - 1.0

scpcli eventstreams cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

3.1.19 - Stop Cluster

3.1.19.1 - 1.0

scpcli eventstreams cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

3.1.20 - Synchronize Cluster State

3.1.20.1 - 1.0

scpcli eventstreams cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

3.1.21 - Synchronize Parameter Values

3.1.21.1 - 1.0

scpcli eventstreams parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

3.1.22 - Terminate Cluster

3.1.22.1 - 1.0

scpcli eventstreams cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

3.1.23 - Unset Maintenance

3.1.23.1 - 1.0

scpcli eventstreams maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

4 - Quick Query

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Quick Query 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until

4.1 - CLIs

4.1.1 - CheckClusterResourceSizeForQuickQuery

4.1.1.1 - 1.1

scpcli quick-query check resource validation
--node_pool_validation_request <value>
[--cluster_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--is_engine_type_private <value>]
[--memory <value>]
[--replica <value>]

Description

Check if resource is verified to be modified/created

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
node_pool_validation_request
required
arraynode_pool_validation_request'{"auto_scale": "", "desired_node_count": "", "max_node_count": "", "min_node_count": "", "scale_name": ""}'
cluster_id
optional
stringcluster_id-
auto_scale
optional
booleanauto_scale-
cluster_size
optional
stringcluster_size-
cpu
optional
stringcpu-
is_engine_type_private
optional
booleanis_engine_type_private-
memory
optional
stringmemory-
replica
optional
stringreplica-

Responses

NameDescriptionExample
cpucpu
is_node_pool_auto_scalableis_node_pool_auto_scalable
memorymemory
replicareplica

4.1.1.2 - 1.0

scpcli quick-query check resource validation
--node_pool_validation_request <value>
[--cluster_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--is_engine_type_private <value>]
[--memory <value>]
[--replica <value>]

Description

Check if resource is verified to be modified/created

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
node_pool_validation_request
required
arraynode_pool_validation_request'{"auto_scale": "", "desired_node_count": "", "max_node_count": "", "min_node_count": "", "scale_name": ""}'
cluster_id
optional
stringcluster_id-
auto_scale
optional
booleanauto_scale-
cluster_size
optional
stringcluster_size-
cpu
optional
stringcpu-
is_engine_type_private
optional
booleanis_engine_type_private-
memory
optional
stringmemory-
replica
optional
stringreplica-

Responses

NameDescriptionExample
cpucpu
is_node_pool_auto_scalableis_node_pool_auto_scalable
memorymemory
replicareplica

4.1.2 - CheckDuplicationQuickQueryName

4.1.2.1 - 1.1

scpcli quick-query check quick query duplication
--quick_query_name <value>

Description

Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_name
required
stringquick query name-

Responses

NameDescriptionExample
resultcheck result

4.1.2.2 - 1.0

scpcli quick-query check quick query duplication
--quick_query_name <value>

Description

Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_name
required
stringquick query name-

Responses

NameDescriptionExample
resultcheck result

4.1.3 - CreateQuickQuery

4.1.3.1 - 1.1

scpcli quick-query create quick query
--quickquery_version <value>
--quick_query_name <value>
--max_query <value>
--is_engine_type_private <value>
--image_id <value>
--dsc_domain <value>
--domain <value>
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--kubernetes_engine_name <value>
--k8s_version <value>
--cloud_logging_enabled <value>
--node_pool_create_requests <value>
[--tags <value>]
[--cifs_volume_id <value>]
[--lb_id <value>]
[--public_acl_ip_address <value>]
[--description <value>]
[--dsc_console_ip <value>]
[--host_alias_list <value>]
[--instance_id <value>]
[--product_group_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--memory <value>]
[--replica <value>]

Description

Create Quick Query.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quickquery_version
required
stringversion-
quick_query_name
required
stringquick_query_name-
max_query
required
stringmax_query-
is_engine_type_private
required
booleanis_engine_type_private-
image_id
required
stringimage_id-
dsc_domain
required
stringdsc_domain-
domain
required
stringdomain-
vpc_id
required
stringvpc_id-
volume_id
required
stringvolume_id-
subnet_id
required
stringsubnet_id-
security_group_id_list
required
arraysecurity_group_id_list-
kubernetes_engine_name
required
stringkubernetes_engine_name-
k8s_version
required
stringk8s_version-
cloud_logging_enabled
required
booleancloud_logging_enabled-
node_pool_create_requests
required
arraynode_pool_create_requests'{"auto_recovery": false, "auto_scale": false, "desired_node_count": "", "image_os": "", "image_os_version": "", "k8s_version": "", "keypair_name": "", "max_node_count": "", "min_node_count": "", "name": "", "scale_name": "", "volume_size": "", "volume_type_name": ""}'
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
cifs_volume_id
optional
stringcifs_volume_id-
lb_id
optional
stringlb_id-
public_acl_ip_address
optional
stringpublic_acl_ip_address-
description
optional
stringdescription-
dsc_console_ip
optional
stringdsc_console_ip-
host_alias_list
optional
arrayhost_alias_list'{"hostnames": "", "ip": ""}'
instance_id
optional
stringinstance_id-
product_group_id
optional
stringproduct_group_id-
auto_scale
optional
booleanauto_scale-
cluster_size
optional
stringcluster_size-
cpu
optional
stringcpu-
memory
optional
stringmemory-
replica
optional
stringreplica-

Responses

NameDescriptionExample
project_idProject ID10a599e031e749b7b260868f441e862b
request_idRequest ID10a599e031e749b7b260868f441e862b
resource_idResource ID10a599e031e749b7b260868f441e862b

4.1.3.2 - 1.0

scpcli quick-query create quick query
--quickquery_version <value>
--quick_query_name <value>
--max_query <value>
--is_engine_type_private <value>
--image_id <value>
--dsc_domain <value>
--domain <value>
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--kubernetes_engine_name <value>
--k8s_version <value>
--cloud_logging_enabled <value>
--node_pool_create_requests <value>
[--tags <value>]
[--cifs_volume_id <value>]
[--lb_id <value>]
[--public_acl_ip_address <value>]
[--description <value>]
[--dsc_console_ip <value>]
[--host_alias_list <value>]
[--instance_id <value>]
[--product_group_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--memory <value>]
[--replica <value>]

Description

Create Quick Query.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quickquery_version
required
stringversion-
quick_query_name
required
stringquick_query_name-
max_query
required
stringmax_query-
is_engine_type_private
required
booleanis_engine_type_private-
image_id
required
stringimage_id-
dsc_domain
required
stringdsc_domain-
domain
required
stringdomain-
vpc_id
required
stringvpc_id-
volume_id
required
stringvolume_id-
subnet_id
required
stringsubnet_id-
security_group_id_list
required
arraysecurity_group_id_list-
kubernetes_engine_name
required
stringkubernetes_engine_name-
k8s_version
required
stringk8s_version-
cloud_logging_enabled
required
booleancloud_logging_enabled-
node_pool_create_requests
required
arraynode_pool_create_requests'{"auto_recovery": false, "auto_scale": false, "desired_node_count": "", "image_os": "", "image_os_version": "", "k8s_version": "", "keypair_name": "", "max_node_count": "", "min_node_count": "", "name": "", "scale_name": "", "volume_size": "", "volume_type_name": ""}'
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
cifs_volume_id
optional
stringcifs_volume_id-
lb_id
optional
stringlb_id-
public_acl_ip_address
optional
stringpublic_acl_ip_address-
description
optional
stringdescription-
dsc_console_ip
optional
stringdsc_console_ip-
host_alias_list
optional
arrayhost_alias_list'{"hostnames": "", "ip": ""}'
instance_id
optional
stringinstance_id-
product_group_id
optional
stringproduct_group_id-
auto_scale
optional
booleanauto_scale-
cluster_size
optional
stringcluster_size-
cpu
optional
stringcpu-
memory
optional
stringmemory-
replica
optional
stringreplica-

Responses

NameDescriptionExample
project_idProject ID10a599e031e749b7b260868f441e862b
request_idRequest ID10a599e031e749b7b260868f441e862b
resource_idResource ID10a599e031e749b7b260868f441e862b

4.1.4 - DeleteQuickQuery

4.1.4.1 - 1.1

scpcli quick-query delete quick query
--quick_query_id <value>

Description

delete quick query

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-

4.1.4.2 - 1.0

scpcli quick-query delete quick query
--quick_query_id <value>

Description

delete quick query

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-

4.1.5 - ListQuickQuery

4.1.5.1 - 1.1

scpcli quick-query list quick query
--page <value>
--size <value>
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--quick_query_state <value>]
[--quickquery_version <value>]
[--quick_query_name <value>]

Description

get quick query list console

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
page
required
integerpage0
size
required
integersize20
sort
optional
stringsortcreated_at:desc
cluster_name
optional
stringcluster_name-
created_by
optional
stringcreated_by-
quick_query_state
optional
****state-
quickquery_version
optional
stringversion-
quick_query_name
optional
stringquick_query_name-

Responses

NameDescriptionExample
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
modified_bymodified_by
modified_dtmodified_at
quick_query_idquick_query_id
quick_query_namequick_query_name
quick_query_statequick_query_state
quick_query_versionquick_query_version

4.1.5.2 - 1.0

scpcli quick-query list quick query
--page <value>
--size <value>
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--quick_query_state <value>]
[--quickquery_version <value>]
[--quick_query_name <value>]

Description

get quick query list console

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
page
required
integerpage0
size
required
integersize20
sort
optional
stringsortcreated_at:desc
cluster_name
optional
stringcluster_name-
created_by
optional
stringcreated_by-
quick_query_state
optional
****state-
quickquery_version
optional
stringversion-
quick_query_name
optional
stringquick_query_name-

Responses

NameDescriptionExample
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
modified_bymodified_by
modified_dtmodified_at
quick_query_idquick_query_id
quick_query_namequick_query_name
quick_query_statequick_query_state
quick_query_versionquick_query_version

4.1.6 - ListQuickQueryImages

4.1.6.1 - 1.1

scpcli quick-query list quick query images

Description

get quick query image versions

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Responses

NameDescriptionExample
image_attrimage_attr
image_idimage_id
image_nameimage_name
versionversion

4.1.6.2 - 1.0

scpcli quick-query list quick query images

Description

get quick query image versions

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Responses

NameDescriptionExample
image_attrimage_attr
image_idimage_id
image_nameimage_name
versionversion

4.1.7 - ShowQuickQuery

4.1.7.1 - 1.1

scpcli quick-query show quick query
--quick_query_id <value>

Description

Get Quick Query details.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-

Responses

NameDescriptionExample
ageage
cluster_idcluster id
container_versionContainer Version
created_atcreated at
external_ip_addressExternal IP Address
gpu_nameGPU Name
ipIP
kernel_versionKernel Version
kubernetes_versionKubernetes Version
namename
node_capacitiesNode Capacities
node_statusnode status
number_of_allocated_podsNumber of allocated pods
number_of_gpuNumber of GPU
os_imageOS Image
uiduid

4.1.7.2 - 1.0

scpcli quick-query show quick query
--quick_query_id <value>

Description

Get Quick Query details.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-

Responses

NameDescriptionExample
ageage
cluster_idcluster id
container_versionContainer Version
created_atcreated at
external_ip_addressExternal IP Address
gpu_nameGPU Name
ipIP
kernel_versionKernel Version
kubernetes_versionKubernetes Version
namename
node_capacitiesNode Capacities
node_statusnode status
number_of_allocated_podsNumber of allocated pods
number_of_gpuNumber of GPU
os_imageOS Image
uiduid

4.1.8 - UpdateQuickQueryDescription

4.1.8.1 - 1.1

scpcli quick-query update quick query description
--quick_query_id <value>
--description <value>

Description

update quick query description

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
description
required
stringdescription-

4.1.8.2 - 1.0

scpcli quick-query update quick query description
--quick_query_id <value>
--description <value>

Description

update quick query description

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
description
required
stringdescription-

4.1.9 - UpdateQuickQueryDomain

4.1.9.1 - 1.1

scpcli quick-query update quick query domain
--quick_query_id <value>
--domain <value>

Description

update quick query domain

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
domain
required
stringdomain-

4.1.9.2 - 1.0

scpcli quick-query update quick query domain
--quick_query_id <value>
--domain <value>

Description

update quick query domain

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
domain
required
stringdomain-

4.1.10 - UpdateQuickQueryDscDomain

4.1.10.1 - 1.1

scpcli quick-query update quick query dsc domain
--quick_query_id <value>
--dsc_domain <value>

Description

update quick query dsc domain

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
dsc_domain
required
stringdsc_domain-

4.1.10.2 - 1.0

scpcli quick-query update quick query dsc domain
--quick_query_id <value>
--dsc_domain <value>

Description

update quick query dsc domain

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
dsc_domain
required
stringdsc_domain-

4.1.11 - UpdateQuickQueryEngine

4.1.11.1 - 1.1

scpcli quick-query update quick query engine
--quick_query_id <value>
--replica <value>
--memory <value>
--cpu <value>
[--cluster_size <value>]

Description

update quick query engine

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
replica
required
stringreplica-
memory
required
stringmemory-
cpu
required
stringcpu-
cluster_size
optional
stringcluster_size-

4.1.11.2 - 1.0

scpcli quick-query update quick query engine
--quick_query_id <value>
--replica <value>
--memory <value>
--cpu <value>
[--cluster_size <value>]

Description

update quick query engine

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
replica
required
stringreplica-
memory
required
stringmemory-
cpu
required
stringcpu-
cluster_size
optional
stringcluster_size-

4.1.12 - UpdateQuickQueryHostAlias

4.1.12.1 - 1.1

scpcli quick-query update quick query host alias
--quick_query_id <value>
[--host_alias_list <value>]

Description

update quick query host alias

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
host_alias_list
optional
arrayhost_alias_list'{"hostnames": "", "ip": ""}'

4.1.12.2 - 1.0

scpcli quick-query update quick query host alias
--quick_query_id <value>
[--host_alias_list <value>]

Description

update quick query host alias

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
host_alias_list
optional
arrayhost_alias_list'{"hostnames": "", "ip": ""}'

5 - Search Engine

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Search Engine 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

5.1 - CLIs

5.1.1 - Add Block Storages

5.1.1.1 - 1.0

scpcli searchengine block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole type-
volume_type
optional
stringVolume type-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.2 - Add Instances

5.1.2.1 - 1.0

scpcli searchengine instance add
--cluster_id <value>
--service_ip_addresses <value>
--instance_count <value>
[--public_ip_ids <value>]

Description

Add Instances.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
service_ip_addresses
required
arrayUser subnet IP address-
instance_count
required
integerInstance Count-
public_ip_ids
optional
arrayPublic IP ID List-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.3 - Create Cluster

5.1.3.1 - 1.0

scpcli searchengine cluster create
--starting_time_hour <value>
--retention_period_day <value>
--database_user_password <value>
--database_user_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--is_combined <value>]
[--license <value>]
[--nat_enabled <value>]
[--tags <value>]
[--database_port <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}'
dbaas_engine_version_id
required
stringDBaaS engine version ID-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
is_combined
optional
booleanMaster Data server separation state-
license
optional
stringlicense-
nat_enabled
optional
booleanNAT availability-
tags
optional
arraytag'{"key": "", "value": ""}'
database_port
optional
integerDatabase service port-
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.4 - Create Restore Cluster

5.1.4.1 - 1.0

scpcli searchengine restore create
--cluster_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--backup_history_number <value>
[--allowable_ip_addresses <value>]
[--license <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Restore Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "role_type": "ACTIVE"}'
backup_history_number
required
stringBackup id-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
license
optional
stringlicense-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.5 - List Backup Histories

5.1.5.1 - 1.0

scpcli searchengine backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
limit
optional
integerNumber of backup lists-
page
optional
integerBackup list page-

Responses

NameDescriptionExample
backup_end_atBackup end time
backup_history_numberBackup id
backup_size_gbBackup amount(GB)
backup_start_atBackup start time
backup_stateBackup state
backup_state_detailBackup detail state
software_versionSoftware version

5.1.6 - List Clusters

5.1.6.1 - 1.0

scpcli searchengine cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

5.1.7 - List Engine Version Properties

5.1.7.1 - 1.0

scpcli searchengine engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

5.1.8 - List Engine Versions

5.1.8.1 - 1.0

scpcli searchengine engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

5.1.9 - List Server Types

5.1.9.1 - 1.0

scpcli searchengine engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

5.1.10 - Remove Backup Histories

5.1.10.1 - 1.0

scpcli searchengine backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

5.1.11 - Restart Cluster

5.1.11.1 - 1.0

scpcli searchengine cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.12 - Set Backup

5.1.12.1 - 1.0

scpcli searchengine backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.13 - Set Block Storage Size

5.1.13.1 - 1.0

scpcli searchengine block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.14 - Set Maintenance

5.1.14.1 - 1.0

scpcli searchengine maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.15 - Set Security Group Rules

5.1.15.1 - 1.0

scpcli searchengine security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.16 - Set Server Type

5.1.16.1 - 1.0

scpcli searchengine server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.17 - Show Cluster

5.1.17.1 - 1.0

scpcli searchengine cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID
block_storage_groupsBlock storage groups list
instancesInstances list
role_typeRole type
server_type_nameServer type name

5.1.18 - Show Request

5.1.18.1 - 1.0

scpcli searchengine request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

5.1.19 - Start Cluster

5.1.19.1 - 1.0

scpcli searchengine cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.20 - Stop Cluster

5.1.20.1 - 1.0

scpcli searchengine cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.21 - Synchronize Cluster State

5.1.21.1 - 1.0

scpcli searchengine cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

5.1.22 - Terminate Cluster

5.1.22.1 - 1.0

scpcli searchengine cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

5.1.23 - Unset Backup

5.1.23.1 - 1.0

scpcli searchengine backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

5.1.24 - Unset Maintenance

5.1.24.1 - 1.0

scpcli searchengine maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6 - Vertica(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Vertica(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

6.1 - CLIs

6.1.1 - Add Block Storages

6.1.1.1 - 1.0

scpcli vertica block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole type-
volume_type
optional
stringVolume type-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.2 - Create Cluster

6.1.2.1 - 1.0

scpcli vertica cluster create
--starting_time_hour <value>
--retention_period_day <value>
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--license <value>]
[--nat_enabled <value>]
[--tags <value>]
[--database_locale <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_name
required
stringDatabase Name-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}'
dbaas_engine_version_id
required
stringDBaaS engine version ID-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
license
optional
stringlicense-
nat_enabled
optional
booleanNAT availability-
tags
optional
arraytag'{"key": "", "value": ""}'
database_locale
optional
stringDatabase locale information-
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.3 - Create Restore Cluster

6.1.3.1 - 1.0

scpcli vertica restore create
--cluster_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--backup_history_number <value>
[--allowable_ip_addresses <value>]
[--license <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Restore Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "role_type": "ACTIVE", "server_type_name": ""}'
backup_history_number
required
stringBackup id-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
license
optional
stringlicense-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.4 - List Backup Histories

6.1.4.1 - 1.0

scpcli vertica backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
limit
optional
integerNumber of backup lists-
page
optional
integerBackup list page-

Responses

NameDescriptionExample
backup_end_atBackup end time
backup_history_numberBackup id
backup_size_gbBackup amount(GB)
backup_start_atBackup start time
backup_stateBackup state
backup_state_detailBackup detail state
software_versionSoftware version

6.1.5 - List Clusters

6.1.5.1 - 1.0

scpcli vertica cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
console_includedManagement Console included state
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
nat_enabledNAT availability
role_typeRole type
service_stateService state

6.1.6 - List Engine Version Properties

6.1.6.1 - 1.0

scpcli vertica engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

6.1.7 - List Engine Versions

6.1.7.1 - 1.0

scpcli vertica engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

6.1.8 - List Server Types

6.1.8.1 - 1.0

scpcli vertica engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

6.1.9 - Remove Backup Histories

6.1.9.1 - 1.0

scpcli vertica backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

6.1.10 - Restart Cluster

6.1.10.1 - 1.0

scpcli vertica cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.11 - Set Backup

6.1.11.1 - 1.0

scpcli vertica backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.12 - Set Block Storage Size

6.1.12.1 - 1.0

scpcli vertica block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.13 - Set Maintenance

6.1.13.1 - 1.0

scpcli vertica maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.14 - Set Security Group Rules

6.1.14.1 - 1.0

scpcli vertica security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.15 - Set Server Type

6.1.15.1 - 1.0

scpcli vertica server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.16 - Show Cluster

6.1.16.1 - 1.0

scpcli vertica cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID
block_storage_groupsBlock storage groups list
instancesInstances list
role_typeRole type
server_type_nameServer type name

6.1.17 - Show Request

6.1.17.1 - 1.0

scpcli vertica request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

6.1.18 - Start Cluster

6.1.18.1 - 1.0

scpcli vertica cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.19 - Stop Cluster

6.1.19.1 - 1.0

scpcli vertica cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.20 - Synchronize Cluster State

6.1.20.1 - 1.0

scpcli vertica cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.21 - Terminate Cluster

6.1.21.1 - 1.0

scpcli vertica cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.1.22 - Unset Backup

6.1.22.1 - 1.0

scpcli vertica backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.1.23 - Unset Maintenance

6.1.23.1 - 1.0

scpcli vertica maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-