이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

Data Analytics

1: Data Flow

1.1: APIs

1.1.1: CheckClusterResourceSizeForDataFlowServiceCreate

1.1.1.1: 1.1
1.1.1.2: 1.0

1.1.2: CheckClusterResourceSizeForDataFlowServiceUpdate

1.1.2.1: 1.1
1.1.2.2: 1.0

1.1.3: CheckDataFlowNameDuplication

1.1.3.1: 1.1
1.1.3.2: 1.0

1.1.4: CheckDataFlowServiceNameDuplication

1.1.4.1: 1.1
1.1.4.2: 1.0

1.1.5: CreateDataFlow

1.1.5.1: 1.1
1.1.5.2: 1.0

1.1.6: CreateDataFlowService

1.1.6.1: 1.1
1.1.6.2: 1.0

1.1.7: DeleteDataFlow

1.1.7.1: 1.1
1.1.7.2: 1.0

1.1.8: DeleteDataFlowService

1.1.8.1: 1.1
1.1.8.2: 1.0

1.1.9: ListDataFlowImages

1.1.9.1: 1.1
1.1.9.2: 1.0

1.1.10: ListDataFlowIngressControllers

1.1.10.1: 1.1
1.1.10.2: 1.0

1.1.11: ListDataFlows

1.1.11.1: 1.1
1.1.11.2: 1.0

1.1.12: ListDataFlowService

1.1.12.1: 1.1
1.1.12.2: 1.0

1.1.13: ShowDataFlow

1.1.13.1: 1.1
1.1.13.2: 1.0

1.1.14: ShowDataFlowService

1.1.14.1: 1.1
1.1.14.2: 1.0

1.1.15: ShowDataFlowServiceSubVersions

1.1.15.1: 1.1
1.1.15.2: 1.0

1.1.16: UpdateDataFlow

1.1.16.1: 1.1
1.1.16.2: 1.0

1.1.17: UpdateDataFlowService

1.1.17.1: 1.1
1.1.17.2: 1.0

1.2: Models

1.2.1: ClusterResourceCheckResponse
1.2.2: DataFlowBodyCreate
1.2.3: DataFlowBodyUpdate
1.2.4: DataFlowCheckDuplicationResponse
1.2.5: DataFlowDetailResponse
1.2.6: DataFlowDetailResponseV1Dot1
1.2.7: DataFlowImageListResponse
1.2.8: DataFlowImageResponse
1.2.9: DataFlowsConsoleResponse
1.2.10: DataFlowsConsoleResponseV1Dot1
1.2.11: DataFlowServiceCheckDuplicationResponse
1.2.12: DataFlowServiceCreateRequest
1.2.13: DataFlowServiceDetailResponse
1.2.14: DataFlowServiceDetailResponseV1Dot1
1.2.15: DataFlowServiceImageResponse
1.2.16: DataFlowServicesResponse
1.2.17: DataFlowServicesResponseV1Dot1
1.2.18: DataFlowServiceSubVersionResponse
1.2.19: DataFlowServicesUpdateRequest
1.2.20: DataFlowServiceUpdateResponse
1.2.21: DataFlowServiceValidateResourceRequest
1.2.22: DataFlowUpdateResponse
1.2.23: ListDataFlowsConsoleResponse
1.2.24: ListDataFlowsConsoleResponseV1Dot1
1.2.25: ListDataFlowServicesConsoleResponse
1.2.26: ListDataFlowServicesConsoleResponseV1Dot1
1.2.27: Tag

2: Data Ops

2.1: APIs

2.1.1: CheckClusterResourceSizeForDataOpsServiceCreate

2.1.1.1: 1.1
2.1.1.2: 1.0

2.1.2: CheckClusterResourceSizeForDataOpsServiceUpdate

2.1.2.1: 1.1
2.1.2.2: 1.0

2.1.3: CheckDataOpsNameDuplication

2.1.3.1: 1.1
2.1.3.2: 1.0

2.1.4: CheckDataOpsServiceNameDuplication

2.1.4.1: 1.1
2.1.4.2: 1.0

2.1.5: CreateDataOps

2.1.5.1: 1.1
2.1.5.2: 1.0

2.1.6: CreateDataOpsService

2.1.6.1: 1.1
2.1.6.2: 1.0

2.1.7: DeleteDataOps

2.1.7.1: 1.1
2.1.7.2: 1.0

2.1.8: DeleteDataOpsService

2.1.8.1: 1.1
2.1.8.2: 1.0

2.1.9: ListDataOps

2.1.9.1: 1.1
2.1.9.2: 1.0

2.1.10: ListDataOpsImageVersions

2.1.10.1: 1.1
2.1.10.2: 1.0

2.1.11: ListDataOpsIngressControllers

2.1.11.1: 1.1
2.1.11.2: 1.0

2.1.12: ListDataOpsService

2.1.12.1: 1.1
2.1.12.2: 1.0

2.1.13: ShowDataOps

2.1.13.1: 1.1
2.1.13.2: 1.0

2.1.14: ShowDataOpsService

2.1.14.1: 1.1
2.1.14.2: 1.0

2.1.15: ShowDataOpsServiceSubVersion

2.1.15.1: 1.1
2.1.15.2: 1.0

2.1.16: UpdateDataOps

2.1.16.1: 1.1
2.1.16.2: 1.0

2.1.17: UpdateDataOpsService

2.1.17.1: 1.1
2.1.17.2: 1.0

2.2: Models

2.2.1: ClusterResourceCheckResponse
2.2.2: DataOpsConsoleResponse
2.2.3: DataOpsConsoleResponseV1Dot1
2.2.4: DataOpsCreateRequest
2.2.5: DataOpsDetailResponse
2.2.6: DataOpsDetailResponseV1Dot1
2.2.7: DataOpsServiceCreateRequest
2.2.8: DataOpsServiceDetailResponse
2.2.9: DataOpsServiceDetailResponseV1Dot1
2.2.10: DataOpsServiceImageResponse
2.2.11: DataOpsServicesConsoleResponse
2.2.12: DataOpsServicesConsoleResponseV1Dot1
2.2.13: DataOpsServiceSubVersionResponse
2.2.14: DataOpsServiceUpdateRequest
2.2.15: DataOpsServiceUpdateResponse
2.2.16: DataOpsServiceValidateResourceRequest
2.2.17: DataOpsUpdateRequest
2.2.18: DataOpsUpdateResponse
2.2.19: ImageAttr
2.2.20: ImageVersionsResponse
2.2.21: ListDataOpsConsoleResponse
2.2.22: ListDataOpsConsoleResponseV1Dot1
2.2.23: ListDataOpsServicesConsoleResponse
2.2.24: ListDataOpsServicesConsoleResponseV1Dot1
2.2.25: QuickQueryImageAttr
2.2.26: Tag

3: Event Streams

3.1: APIs

3.1.1: Add Instances

3.1.1.1: 1.0

3.1.2: Create Cluster

3.1.2.1: 1.0

3.1.3: List Clusters

3.1.3.1: 1.0

3.1.4: List Engine Version Properties

3.1.4.1: 1.0

3.1.5: List Engine Versions

3.1.5.1: 1.0

3.1.6: List Parameter Groups

3.1.6.1: 1.0

3.1.7: List Parameter Values

3.1.7.1: 1.0

3.1.8: List Parameters

3.1.8.1: 1.0

3.1.9: List Server Types

3.1.9.1: 1.0

3.1.10: Restart Cluster

3.1.10.1: 1.0

3.1.11: Set Block Storage Size

3.1.11.1: 1.0

3.1.12: Set Maintenance

3.1.12.1: 1.0

3.1.13: Set Parameter Values

3.1.13.1: 1.0

3.1.14: Set Security Group Rules

3.1.14.1: 1.0

3.1.15: Set Server Type

3.1.15.1: 1.0

3.1.16: Show Cluster

3.1.16.1: 1.0

3.1.17: Show Request

3.1.17.1: 1.0

3.1.18: Start Cluster

3.1.18.1: 1.0

3.1.19: Stop Cluster

3.1.19.1: 1.0

3.1.20: Synchronize Cluster State

3.1.20.1: 1.0

3.1.21: Synchronize Parameter Values

3.1.21.1: 1.0

3.1.22: Terminate Cluster

3.1.22.1: 1.0

3.1.23: Unset Maintenance

3.1.23.1: 1.0

3.2: Models

3.2.1: AsyncResponse
3.2.2: BlockStorageGroupRequest
3.2.3: BlockStorageGroupResponse
3.2.4: ClusterPageResponse
3.2.5: ClusterResponse
3.2.6: Engine
3.2.7: EngineListResponse
3.2.8: EngineProperty
3.2.9: EnginePropertyListResponse
3.2.10: EventStreamsClusterAddInstancesRequest
3.2.11: EventStreamsClusterCreateRequest
3.2.12: EventStreamsClusterDetailResponse
3.2.13: EventStreamsInitConfigOptionDetail
3.2.14: EventStreamsInitConfigOptionRequest
3.2.15: InstanceGroupRequest
3.2.16: InstanceGroupResizeRequest
3.2.17: InstanceGroupResponse
3.2.18: InstanceRequest
3.2.19: InstanceResponse
3.2.20: MaintenanceOption
3.2.21: MaintenanceRequest
3.2.22: MaintenanceResponseOption
3.2.23: ParameterDTO
3.2.24: ParameterGroup
3.2.25: ParameterGroupListResponse
3.2.26: ParameterPageResponse
3.2.27: ParameterRequest
3.2.28: Parameters
3.2.29: ParametersRequest
3.2.30: ParametersResponse
3.2.31: RequestStateResponse
3.2.32: ResizeBlockStorageGroupRequest
3.2.33: ResourceInfo
3.2.34: ServerType
3.2.35: ServerTypeListResponse
3.2.36: Tag
3.2.37: UpdateSecurityGroupRulesRequest

4: Quick Query

4.1: APIs

4.1.1: CheckClusterResourceSizeForQuickQuery

4.1.1.1: 1.1
4.1.1.2: 1.0

4.1.2: CheckDuplicationQuickQueryName

4.1.2.1: 1.1
4.1.2.2: 1.0

4.1.3: CreateQuickQuery

4.1.3.1: 1.1
4.1.3.2: 1.0

4.1.4: DeleteQuickQuery

4.1.4.1: 1.1
4.1.4.2: 1.0

4.1.5: ListQuickQuery

4.1.5.1: 1.1
4.1.5.2: 1.0

4.1.6: ListQuickQueryImages

4.1.6.1: 1.1
4.1.6.2: 1.0

4.1.7: ShowQuickQuery

4.1.7.1: 1.1
4.1.7.2: 1.0

4.1.8: UpdateQuickQueryDescription

4.1.8.1: 1.1
4.1.8.2: 1.0

4.1.9: UpdateQuickQueryDomain

4.1.9.1: 1.1
4.1.9.2: 1.0

4.1.10: UpdateQuickQueryDscDomain

4.1.10.1: 1.1
4.1.10.2: 1.0

4.1.11: UpdateQuickQueryEngine

4.1.11.1: 1.1
4.1.11.2: 1.0

4.1.12: UpdateQuickQueryHostAlias

4.1.12.1: 1.1
4.1.12.2: 1.0

4.2: Models

4.2.1: AsyncResponse
4.2.2: CheckResponse
4.2.3: HostAliasList
4.2.4: ImageAttr
4.2.5: ImageVersionsResponse
4.2.6: InternalNodeSummary
4.2.7: KubernetesEngineCreateRequest
4.2.8: NodeCapacity
4.2.9: NodePoolCreateRequest
4.2.10: NodePoolResourceValidationRequest
4.2.11: NodePoolSpecResponse
4.2.12: QueryEngineSpec
4.2.13: QuickQueryCreateRequest
4.2.14: QuickQueryDescriptionRequest
4.2.15: QuickQueryDescriptionResponse
4.2.16: QuickQueryDetailResponse
4.2.17: QuickQueryDomainRequest
4.2.18: QuickQueryDscDomainRequest
4.2.19: QuickQueryEngineRequest
4.2.20: QuickQueryHostAliasRequest
4.2.21: QuickQueryImageAttr
4.2.22: QuickQueryListResponse
4.2.23: QuickQueryListSearchResponse
4.2.24: QuickQueryTotalCreateRequest
4.2.25: QuickQueryUpdateEngineRequest
4.2.26: QuickQueryValidateResourceRequest
4.2.27: QuickQueryValidateResourceResponse
4.2.28: Tag

5: Search Engine

5.1: APIs

5.1.1: Add Block Storages

5.1.1.1: 1.0

5.1.2: Add Instances

5.1.2.1: 1.0

5.1.3: Create Cluster

5.1.3.1: 1.0

5.1.4: Create Restore Cluster

5.1.4.1: 1.0

5.1.5: List Backup Histories

5.1.5.1: 1.0

5.1.6: List Clusters

5.1.6.1: 1.0

5.1.7: List Engine Version Properties

5.1.7.1: 1.0

5.1.8: List Engine Versions

5.1.8.1: 1.0

5.1.9: List Server Types

5.1.9.1: 1.0

5.1.10: Remove Backup Histories

5.1.10.1: 1.0

5.1.11: Restart Cluster

5.1.11.1: 1.0

5.1.12: Set Backup

5.1.12.1: 1.0

5.1.13: Set Block Storage Size

5.1.13.1: 1.0

5.1.14: Set Maintenance

5.1.14.1: 1.0

5.1.15: Set Security Group Rules

5.1.15.1: 1.0

5.1.16: Set Server Type

5.1.16.1: 1.0

5.1.17: Show Cluster

5.1.17.1: 1.0

5.1.18: Show Request

5.1.18.1: 1.0

5.1.19: Start Cluster

5.1.19.1: 1.0

5.1.20: Stop Cluster

5.1.20.1: 1.0

5.1.21: Synchronize Cluster State

5.1.21.1: 1.0

5.1.22: Terminate Cluster

5.1.22.1: 1.0

5.1.23: Unset Backup

5.1.23.1: 1.0

5.1.24: Unset Maintenance

5.1.24.1: 1.0

5.2: Models

5.2.1: AddBlockStoragesRequest
5.2.2: AsyncResponse
5.2.3: BackupHistoryApiItem
5.2.4: BackupHistoryListApiResponse
5.2.5: BackupHistoryNumberRequest
5.2.6: BackupSettingExcludingArchiveRequest
5.2.7: BlockStorageGroupRequest
5.2.8: BlockStorageGroupResponse
5.2.9: ClusterPageResponse
5.2.10: ClusterResponse
5.2.11: Engine
5.2.12: EngineListResponse
5.2.13: EngineProperty
5.2.14: EnginePropertyListResponse
5.2.15: InstanceGroupRequest
5.2.16: InstanceGroupResizeRequest
5.2.17: InstanceGroupResponse
5.2.18: InstanceRequest
5.2.19: InstanceResponse
5.2.20: MaintenanceOption
5.2.21: MaintenanceRequest
5.2.22: MaintenanceResponseOption
5.2.23: RequestStateResponse
5.2.24: ResizeBlockStorageGroupRequest
5.2.25: ResourceInfo
5.2.26: SearchEngineClusterAddInstancesRequest
5.2.27: SearchEngineClusterCreateRequest
5.2.28: SearchEngineClusterDetailResponse
5.2.29: SearchEngineClusterRestoreRequest
5.2.30: SearchEngineInitConfigOptionRequest
5.2.31: SearchEngineInitConfigOptionResponse
5.2.32: SearchEngineLicenseResponse
5.2.33: SearchEngineRestoreInstanceGroup
5.2.34: ServerType
5.2.35: ServerTypeListResponse
5.2.36: Tag
5.2.37: UpdateSecurityGroupRulesRequest

6: Vertica(DBaaS)

6.1: APIs

6.1.1: Add Block Storages

6.1.1.1: 1.0

6.1.2: Create Cluster

6.1.2.1: 1.0

6.1.3: Create Restore Cluster

6.1.3.1: 1.0

6.1.4: List Backup Histories

6.1.4.1: 1.0

6.1.5: List Clusters

6.1.5.1: 1.0

6.1.6: List Engine Version Properties

6.1.6.1: 1.0

6.1.7: List Engine Versions

6.1.7.1: 1.0

6.1.8: List Server Types

6.1.8.1: 1.0

6.1.9: Remove Backup Histories

6.1.9.1: 1.0

6.1.10: Restart Cluster

6.1.10.1: 1.0

6.1.11: Set Backup

6.1.11.1: 1.0

6.1.12: Set Block Storage Size

6.1.12.1: 1.0

6.1.13: Set Maintenance

6.1.13.1: 1.0

6.1.14: Set Security Group Rules

6.1.14.1: 1.0

6.1.15: Set Server Type

6.1.15.1: 1.0

6.1.16: Show Cluster

6.1.16.1: 1.0

6.1.17: Show Request

6.1.17.1: 1.0

6.1.18: Start Cluster

6.1.18.1: 1.0

6.1.19: Stop Cluster

6.1.19.1: 1.0

6.1.20: Synchronize Cluster State

6.1.20.1: 1.0

6.1.21: Terminate Cluster

6.1.21.1: 1.0

6.1.22: Unset Backup

6.1.22.1: 1.0

6.1.23: Unset Maintenance

6.1.23.1: 1.0

6.2: Models

6.2.1: AddBlockStoragesRequest
6.2.2: AsyncResponse
6.2.3: BackupHistoryApiItem
6.2.4: BackupHistoryListApiResponse
6.2.5: BackupHistoryNumberRequest
6.2.6: BackupSettingExcludingArchiveRequest
6.2.7: BlockStorageGroupRequest
6.2.8: BlockStorageGroupResponse
6.2.9: Engine
6.2.10: EngineListResponse
6.2.11: EngineProperty
6.2.12: EnginePropertyListResponse
6.2.13: InstanceGroupRequest
6.2.14: InstanceGroupResizeRequest
6.2.15: InstanceGroupResponse
6.2.16: InstanceRequest
6.2.17: InstanceResponse
6.2.18: MaintenanceOption
6.2.19: MaintenanceRequest
6.2.20: MaintenanceResponseOption
6.2.21: RequestStateResponse
6.2.22: ResizeBlockStorageGroupRequest
6.2.23: ResourceInfo
6.2.24: ServerType
6.2.25: ServerTypeListResponse
6.2.26: Tag
6.2.27: UpdateSecurityGroupRulesRequest
6.2.28: VerticaClusterCreateRequest
6.2.29: VerticaClusterDetailResponse
6.2.30: VerticaClusterListResponse
6.2.31: VerticaClusterPageResponse
6.2.32: VerticaClusterRestoreRequest
6.2.33: VerticaInitConfigOptionRequest
6.2.34: VerticaInitConfigOptionResponse
6.2.35: VerticaRestoreInstanceGroup

1 - Data Flow

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Data Flow 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until

OpenAPI URL

https://data-flow.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

1.1 - APIs

1.1.1 - CheckClusterResourceSizeForDataFlowServiceCreate

1.1.1.1 - 1.1

post /v1/data-flow-services/clusters/{cluster_id}/validate-resources

Description

Validate Cluster Resource Size for Data Flow Service Creation.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	cluster_id required	Cluster ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None
body	body required		DataFlowServiceValidateResourceRequest

Responses

HTTP Code	Description	Schema
200	OK	ClusterResourceCheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services/clusters/{cluster_id}/validate-resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Request body

{
    "service_workload": {
        "nifi": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "nifi_registry": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "zookeeper": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "3",
            "version": "3.9.2"
        }
    }
}

Example HTTP response

Response 200

{
    "cpu": "CPU",
    "err_code": "",
    "memory": "Memory",
    "result": ""
}

1.1.1.2 - 1.0

post /v1/data-flow-services/clusters/{cluster_id}/validate-resources

Description

Validate Cluster Resource Size for Data Flow Service Creation.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	cluster_id required	Cluster ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None
body	body required		DataFlowServiceValidateResourceRequest

Responses

HTTP Code	Description	Schema
200	OK	ClusterResourceCheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services/clusters/{cluster_id}/validate-resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Request body

{
    "service_workload": {
        "nifi": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "nifi_registry": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "zookeeper": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "3",
            "version": "3.9.2"
        }
    }
}

Example HTTP response

Response 200

{
    "cpu": "CPU",
    "err_code": "",
    "memory": "Memory",
    "result": ""
}

1.1.2 - CheckClusterResourceSizeForDataFlowServiceUpdate

1.1.2.1 - 1.1

post /v1/data-flow-services/{data_flow_service_id}/validate-resources

Description

Validate Cluster Resource Size for Data Flow Service Update.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_service_id required	data_flow_service_id Example :	string	None
body	body required		DataFlowServiceValidateResourceRequest

Responses

HTTP Code	Description	Schema
200	OK	ClusterResourceCheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services/{data_flow_service_id}/validate-resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Request body

{
    "service_workload": {
        "nifi": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "nifi_registry": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "zookeeper": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "3",
            "version": "3.9.2"
        }
    }
}

Example HTTP response

Response 200

{
    "cpu": "CPU",
    "err_code": "",
    "memory": "Memory",
    "result": ""
}

1.1.2.2 - 1.0

post /v1/data-flow-services/{data_flow_service_id}/validate-resources

Description

Validate Cluster Resource Size for Data Flow Service Update.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_service_id required	data_flow_service_id Example :	string	None
body	body required		DataFlowServiceValidateResourceRequest

Responses

HTTP Code	Description	Schema
200	OK	ClusterResourceCheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services/{data_flow_service_id}/validate-resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Request body

{
    "service_workload": {
        "nifi": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "nifi_registry": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "zookeeper": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "3",
            "version": "3.9.2"
        }
    }
}

Example HTTP response

Response 200

{
    "cpu": "CPU",
    "err_code": "",
    "memory": "Memory",
    "result": ""
}

1.1.3 - CheckDataFlowNameDuplication

1.1.3.1 - 1.1

get /v1/data-flows/{data_flow_name}/check-duplication

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_name required	Data flow name Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataFlowCheckDuplicationResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows/{data_flow_name}/check-duplication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Example HTTP response

Response 200

{
    "result": ""
}

1.1.3.2 - 1.0

get /v1/data-flows/{data_flow_name}/check-duplication

Description

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

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_name required	Data flow name Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataFlowCheckDuplicationResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows/{data_flow_name}/check-duplication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Example HTTP response

Response 200

{
    "result": ""
}

1.1.4 - CheckDataFlowServiceNameDuplication

1.1.4.1 - 1.1

get /v1/data-flow-services/{data_flow_service_name}/check-duplication

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_service_name required	Data flow service name Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataFlowServiceCheckDuplicationResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services/{data_flow_service_name}/check-duplication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Example HTTP response

Response 200

{
    "result": ""
}

1.1.4.2 - 1.0

get /v1/data-flow-services/{data_flow_service_name}/check-duplication

Description

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

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_service_name required	Data flow service name Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataFlowServiceCheckDuplicationResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services/{data_flow_service_name}/check-duplication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Example HTTP response

Response 200

{
    "result": ""
}

1.1.5 - CreateDataFlow

1.1.5.1 - 1.1

post /v1/data-flows

Description

create data flow

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
body	body required		DataFlowBodyCreate

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Request body

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "data_flow_name": "",
    "description": "",
    "domain": "",
    "dsc_domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "image_id": "",
    "ingress_controller_name": "",
    "instance_id": "",
    "node_selector": "",
    "storage_class_name": "",
    "tags": [
        {
            "tag_key": "",
            "tag_value": ""
        }
    ]
}

Example HTTP response

Response 202

1.1.5.2 - 1.0

post /v1/data-flows

Description

create data flow

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
body	body required		DataFlowBodyCreate

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Request body

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "data_flow_name": "",
    "description": "",
    "domain": "",
    "dsc_domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "image_id": "",
    "ingress_controller_name": "",
    "instance_id": "",
    "node_selector": "",
    "storage_class_name": "",
    "tags": [
        {
            "tag_key": "",
            "tag_value": ""
        }
    ]
}

Example HTTP response

Response 202

1.1.6 - CreateDataFlowService

1.1.6.1 - 1.1

post /v1/data-flow-services

Description

Create dataflow service console

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
body	body required		DataFlowServiceCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Request body

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "data_flow_id": "",
    "data_flow_service_name": "",
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "node_selector": "",
    "service_workload": {
        "nifi": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "nifi_registry": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "zookeeper": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "3",
            "version": "3.9.2"
        }
    },
    "storage_class_name": "",
    "tags": [
        {
            "tag_key": "",
            "tag_value": ""
        }
    ]
}

Example HTTP response

Response 202

1.1.6.2 - 1.0

post /v1/data-flow-services

Description

Create dataflow service console

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
body	body required		DataFlowServiceCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Request body

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "data_flow_id": "",
    "data_flow_service_name": "",
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "node_selector": "",
    "service_workload": {
        "nifi": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "nifi_registry": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "zookeeper": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "3",
            "version": "3.9.2"
        }
    },
    "storage_class_name": "",
    "tags": [
        {
            "tag_key": "",
            "tag_value": ""
        }
    ]
}

Example HTTP response

Response 202

1.1.7 - DeleteDataFlow

1.1.7.1 - 1.1

delete /v1/data-flows/{data_flow_id}

Description

get data flow

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_id required	Cluster ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241s`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows/{data_flow_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Example HTTP response

Response 202

1.1.7.2 - 1.0

delete /v1/data-flows/{data_flow_id}

Description

get data flow

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_id required	Cluster ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241s`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows/{data_flow_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Example HTTP response

Response 202

1.1.8 - DeleteDataFlowService

1.1.8.1 - 1.1

delete /v1/data-flow-services/{data_flow_service_id}

Description

delete dataflow service console

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_service_id required	data_flow_service_id Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services/{data_flow_service_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Example HTTP response

Response 202

1.1.8.2 - 1.0

delete /v1/data-flow-services/{data_flow_service_id}

Description

delete dataflow service console

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_service_id required	data_flow_service_id Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services/{data_flow_service_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Example HTTP response

Response 202

1.1.9 - ListDataFlowImages

1.1.9.1 - 1.1

get /v1/data-flows/image-versions

Description

Get List of Data Flow Images.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi

Responses

HTTP Code	Description	Schema
200	OK	DataFlowImageListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows/image-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "image_id": "",
            "image_name": "",
            "version": ""
        }
    ],
    "total_count": ""
}

1.1.9.2 - 1.0

get /v1/data-flows/image-versions

Description

Get List of Data Flow Images.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi

Responses

HTTP Code	Description	Schema
200	OK	DataFlowImageListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows/image-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "image_id": "",
            "image_name": "",
            "version": ""
        }
    ],
    "total_count": ""
}

1.1.10 - ListDataFlowIngressControllers

1.1.10.1 - 1.1

get /v1/data-flows/clusters/{cluster_id}/ingress-controllers

Description

ingress by cluster id

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	cluster_id required	Cluster ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows/clusters/{cluster_id}/ingress-controllers

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Example HTTP response

Response 200

1.1.10.2 - 1.0

get /v1/data-flows/clusters/{cluster_id}/ingress-controllers

Description

ingress by cluster id

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	cluster_id required	Cluster ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows/clusters/{cluster_id}/ingress-controllers

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Example HTTP response

Response 200

1.1.11 - ListDataFlows

1.1.11.1 - 1.1

get /v1/data-flows

Description

get dataflow list console v1.1

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
query	sort optional	sort Example : `created_dt:desc`	string	created_dt:desc
query	cluster_name optional	cluster_name Example :	string	None
query	created_by optional	created_by Example :	string	None
query	state optional	state Example :	enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING)	None
query	version optional	version Example :	string	None
query	size optional	size Example : `20`	integer	None
query	page optional	page Example : `0`	integer	None
query	cluster_id optional	cluster_id Example :	string	None
query	data_flow_name optional	data_flow_name Example :	string	None
query	region optional	region Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	ListDataFlowsConsoleResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "account_id": "",
            "cluster_id": "",
            "cluster_name": "",
            "cluster_permission": {},
            "cluster_request_failed": false,
            "created_by": "",
            "created_dt": "2026-02-11T06:41:26.053Z",
            "data_flow_id": "",
            "data_flow_name": "",
            "image_id": "",
            "instance_id": "",
            "is_active_image": "",
            "modified_by": "",
            "modified_dt": "2026-02-11T06:41:26.060Z",
            "namespace_name": "",
            "state": "",
            "version": ""
        }
    ],
    "total_count": ""
}

1.1.11.2 - 1.0

get /v1/data-flows

Description

get dataflow list console

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
query	sort optional	sort Example : `created_dt:desc`	string	created_dt:desc
query	cluster_name optional	cluster_name Example :	string	None
query	created_by optional	created_by Example :	string	None
query	state optional	state Example :	enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING)	None
query	version optional	version Example :	string	None
query	size optional	size Example : `20`	integer	None
query	page optional	page Example : `0`	integer	None
query	cluster_id optional	cluster_id Example :	string	None
query	data_flow_name optional	data_flow_name Example :	string	None
query	region optional	region Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	ListDataFlowsConsoleResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "cluster_id": "",
            "cluster_name": "",
            "cluster_permission": {},
            "cluster_request_failed": false,
            "created_by": "",
            "created_dt": "2026-02-11T06:41:25.463Z",
            "data_flow_id": "",
            "data_flow_name": "",
            "image_id": "",
            "instance_id": "",
            "is_active_image": "",
            "modified_by": "",
            "modified_dt": "2026-02-11T06:41:25.469Z",
            "namespace_name": "",
            "state": "",
            "version": ""
        }
    ],
    "total_count": ""
}

1.1.12 - ListDataFlowService

1.1.12.1 - 1.1

get /v1/data-flow-services

Description

get dataflow service list console v1.1

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_dt:desc`	string	created_dt:desc
query	created_by optional	created_by Example :	string	None
query	state optional	state Example :	enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING)	None
query	data_flow_service_name optional	data_flow_service_name Example :	any of [string, null]	None
query	data_flow_name optional	data_flow_name Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	ListDataFlowServicesConsoleResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "account_id": "",
            "cluster_id": "",
            "cluster_name": "",
            "cluster_permission": {},
            "cluster_request_failed": false,
            "created_by": "",
            "created_dt": "2026-02-11T06:41:25.909Z",
            "data_flow_id": "",
            "data_flow_name": "",
            "data_flow_service_id": "",
            "data_flow_service_name": "",
            "description": "",
            "modified_by": "",
            "modified_dt": "2026-02-11T06:41:25.915Z",
            "state": "",
            "version": ""
        }
    ],
    "total_count": ""
}

1.1.12.2 - 1.0

get /v1/data-flow-services

Description

get dataflow service list console

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_dt:desc`	string	created_dt:desc
query	created_by optional	created_by Example :	string	None
query	state optional	state Example :	enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING)	None
query	data_flow_service_name optional	data_flow_service_name Example :	any of [string, null]	None
query	data_flow_name optional	data_flow_name Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	ListDataFlowServicesConsoleResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "cluster_id": "",
            "cluster_name": "",
            "cluster_permission": {},
            "cluster_request_failed": false,
            "created_by": "",
            "created_dt": "2026-02-11T06:41:25.071Z",
            "data_flow_id": "",
            "data_flow_name": "",
            "data_flow_service_id": "",
            "data_flow_service_name": "",
            "description": "",
            "modified_by": "",
            "modified_dt": "2026-02-11T06:41:25.077Z",
            "state": "",
            "version": ""
        }
    ],
    "total_count": ""
}

1.1.13 - ShowDataFlow

1.1.13.1 - 1.1

get /v1/data-flows/{data_flow_id}

Description

get data flow

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_id required	Cluster ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241s`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataFlowDetailResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows/{data_flow_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Example HTTP response

Response 200

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "account_id": "",
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "count_data_flow_service": "",
    "created_dt": "2026-02-11T06:41:26.085Z",
    "data_flow_id": "",
    "data_flow_name": "",
    "description": "",
    "domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "is_active_image": "",
    "modified_dt": "2026-02-11T06:41:26.140Z",
    "namespace_name": "",
    "node_selector": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url": ""
}

1.1.13.2 - 1.0

get /v1/data-flows/{data_flow_id}

Description

get data flow

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_id required	Cluster ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241s`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataFlowDetailResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows/{data_flow_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Example HTTP response

Response 200

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "count_data_flow_service": "",
    "created_dt": "2026-02-11T06:41:25.563Z",
    "data_flow_id": "",
    "data_flow_name": "",
    "description": "",
    "domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "is_active_image": "",
    "modified_dt": "2026-02-11T06:41:25.623Z",
    "namespace_name": "",
    "node_selector": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url": ""
}

1.1.14 - ShowDataFlowService

1.1.14.1 - 1.1

get /v1/data-flow-services/{data_flow_service_id}

Description

GET dataflow service console v1.1

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_service_id required	data_flow_service_id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataFlowServiceDetailResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services/{data_flow_service_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Example HTTP response

Response 200

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "account_id": "",
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "created_dt": "2026-02-11T06:41:25.941Z",
    "data_flow_id": "",
    "data_flow_name": "",
    "data_flow_service_id": "",
    "data_flow_service_name": "",
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "host_file_registry": "",
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "is_active_image": "",
    "modified_dt": "2026-02-11T06:41:26.001Z",
    "namespace_name": "",
    "node_selector": "",
    "service_workload": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url_nifi": "",
    "web_url_registry": ""
}

1.1.14.2 - 1.0

get /v1/data-flow-services/{data_flow_service_id}

Description

GET dataflow service console

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_service_id required	data_flow_service_id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataFlowServiceDetailResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services/{data_flow_service_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Example HTTP response

Response 200

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "created_dt": "2026-02-11T06:41:25.201Z",
    "data_flow_id": "",
    "data_flow_name": "",
    "data_flow_service_id": "",
    "data_flow_service_name": "",
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "host_file_registry": "",
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "is_active_image": "",
    "modified_dt": "2026-02-11T06:41:25.261Z",
    "namespace_name": "",
    "node_selector": "",
    "service_workload": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url_nifi": "",
    "web_url_registry": ""
}

1.1.15 - ShowDataFlowServiceSubVersions

1.1.15.1 - 1.1

get /v1/data-flow-services/data-flows/{data_flow_id}/sub-versions

Description

Get List of Data Flow Service Versions.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_id required	Data flow ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataFlowServiceImageResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services/data-flows/{data_flow_id}/sub-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Example HTTP response

Response 200

{
    "data_flow_service_count": "",
    "versions": {
        "nifi": "",
        "nifiregistry": "",
        "zookeeper": ""
    }
}

1.1.15.2 - 1.0

get /v1/data-flow-services/data-flows/{data_flow_id}/sub-versions

Description

Get List of Data Flow Service Versions.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_id required	Data flow ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataFlowServiceImageResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services/data-flows/{data_flow_id}/sub-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Example HTTP response

Response 200

{
    "data_flow_service_count": "",
    "versions": {
        "nifi": "",
        "nifiregistry": "",
        "zookeeper": ""
    }
}

1.1.16 - UpdateDataFlow

1.1.16.1 - 1.1

put /v1/data-flows/{data_flow_id}

Description

update data flow by flow id

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_id required	Cluster ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241s`	string	None
body	body required		DataFlowBodyUpdate

Responses

HTTP Code	Description	Schema
202	Accepted	DataFlowUpdateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows/{data_flow_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Request body

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "description": "",
    "domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "node_selector": ""
}

Example HTTP response

Response 202

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "count_data_flow_service": "",
    "created_dt": "2026-02-11T06:41:25.706Z",
    "data_flow_id": "",
    "data_flow_name": "",
    "description": "",
    "domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "modified_dt": "2026-02-11T06:41:25.760Z",
    "namespace_name": "",
    "node_selector": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url": ""
}

1.1.16.2 - 1.0

put /v1/data-flows/{data_flow_id}

Description

update data flow by flow id

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_id required	Cluster ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241s`	string	None
body	body required		DataFlowBodyUpdate

Responses

HTTP Code	Description	Schema
202	Accepted	DataFlowUpdateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flows/{data_flow_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Request body

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "description": "",
    "domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "node_selector": ""
}

Example HTTP response

Response 202

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "count_data_flow_service": "",
    "created_dt": "2026-02-11T06:41:25.706Z",
    "data_flow_id": "",
    "data_flow_name": "",
    "description": "",
    "domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "modified_dt": "2026-02-11T06:41:25.760Z",
    "namespace_name": "",
    "node_selector": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url": ""
}

1.1.17 - UpdateDataFlowService

1.1.17.1 - 1.1

put /v1/data-flow-services/{data_flow_service_id}

Description

update dataflow service console

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_service_id required	data_flow_service_id Example :	string	None
body	body required		DataFlowServicesUpdateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	DataFlowServiceUpdateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services/{data_flow_service_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.1"

Request body

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "node_selector": "",
    "service_workload": {
        "nifi": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "nifi_registry": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "zookeeper": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "3",
            "version": "3.9.2"
        }
    }
}

Example HTTP response

Response 202

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "created_dt": "2026-02-11T06:41:25.347Z",
    "data_flow_id": "",
    "data_flow_name": "",
    "data_flow_service_id": "",
    "data_flow_service_name": "",
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "host_file_registry": "",
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "modified_dt": "2026-02-11T06:41:25.401Z",
    "namespace_name": "",
    "node_selector": "",
    "service_workload": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url_nifi": "",
    "web_url_registry": ""
}

1.1.17.2 - 1.0

put /v1/data-flow-services/{data_flow_service_id}

Description

update dataflow service console

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_flow_service_id required	data_flow_service_id Example :	string	None
body	body required		DataFlowServicesUpdateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	DataFlowServiceUpdateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-flow-services/{data_flow_service_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-flow 1.0"

Request body

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "node_selector": "",
    "service_workload": {
        "nifi": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "nifi_registry": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "1",
            "version": "1.27.1"
        },
        "zookeeper": {
            "cpu": "2000",
            "memory": "1024",
            "replica": "3",
            "version": "3.9.2"
        }
    }
}

Example HTTP response

Response 202

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "created_dt": "2026-02-11T06:41:25.347Z",
    "data_flow_id": "",
    "data_flow_name": "",
    "data_flow_service_id": "",
    "data_flow_service_name": "",
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "host_file_registry": "",
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "modified_dt": "2026-02-11T06:41:25.401Z",
    "namespace_name": "",
    "node_selector": "",
    "service_workload": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url_nifi": "",
    "web_url_registry": ""
}

1.2 - Models

1.2.1 - ClusterResourceCheckResponse

Name	Description	Schema	Default
cpu optional	Example : `CPU`	object	CPU
err_code required	Error code Example :	string
memory optional	Example : `Memory`	object	Memory
result required	Cluster resource check result Example :	boolean

1.2.2 - DataFlowBodyCreate

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
cluster_id required	cluster_id Example :	string
data_flow_name required	data_flow_name Example : Minimum length : `3` Maximum length : `30`	string
description optional	description Example :	any of [string, null]
domain required	domain Example : Minimum length : `3` Maximum length : `50`	string
dsc_domain optional	dsc_domain Example :	any of [string, null]
host_alias_list required	host_alias_list Example : `[{'hostnames': [''], 'ip': ''}]`	array[object]
image_id required	image_id Example :	string
ingress_controller_name required	ingress_controller_name Example :	string
instance_id optional	instance_id Example :	any of [string, null]
node_selector optional	node_selector Example :	any of [string, null]
storage_class_name required	storage_class_name Example :	string
tags optional	tags	array[Tag]

1.2.3 - DataFlowBodyUpdate

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias_list optional	host_alias Example : `[{'hostnames': [''], 'ip': ''}]`	any of [array[object], null]
node_selector optional	node_selector Example :	any of [string, null]

1.2.4 - DataFlowCheckDuplicationResponse

Name	Description	Schema	Default
result required	Data flow check result Example :	boolean

1.2.5 - DataFlowDetailResponse

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
count_data_flow_service optional	count_data_flow_service Example :	integer
created_dt required	created_dt Example : `2026-02-11T06:41:25.563Z`	string (date-time)
data_flow_id required	data_flow_id Example :	string
data_flow_name required	data_flow_name Example :	string
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias_list optional	host_alias Example : `[{'hostnames': [''], 'ip': ''}]`	any of [array[object], null]
hosts_file optional	hosts_file Example :	any of [string, null]
http_port optional	http_port Example :	any of [integer, null]
https_port optional	https_port Example :	any of [integer, null]
image_id required	image_id Example :	string
ingress_class_name optional	ingress_class_name Example :	any of [string, null]
instance_id required	instance_id Example :	any of [string, null]
is_active_image optional	is_active_image Example :	any of [boolean, null]
modified_dt required	modified_dt Example : `2026-02-11T06:41:25.623Z`	string (date-time)
namespace_name required	namespace_name Example :	string
node_selector optional	node_selector Example :	any of [string, null]
state required	state Example :	string
storage_class_name required	storage_class_name Example :	string
version required	version Example :	string
web_url optional	web_url Example :	any of [string, null]

1.2.6 - DataFlowDetailResponseV1Dot1

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
account_id required	account_id Example :	string
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
count_data_flow_service optional	count_data_flow_service Example :	integer
created_dt required	created_dt Example : `2026-02-11T06:41:26.085Z`	string (date-time)
data_flow_id required	data_flow_id Example :	string
data_flow_name required	data_flow_name Example :	string
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias_list optional	host_alias Example : `[{'hostnames': [''], 'ip': ''}]`	any of [array[object], null]
hosts_file optional	hosts_file Example :	any of [string, null]
http_port optional	http_port Example :	any of [integer, null]
https_port optional	https_port Example :	any of [integer, null]
image_id required	image_id Example :	string
ingress_class_name optional	ingress_class_name Example :	any of [string, null]
instance_id required	instance_id Example :	any of [string, null]
is_active_image optional	is_active_image Example :	any of [boolean, null]
modified_dt required	modified_dt Example : `2026-02-11T06:41:26.140Z`	string (date-time)
namespace_name required	namespace_name Example :	string
node_selector optional	node_selector Example :	any of [string, null]
state required	state Example :	string
storage_class_name required	storage_class_name Example :	string
version required	version Example :	string
web_url optional	web_url Example :	any of [string, null]

1.2.7 - DataFlowImageListResponse

Name	Description	Schema	Default
contents required	List of DataFlowImage	array[DataFlowImageResponse]
total_count optional	total_count Example :	integer

1.2.8 - DataFlowImageResponse

Name	Description	Schema
image_id required	Image ID Example :	string
image_name required	Image name Example :	string
version required	Version Example :	string

1.2.9 - DataFlowsConsoleResponse

Name	Description	Schema
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	object
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_by required	created_by Example :	string
created_dt required	created_at Example : `2026-02-11T06:41:25.463Z`	string (date-time)
data_flow_id required	data_flow_id Example :	string
data_flow_name required	data_flow_name Example :	string
image_id required	image_id Example :	string
instance_id required	instance_id Example :	any of [string, null]
is_active_image required	is_active_image Example :	boolean
modified_by required	modified_by Example :	string
modified_dt required	modified_at Example : `2026-02-11T06:41:25.469Z`	string (date-time)
namespace_name required	namespace_name Example :	string
state required	state Example :	string
version required	version Example :	string

1.2.10 - DataFlowsConsoleResponseV1Dot1

Name	Description	Schema
account_id required	account_id Example :	string
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	object
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_by required	created_by Example :	string
created_dt required	created_at Example : `2026-02-11T06:41:26.053Z`	string (date-time)
data_flow_id required	data_flow_id Example :	string
data_flow_name required	data_flow_name Example :	string
image_id required	image_id Example :	string
instance_id required	instance_id Example :	any of [string, null]
is_active_image required	is_active_image Example :	boolean
modified_by required	modified_by Example :	string
modified_dt required	modified_at Example : `2026-02-11T06:41:26.060Z`	string (date-time)
namespace_name required	namespace_name Example :	string
state required	state Example :	string
version required	version Example :	string

1.2.11 - DataFlowServiceCheckDuplicationResponse

Name	Description	Schema	Default
result required	Data flow service check result Example :	boolean

1.2.12 - DataFlowServiceCreateRequest

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
data_flow_id required	data_flow_id Example :	string
data_flow_service_name required	data_flow_service_name Example : Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `30`	string
description optional	description Example :	any of [string, null]
domain required	description Example : Minimum length : `3` Maximum length : `50`	string
host_alias required	host_alias Example : `{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}`	object
node_selector optional	node_selector Example :	any of [string, null]
service_workload required	service_workload Example : `{'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}}`	object
storage_class_name required	storage_class_name Example :	string
tags optional	tags	array[Tag]

1.2.13 - DataFlowServiceDetailResponse

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_dt required	created_dt Example : `2026-02-11T06:41:25.201Z`	string (date-time)
data_flow_id required	data_flow_id Example :	string
data_flow_name required	data_flow_name Example :	string
data_flow_service_id required	data_flow_service_id Example :	string
data_flow_service_name required	data_flow_service_name Example :	string
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias optional	host_alias Example : `{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}`	any of [object, null]
host_file_registry optional	host_file_registry Example :	any of [string, null]
hosts_file optional	hosts_file Example :	any of [string, null]
http_port optional	http_port Example :	any of [integer, null]
https_port optional	https_port Example :	any of [integer, null]
image_id required	image_id Example :	string
ingress_class_name optional	ingress_class_name Example :	any of [string, null]
instance_id required	instance_id Example :	any of [string, null]
is_active_image optional	is_active_image Example :	any of [boolean, null]
modified_dt required	modified_dt Example : `2026-02-11T06:41:25.261Z`	string (date-time)
namespace_name required	namespace_name Example :	string
node_selector optional	node_selector Example :	any of [string, null]
service_workload optional	service_workload Example :	any of [object, null]
state required	state Example :	string
storage_class_name required	storage_class_name Example :	string
version required	version Example :	string
web_url_nifi optional	web_url_nifi Example :	any of [string, null]
web_url_registry optional	web_url_registry Example :	any of [string, null]

1.2.14 - DataFlowServiceDetailResponseV1Dot1

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
account_id required	account_id Example :	string
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_dt required	created_dt Example : `2026-02-11T06:41:25.941Z`	string (date-time)
data_flow_id required	data_flow_id Example :	string
data_flow_name required	data_flow_name Example :	string
data_flow_service_id required	data_flow_service_id Example :	string
data_flow_service_name required	data_flow_service_name Example :	string
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias optional	host_alias Example : `{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}`	any of [object, null]
host_file_registry optional	host_file_registry Example :	any of [string, null]
hosts_file optional	hosts_file Example :	any of [string, null]
http_port optional	http_port Example :	any of [integer, null]
https_port optional	https_port Example :	any of [integer, null]
image_id required	image_id Example :	string
ingress_class_name optional	ingress_class_name Example :	any of [string, null]
instance_id required	instance_id Example :	any of [string, null]
is_active_image optional	is_active_image Example :	any of [boolean, null]
modified_dt required	modified_dt Example : `2026-02-11T06:41:26.001Z`	string (date-time)
namespace_name required	namespace_name Example :	string
node_selector optional	node_selector Example :	any of [string, null]
service_workload optional	service_workload Example :	any of [object, null]
state required	state Example :	string
storage_class_name required	storage_class_name Example :	string
version required	version Example :	string
web_url_nifi optional	web_url_nifi Example :	any of [string, null]
web_url_registry optional	web_url_registry Example :	any of [string, null]

1.2.15 - DataFlowServiceImageResponse

Name	Description	Schema	Default
data_flow_service_count optional	DataFlowService count Example :	integer
versions optional	image versions	DataFlowServiceSubVersionResponse

1.2.16 - DataFlowServicesResponse

Name	Description	Schema
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_by required	created_by Example :	string
created_dt required	created_at Example : `2026-02-11T06:41:25.071Z`	string (date-time)
data_flow_id required	data_flow_id Example :	string
data_flow_name required	data_flow_name Example :	string
data_flow_service_id required	data_flow_service_id Example :	string
data_flow_service_name required	data_flow_service_name Example :	string
description optional	description Example :	any of [string, null]
modified_by required	modified_by Example :	string
modified_dt required	modified_at Example : `2026-02-11T06:41:25.077Z`	string (date-time)
state required	state Example :	string
version required	version Example :	string

1.2.17 - DataFlowServicesResponseV1Dot1

Name	Description	Schema
account_id required	account_id Example :	string
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_by required	created_by Example :	string
created_dt required	created_at Example : `2026-02-11T06:41:25.909Z`	string (date-time)
data_flow_id required	data_flow_id Example :	string
data_flow_name required	data_flow_name Example :	string
data_flow_service_id required	data_flow_service_id Example :	string
data_flow_service_name required	data_flow_service_name Example :	string
description optional	description Example :	any of [string, null]
modified_by required	modified_by Example :	string
modified_dt required	modified_at Example : `2026-02-11T06:41:25.915Z`	string (date-time)
state required	state Example :	string
version required	version Example :	string

1.2.18 - DataFlowServiceSubVersionResponse

Name	Description	Schema
nifi required	nifi Example :	string
nifiregistry required	nifiregistry Example :	string
zookeeper required	zookeeper Example :	string

1.2.19 - DataFlowServicesUpdateRequest

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	object
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias optional	host_alias Example : `{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}`	any of [object, null]
node_selector optional	node_selector Example :	any of [string, null]
service_workload optional	service_workload Example : `{'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}}`	object

1.2.20 - DataFlowServiceUpdateResponse

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_dt required	created_dt Example : `2026-02-11T06:41:25.347Z`	string (date-time)
data_flow_id required	data_flow_id Example :	string
data_flow_name required	data_flow_name Example :	string
data_flow_service_id required	data_flow_service_id Example :	string
data_flow_service_name required	data_flow_service_name Example :	string
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias optional	host_alias Example : `{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}`	any of [object, null]
host_file_registry optional	host_file_registry Example :	any of [string, null]
hosts_file optional	hosts_file Example :	any of [string, null]
http_port optional	http_port Example :	any of [integer, null]
https_port optional	https_port Example :	any of [integer, null]
image_id required	image_id Example :	string
ingress_class_name optional	ingress_class_name Example :	any of [string, null]
instance_id required	instance_id Example :	any of [string, null]
modified_dt required	modified_dt Example : `2026-02-11T06:41:25.401Z`	string (date-time)
namespace_name required	namespace_name Example :	string
node_selector optional	node_selector Example :	any of [string, null]
service_workload optional	service_workload Example :	any of [object, null]
state required	state Example :	string
storage_class_name required	storage_class_name Example :	string
version required	version Example :	string
web_url_nifi optional	web_url_nifi Example :	any of [string, null]
web_url_registry optional	web_url_registry Example :	any of [string, null]

1.2.21 - DataFlowServiceValidateResourceRequest

Name	Description	Schema	Default
service_workload required	service_workload Example : `{'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}}`	object

1.2.22 - DataFlowUpdateResponse

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
count_data_flow_service optional	count_data_flow_service Example :	integer
created_dt required	created_dt Example : `2026-02-11T06:41:25.706Z`	string (date-time)
data_flow_id required	data_flow_id Example :	string
data_flow_name required	data_flow_name Example :	string
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias_list optional	host_alias Example : `[{'hostnames': [''], 'ip': ''}]`	any of [array[object], null]
hosts_file optional	hosts_file Example :	any of [string, null]
http_port optional	http_port Example :	any of [integer, null]
https_port optional	https_port Example :	any of [integer, null]
image_id required	image_id Example :	string
ingress_class_name optional	ingress_class_name Example :	any of [string, null]
instance_id required	instance_id Example :	any of [string, null]
modified_dt required	modified_dt Example : `2026-02-11T06:41:25.760Z`	string (date-time)
namespace_name required	namespace_name Example :	string
node_selector optional	node_selector Example :	any of [string, null]
state required	state Example :	string
storage_class_name required	storage_class_name Example :	string
version required	version Example :	string
web_url optional	web_url Example :	any of [string, null]

1.2.23 - ListDataFlowsConsoleResponse

Name	Description	Schema	Default
contents optional	contents	array[DataFlowsConsoleResponse]
total_count optional	total_count Example :	integer

1.2.24 - ListDataFlowsConsoleResponseV1Dot1

Name	Description	Schema	Default
contents optional	contents	array[DataFlowsConsoleResponseV1Dot1]
total_count optional	total_count Example :	integer

1.2.25 - ListDataFlowServicesConsoleResponse

Name	Description	Schema	Default
contents optional		array[DataFlowServicesResponse]
total_count required	total_count Example :	integer

1.2.26 - ListDataFlowServicesConsoleResponseV1Dot1

Name	Description	Schema	Default
contents optional		array[DataFlowServicesResponseV1Dot1]
total_count required	total_count Example :	integer

1.2.27 - Tag

Name	Description	Schema	Default
tag_key required	tag_key Example : Pattern : `^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]$` Maximum length* : `128`	string
tag_value optional	tag_value Example : Pattern : `^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]$` Maximum length* : `256`	string

2 - Data Ops

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Data Ops 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until

OpenAPI URL

https://data-ops.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

2.1 - APIs

2.1.1 - CheckClusterResourceSizeForDataOpsServiceCreate

2.1.1.1 - 1.1

post /v1/data-ops-services/clusters/{cluster_id}/validate-resources

Description

Validate Cluster Resource Size for Data Ops Service Creation.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	cluster_id required	Cluster ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None
body	body required		DataOpsServiceValidateResourceRequest

Responses

HTTP Code	Description	Schema
200	OK	ClusterResourceCheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services/clusters/{cluster_id}/validate-resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Request body

{
    "service_workload": {
        "scheduler": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "web_server": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "worker": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        }
    }
}

Example HTTP response

Response 200

{
    "cpu": "CPU",
    "err_code": "",
    "memory": "Memory",
    "result": ""
}

2.1.1.2 - 1.0

post /v1/data-ops-services/clusters/{cluster_id}/validate-resources

Description

Validate Cluster Resource Size for Data Ops Service Creation.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	cluster_id required	Cluster ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None
body	body required		DataOpsServiceValidateResourceRequest

Responses

HTTP Code	Description	Schema
200	OK	ClusterResourceCheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services/clusters/{cluster_id}/validate-resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Request body

{
    "service_workload": {
        "scheduler": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "web_server": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "worker": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        }
    }
}

Example HTTP response

Response 200

{
    "cpu": "CPU",
    "err_code": "",
    "memory": "Memory",
    "result": ""
}

2.1.2 - CheckClusterResourceSizeForDataOpsServiceUpdate

2.1.2.1 - 1.1

post /v1/data-ops-services/{data_ops_service_id}/validate-resources

Description

Validate Cluster Resource Size for Data Ops Service Update.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_service_id required	data ops service ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None
body	body required		DataOpsServiceValidateResourceRequest

Responses

HTTP Code	Description	Schema
200	OK	ClusterResourceCheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services/{data_ops_service_id}/validate-resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Request body

{
    "service_workload": {
        "scheduler": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "web_server": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "worker": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        }
    }
}

Example HTTP response

Response 200

{
    "cpu": "CPU",
    "err_code": "",
    "memory": "Memory",
    "result": ""
}

2.1.2.2 - 1.0

post /v1/data-ops-services/{data_ops_service_id}/validate-resources

Description

Validate Cluster Resource Size for Data Ops Service Update.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_service_id required	data ops service ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None
body	body required		DataOpsServiceValidateResourceRequest

Responses

HTTP Code	Description	Schema
200	OK	ClusterResourceCheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services/{data_ops_service_id}/validate-resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Request body

{
    "service_workload": {
        "scheduler": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "web_server": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "worker": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        }
    }
}

Example HTTP response

Response 200

{
    "cpu": "CPU",
    "err_code": "",
    "memory": "Memory",
    "result": ""
}

2.1.3 - CheckDataOpsNameDuplication

2.1.3.1 - 1.1

get /v1/data-ops/{data_ops_name}/check-duplication

Description

check duplication controller

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_name required	data ops name Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops/{data_ops_name}/check-duplication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Example HTTP response

Response 200

2.1.3.2 - 1.0

get /v1/data-ops/{data_ops_name}/check-duplication

Description

check duplication controller

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_name required	data ops name Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops/{data_ops_name}/check-duplication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Example HTTP response

Response 200

2.1.4 - CheckDataOpsServiceNameDuplication

2.1.4.1 - 1.1

get /v1/data-ops-services/{data_ops_service_name}/check-duplication

Description

check duplication controller

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_service_name required	data ops service name Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services/{data_ops_service_name}/check-duplication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Example HTTP response

Response 200

2.1.4.2 - 1.0

get /v1/data-ops-services/{data_ops_service_name}/check-duplication

Description

check duplication controller

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_service_name required	data ops service name Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services/{data_ops_service_name}/check-duplication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Example HTTP response

Response 200

2.1.5 - CreateDataOps

2.1.5.1 - 1.1

post /v1/data-ops

Description

create dataops

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
body	body required		DataOpsCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Request body

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "data_ops_name": "",
    "description": "",
    "domain": "",
    "dsc_domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "image_id": "",
    "ingress_controller_name": "",
    "instance_id": "",
    "node_selector": "",
    "storage_class_name": "",
    "tags": [
        {
            "tag_key": "",
            "tag_value": ""
        }
    ]
}

Example HTTP response

Response 202

2.1.5.2 - 1.0

post /v1/data-ops

Description

create dataops

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
body	body required		DataOpsCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Request body

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "data_ops_name": "",
    "description": "",
    "domain": "",
    "dsc_domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "image_id": "",
    "ingress_controller_name": "",
    "instance_id": "",
    "node_selector": "",
    "storage_class_name": "",
    "tags": [
        {
            "tag_key": "",
            "tag_value": ""
        }
    ]
}

Example HTTP response

Response 202

2.1.6 - CreateDataOpsService

2.1.6.1 - 1.1

post /v1/data-ops-services

Description

create dataops service

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
body	body required		DataOpsServiceCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Request body

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "data_ops_id": "",
    "data_ops_service_name": "",
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "node_selector": "",
    "service_workload": {
        "scheduler": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "web_server": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "worker": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        }
    },
    "storage_class_name": "",
    "tags": [
        {
            "tag_key": "",
            "tag_value": ""
        }
    ],
    "worker_type": ""
}

Example HTTP response

Response 202

2.1.6.2 - 1.0

post /v1/data-ops-services

Description

create dataops service

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
body	body required		DataOpsServiceCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Request body

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "data_ops_id": "",
    "data_ops_service_name": "",
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "node_selector": "",
    "service_workload": {
        "scheduler": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "web_server": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "worker": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        }
    },
    "storage_class_name": "",
    "tags": [
        {
            "tag_key": "",
            "tag_value": ""
        }
    ],
    "worker_type": ""
}

Example HTTP response

Response 202

2.1.7 - DeleteDataOps

2.1.7.1 - 1.1

delete /v1/data-ops/{data_ops_id}

Description

delete dataops v1

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_id required	data ops ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops/{data_ops_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Example HTTP response

Response 202

2.1.7.2 - 1.0

delete /v1/data-ops/{data_ops_id}

Description

delete dataops v1

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_id required	data ops ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops/{data_ops_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Example HTTP response

Response 202

2.1.8 - DeleteDataOpsService

2.1.8.1 - 1.1

delete /v1/data-ops-services/{data_ops_service_id}

Description

delete data ops service

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_service_id required	data ops service ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services/{data_ops_service_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Example HTTP response

Response 202

2.1.8.2 - 1.0

delete /v1/data-ops-services/{data_ops_service_id}

Description

delete data ops service

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_service_id required	data ops service ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services/{data_ops_service_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Example HTTP response

Response 202

2.1.9 - ListDataOps

2.1.9.1 - 1.1

get /v1/data-ops

Description

{aianalytics.GetDataOpsListConsole.notes} v1.1

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
query	sort optional	sort Example : `created_dt:desc`	string	created_dt:desc
query	cluster_name optional	cluster_name Example :	string	None
query	created_by optional	created_by Example :	string	None
query	state optional	state Example :	enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING)	None
query	version optional	version Example :	string	None
query	size optional	size Example : `20`	integer	None
query	page optional	page Example : `0`	integer	None
query	cluster_id optional	cluster_id Example :	string	None
query	data_ops_name optional	data_ops_name Example :	string	None
query	region optional	region Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	ListDataOpsConsoleResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "account_id": "",
            "cluster_id": "",
            "cluster_name": "",
            "cluster_permission": {},
            "cluster_request_failed": false,
            "created_by": "",
            "created_dt": "2026-02-11T06:41:30.704Z",
            "data_ops_id": "",
            "data_ops_name": "",
            "image_id": "",
            "instance_id": "",
            "is_active_image": "",
            "modified_by": "",
            "modified_dt": "2026-02-11T06:41:30.710Z",
            "namespace_name": "",
            "state": "",
            "version": ""
        }
    ],
    "total_count": ""
}

2.1.9.2 - 1.0

get /v1/data-ops

Description

{aianalytics.GetDataOpsListConsole.notes}

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
query	sort optional	sort Example : `created_dt:desc`	string	created_dt:desc
query	cluster_name optional	cluster_name Example :	string	None
query	created_by optional	created_by Example :	string	None
query	state optional	state Example :	enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING)	None
query	version optional	version Example :	string	None
query	size optional	size Example : `20`	integer	None
query	page optional	page Example : `0`	integer	None
query	cluster_id optional	cluster_id Example :	string	None
query	data_ops_name optional	data_ops_name Example :	string	None
query	region optional	region Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	ListDataOpsConsoleResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "cluster_id": "",
            "cluster_name": "",
            "cluster_permission": {},
            "cluster_request_failed": false,
            "created_by": "",
            "created_dt": "2026-02-11T06:41:29.993Z",
            "data_ops_id": "",
            "data_ops_name": "",
            "image_id": "",
            "instance_id": "",
            "is_active_image": "",
            "modified_by": "",
            "modified_dt": "2026-02-11T06:41:30.000Z",
            "namespace_name": "",
            "state": "",
            "version": ""
        }
    ],
    "total_count": ""
}

2.1.10 - ListDataOpsImageVersions

2.1.10.1 - 1.1

get /v1/data-ops/image-versions

Description

get dataops image version v1

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi

Responses

HTTP Code	Description	Schema
200	OK	ImageVersionsResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops/image-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "image_attr": {
                "k8s.version": "",
                "os.type": ""
            },
            "image_id": "",
            "image_name": "",
            "version": ""
        }
    ],
    "total_count": ""
}

2.1.10.2 - 1.0

get /v1/data-ops/image-versions

Description

get dataops image version v1

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi

Responses

HTTP Code	Description	Schema
200	OK	ImageVersionsResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops/image-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "image_attr": {
                "k8s.version": "",
                "os.type": ""
            },
            "image_id": "",
            "image_name": "",
            "version": ""
        }
    ],
    "total_count": ""
}

2.1.11 - ListDataOpsIngressControllers

2.1.11.1 - 1.1

get /v1/data-ops/clusters/{cluster_id}/ingress-controllers

Description

get ingress controller list

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	cluster_id required	Cluster ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops/clusters/{cluster_id}/ingress-controllers

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Example HTTP response

Response 200

2.1.11.2 - 1.0

get /v1/data-ops/clusters/{cluster_id}/ingress-controllers

Description

get ingress controller list

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	cluster_id required	Cluster ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops/clusters/{cluster_id}/ingress-controllers

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Example HTTP response

Response 200

2.1.12 - ListDataOpsService

2.1.12.1 - 1.1

get /v1/data-ops-services

Description

GetDataOpsServiceListConsole v1.1

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
query	created_by optional	created_by Example :	string	None
query	state optional	state Example :	enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING)	None
query	sort optional	sort Example : `created_dt:desc`	string	created_dt:desc
query	size optional	size Example : `20`	integer	None
query	page optional	page Example : `0`	integer	None
query	data_ops_service_name optional	data_ops_service_name Example :	string	None
query	data_ops_name optional	data_ops_name Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	ListDataOpsServicesConsoleResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "account_id": "",
            "cluster_id": "",
            "cluster_name": "",
            "cluster_permission": {},
            "cluster_request_failed": false,
            "created_by": "",
            "created_dt": "2026-02-11T06:41:30.741Z",
            "data_ops_id": "",
            "data_ops_name": "",
            "data_ops_service_id": "",
            "data_ops_service_name": "",
            "description": "",
            "modified_by": "",
            "modified_dt": "2026-02-11T06:41:30.747Z",
            "state": "",
            "version": ""
        }
    ],
    "total_count": ""
}

2.1.12.2 - 1.0

get /v1/data-ops-services

Description

GetDataOpsServiceListConsole

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
query	created_by optional	created_by Example :	string	None
query	state optional	state Example :	enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING)	None
query	sort optional	sort Example : `created_dt:desc`	string	created_dt:desc
query	size optional	size Example : `20`	integer	None
query	page optional	page Example : `0`	integer	None
query	data_ops_service_name optional	data_ops_service_name Example :	string	None
query	data_ops_name optional	data_ops_name Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	ListDataOpsServicesConsoleResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "cluster_id": "",
            "cluster_name": "",
            "cluster_permission": {},
            "cluster_request_failed": false,
            "created_by": "",
            "created_dt": "2026-02-11T06:41:30.089Z",
            "data_ops_id": "",
            "data_ops_name": "",
            "data_ops_service_id": "",
            "data_ops_service_name": "",
            "description": "",
            "modified_by": "",
            "modified_dt": "2026-02-11T06:41:30.095Z",
            "state": "",
            "version": ""
        }
    ],
    "total_count": ""
}

2.1.13 - ShowDataOps

2.1.13.1 - 1.1

get /v1/data-ops/{data_ops_id}

Description

get dataops detail v1.1

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_id required	data ops ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataOpsDetailResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops/{data_ops_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Example HTTP response

Response 200

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "account_id": "",
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "created_dt": "2026-02-11T06:41:30.871Z",
    "data_ops_id": "",
    "data_ops_name": "",
    "description": "",
    "domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "is_active_image": "",
    "modified_dt": "2026-02-11T06:41:30.927Z",
    "namespace_name": "",
    "node_selector": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url": ""
}

2.1.13.2 - 1.0

get /v1/data-ops/{data_ops_id}

Description

get dataops detail

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_id required	data ops ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataOpsDetailResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops/{data_ops_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Example HTTP response

Response 200

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "created_dt": "2026-02-11T06:41:30.482Z",
    "data_ops_id": "",
    "data_ops_name": "",
    "description": "",
    "domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "is_active_image": "",
    "modified_dt": "2026-02-11T06:41:30.537Z",
    "namespace_name": "",
    "node_selector": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url": ""
}

2.1.14 - ShowDataOpsService

2.1.14.1 - 1.1

get /v1/data-ops-services/{data_ops_service_id}

Description

get data ops service v1.1

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_service_id required	data ops service ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataOpsServiceDetailResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services/{data_ops_service_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Example HTTP response

Response 200

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "account_id": "",
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "created_dt": "2026-02-11T06:41:30.772Z",
    "data_ops_id": "",
    "data_ops_name": "",
    "data_ops_service_id": "",
    "data_ops_service_name": "",
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "is_active_image": "",
    "modified_dt": "2026-02-11T06:41:30.828Z",
    "namespace_name": "",
    "node_selector": "",
    "service_workload": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url": ""
}

2.1.14.2 - 1.0

get /v1/data-ops-services/{data_ops_service_id}

Description

get data ops service

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_service_id required	data ops service ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataOpsServiceDetailResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services/{data_ops_service_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Example HTTP response

Response 200

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "created_dt": "2026-02-11T06:41:30.212Z",
    "data_ops_id": "",
    "data_ops_name": "",
    "data_ops_service_id": "",
    "data_ops_service_name": "",
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "is_active_image": "",
    "modified_dt": "2026-02-11T06:41:30.267Z",
    "namespace_name": "",
    "node_selector": "",
    "service_workload": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url": ""
}

2.1.15 - ShowDataOpsServiceSubVersion

2.1.15.1 - 1.1

get /v1/data-ops-services/data-ops/{data_ops_id}/sub-versions

Description

get data ops sub version

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_id required	data ops ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataOpsServiceImageResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services/data-ops/{data_ops_id}/sub-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Example HTTP response

Response 200

{
    "data_ops_service_count": "",
    "versions": {
        "scheduler": "",
        "webserver": "",
        "worker": ""
    }
}

2.1.15.2 - 1.0

get /v1/data-ops-services/data-ops/{data_ops_id}/sub-versions

Description

get data ops sub version

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_id required	data ops ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DataOpsServiceImageResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services/data-ops/{data_ops_id}/sub-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Example HTTP response

Response 200

{
    "data_ops_service_count": "",
    "versions": {
        "scheduler": "",
        "webserver": "",
        "worker": ""
    }
}

2.1.16 - UpdateDataOps

2.1.16.1 - 1.1

put /v1/data-ops/{data_ops_id}

Description

update dataops v1

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_id required	data ops ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None
body	body required		DataOpsUpdateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	DataOpsUpdateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops/{data_ops_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Request body

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "description": "",
    "domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "node_selector": ""
}

Example HTTP response

Response 202

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "created_dt": "2026-02-11T06:41:30.617Z",
    "data_ops_id": "",
    "data_ops_name": "",
    "description": "",
    "domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "modified_dt": "2026-02-11T06:41:30.665Z",
    "namespace_name": "",
    "node_selector": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url": ""
}

2.1.16.2 - 1.0

put /v1/data-ops/{data_ops_id}

Description

update dataops v1

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_id required	data ops ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None
body	body required		DataOpsUpdateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	DataOpsUpdateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops/{data_ops_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Request body

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "description": "",
    "domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "node_selector": ""
}

Example HTTP response

Response 202

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "created_dt": "2026-02-11T06:41:30.617Z",
    "data_ops_id": "",
    "data_ops_name": "",
    "description": "",
    "domain": "",
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ],
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "modified_dt": "2026-02-11T06:41:30.665Z",
    "namespace_name": "",
    "node_selector": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url": ""
}

2.1.17 - UpdateDataOpsService

2.1.17.1 - 1.1

put /v1/data-ops-services/{data_ops_service_id}

Description

update data ops service

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_service_id required	data ops service ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None
body	body required		DataOpsServiceUpdateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	DataOpsServiceUpdateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services/{data_ops_service_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.1"

Request body

{
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "node_selector": "",
    "service_workload": {
        "scheduler": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "web_server": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "worker": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        }
    },
    "worker_type": ""
}

Example HTTP response

Response 202

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "created_dt": "2026-02-11T06:41:30.347Z",
    "data_ops_id": "",
    "data_ops_name": "",
    "data_ops_service_id": "",
    "data_ops_service_name": "",
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "modified_dt": "2026-02-11T06:41:30.395Z",
    "namespace_name": "",
    "node_selector": "",
    "service_workload": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url": ""
}

2.1.17.2 - 1.0

put /v1/data-ops-services/{data_ops_service_id}

Description

update data ops service

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
header	Accept optional	Accept Example : `application/json`	string	application/json
header	Content-Type optional	Content-Type Example : `application/json`	string	application/json
header	Scp-Request-Path optional	Scp-Request-Path Example : `openapi`	string	openapi
path	data_ops_service_id required	data ops service ID Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	string	None
body	body required		DataOpsServiceUpdateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	DataOpsServiceUpdateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/data-ops-services/{data_ops_service_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = data-ops 1.0"

Request body

{
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "node_selector": "",
    "service_workload": {
        "scheduler": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "web_server": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        },
        "worker": {
            "cpu": "",
            "memory": "",
            "replica": "",
            "version": ""
        }
    },
    "worker_type": ""
}

Example HTTP response

Response 202

{
    "account": {
        "account_id": "",
        "account_password": ""
    },
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "created_dt": "2026-02-11T06:41:30.347Z",
    "data_ops_id": "",
    "data_ops_name": "",
    "data_ops_service_id": "",
    "data_ops_service_name": "",
    "description": "",
    "domain": "",
    "host_alias": {
        "enabled": "true",
        "host_alias_list": [
            {
                "hostname": "",
                "ip": ""
            }
        ]
    },
    "hosts_file": "",
    "http_port": "",
    "https_port": "",
    "image_id": "",
    "ingress_class_name": "",
    "instance_id": "",
    "modified_dt": "2026-02-11T06:41:30.395Z",
    "namespace_name": "",
    "node_selector": "",
    "service_workload": "",
    "state": "",
    "storage_class_name": "",
    "version": "",
    "web_url": ""
}

2.2 - Models

2.2.1 - ClusterResourceCheckResponse

Name	Description	Schema	Default
cpu optional	Example : `CPU`	object	CPU
err_code required	Error code Example :	string
memory optional	Example : `Memory`	object	Memory
result required	Cluster resource check result Example :	boolean

2.2.2 - DataOpsConsoleResponse

Name	Description	Schema
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	object
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_by required	created_by Example :	string
created_dt required	created_at Example : `2026-02-11T06:41:29.993Z`	string (date-time)
data_ops_id required	data_ops_id Example :	string
data_ops_name required	data_ops_name Example :	string
image_id required	image_id Example :	string
instance_id required	instance_id Example :	any of [string, null]
is_active_image required	is_active_image Example :	boolean
modified_by required	modified_by Example :	string
modified_dt required	modified_at Example : `2026-02-11T06:41:30.000Z`	string (date-time)
namespace_name required	namespace_name Example :	string
state required	state Example :	string
version required	version Example :	string

2.2.3 - DataOpsConsoleResponseV1Dot1

Name	Description	Schema
account_id required	account_id Example :	string
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	object
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_by required	created_by Example :	string
created_dt required	created_at Example : `2026-02-11T06:41:30.704Z`	string (date-time)
data_ops_id required	data_ops_id Example :	string
data_ops_name required	data_ops_name Example :	string
image_id required	image_id Example :	string
instance_id required	instance_id Example :	any of [string, null]
is_active_image required	is_active_image Example :	boolean
modified_by required	modified_by Example :	string
modified_dt required	modified_at Example : `2026-02-11T06:41:30.710Z`	string (date-time)
namespace_name required	namespace_name Example :	string
state required	state Example :	string
version required	version Example :	string

2.2.4 - DataOpsCreateRequest

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
cluster_id required	cluster_id Example :	string
data_ops_name required	data_ops_name Example : Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `30`	string
description optional	description Example :	any of [string, null]
domain required	domain Example : Minimum length : `3` Maximum length : `50`	string
dsc_domain optional	dsc_domain Example :	any of [string, null]
host_alias_list required	host_alias_list Example : `[{'hostnames': [''], 'ip': ''}]`	array[object]
image_id required	image_id Example :	string
ingress_controller_name required	ingress_controller_name Example :	string
instance_id optional	instance_id Example :	any of [string, null]
node_selector optional	node_selector Example :	any of [string, null]
storage_class_name required	storage_class_name Example :	string
tags optional	tags	array[Tag]

2.2.5 - DataOpsDetailResponse

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_dt required	created_dt Example : `2026-02-11T06:41:30.482Z`	string (date-time)
data_ops_id required	data_ops_id Example :	string
data_ops_name required	data_ops_name Example :	string
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias_list optional	host_alias Example : `[{'hostnames': [''], 'ip': ''}]`	any of [array[object], null]
hosts_file optional	hosts_file Example :	any of [string, null]
http_port optional	http_port Example :	any of [integer, null]
https_port optional	https_port Example :	any of [integer, null]
image_id required	image_id Example :	string
ingress_class_name optional	ingress_class_name Example :	any of [string, null]
instance_id required	instance_id Example :	any of [string, null]
is_active_image optional	is_active_image Example :	any of [boolean, null]
modified_dt required	modified_dt Example : `2026-02-11T06:41:30.537Z`	string (date-time)
namespace_name required	namespace_name Example :	string
node_selector optional	node_selector Example :	any of [string, null]
state required	state Example :	string
storage_class_name required	storage_class_name Example :	string
version required	version Example :	string
web_url optional	web_url Example :	any of [string, null]

2.2.6 - DataOpsDetailResponseV1Dot1

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
account_id required	account_id Example :	string
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_dt required	created_dt Example : `2026-02-11T06:41:30.871Z`	string (date-time)
data_ops_id required	data_ops_id Example :	string
data_ops_name required	data_ops_name Example :	string
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias_list optional	host_alias Example : `[{'hostnames': [''], 'ip': ''}]`	any of [array[object], null]
hosts_file optional	hosts_file Example :	any of [string, null]
http_port optional	http_port Example :	any of [integer, null]
https_port optional	https_port Example :	any of [integer, null]
image_id required	image_id Example :	string
ingress_class_name optional	ingress_class_name Example :	any of [string, null]
instance_id required	instance_id Example :	any of [string, null]
is_active_image optional	is_active_image Example :	any of [boolean, null]
modified_dt required	modified_dt Example : `2026-02-11T06:41:30.927Z`	string (date-time)
namespace_name required	namespace_name Example :	string
node_selector optional	node_selector Example :	any of [string, null]
state required	state Example :	string
storage_class_name required	storage_class_name Example :	string
version required	version Example :	string
web_url optional	web_url Example :	any of [string, null]

2.2.7 - DataOpsServiceCreateRequest

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
data_ops_id required	data_ops_id Example :	string
data_ops_service_name required	data_ops_service_name Example : Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `30`	string
description optional	description Example :	any of [string, null]
domain required	description Example : Minimum length : `3` Maximum length : `50`	string
host_alias required	host_alias Example : `{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}`	object
node_selector optional	node_selector Example :	any of [string, null]
service_workload required	service_workload Example : `{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}`	object
storage_class_name required	storage_class_name Example :	string
tags optional	tags	array[Tag]
worker_type required	worker_type Example :	string

2.2.8 - DataOpsServiceDetailResponse

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_dt required	created_dt Example : `2026-02-11T06:41:30.212Z`	string (date-time)
data_ops_id required	data_ops_id Example :	string
data_ops_name required	data_ops_name Example :	string
data_ops_service_id required	data_ops_service_id Example :	string
data_ops_service_name required	data_ops_service_name Example :	string
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias optional	host_alias Example : `{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}`	any of [object, null]
hosts_file optional	hosts_file Example :	any of [string, null]
http_port optional	http_port Example :	any of [integer, null]
https_port optional	https_port Example :	any of [integer, null]
image_id required	image_id Example :	string
ingress_class_name optional	ingress_class_name Example :	any of [string, null]
instance_id required	instance_id Example :	any of [string, null]
is_active_image optional	is_active_image Example :	any of [boolean, null]
modified_dt required	modified_dt Example : `2026-02-11T06:41:30.267Z`	string (date-time)
namespace_name required	namespace_name Example :	string
node_selector optional	node_selector Example :	any of [string, null]
service_workload optional	service_workload Example :	any of [object, null]
state required	state Example :	string
storage_class_name required	storage_class_name Example :	string
version required	version Example :	string
web_url optional	web_url Example :	any of [string, null]

2.2.9 - DataOpsServiceDetailResponseV1Dot1

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
account_id required	account_id Example :	string
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_dt required	created_dt Example : `2026-02-11T06:41:30.772Z`	string (date-time)
data_ops_id required	data_ops_id Example :	string
data_ops_name required	data_ops_name Example :	string
data_ops_service_id required	data_ops_service_id Example :	string
data_ops_service_name required	data_ops_service_name Example :	string
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias optional	host_alias Example : `{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}`	any of [object, null]
hosts_file optional	hosts_file Example :	any of [string, null]
http_port optional	http_port Example :	any of [integer, null]
https_port optional	https_port Example :	any of [integer, null]
image_id required	image_id Example :	string
ingress_class_name optional	ingress_class_name Example :	any of [string, null]
instance_id required	instance_id Example :	any of [string, null]
is_active_image optional	is_active_image Example :	any of [boolean, null]
modified_dt required	modified_dt Example : `2026-02-11T06:41:30.828Z`	string (date-time)
namespace_name required	namespace_name Example :	string
node_selector optional	node_selector Example :	any of [string, null]
service_workload optional	service_workload Example :	any of [object, null]
state required	state Example :	string
storage_class_name required	storage_class_name Example :	string
version required	version Example :	string
web_url optional	web_url Example :	any of [string, null]

2.2.10 - DataOpsServiceImageResponse

Name	Description	Schema	Default
data_ops_service_count optional	DataOpsService count Example :	integer
versions optional	image versions	DataOpsServiceSubVersionResponse

2.2.11 - DataOpsServicesConsoleResponse

Name	Description	Schema
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_by required	created_by Example :	string
created_dt required	created_at Example : `2026-02-11T06:41:30.089Z`	string (date-time)
data_ops_id required	data_ops_id Example :	string
data_ops_name required	data_ops_name Example :	string
data_ops_service_id required	data_ops_service_id Example :	string
data_ops_service_name required	data_ops_service_name Example :	string
description optional	description Example :	any of [string, null]
modified_by required	modified_by Example :	string
modified_dt required	modified_at Example : `2026-02-11T06:41:30.095Z`	string (date-time)
state required	state Example :	string
version required	version Example :	string

2.2.12 - DataOpsServicesConsoleResponseV1Dot1

Name	Description	Schema
account_id required	account_id Example :	string
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_by required	created_by Example :	string
created_dt required	created_at Example : `2026-02-11T06:41:30.741Z`	string (date-time)
data_ops_id required	data_ops_id Example :	string
data_ops_name required	data_ops_name Example :	string
data_ops_service_id required	data_ops_service_id Example :	string
data_ops_service_name required	data_ops_service_name Example :	string
description optional	description Example :	any of [string, null]
modified_by required	modified_by Example :	string
modified_dt required	modified_at Example : `2026-02-11T06:41:30.747Z`	string (date-time)
state required	state Example :	string
version required	version Example :	string

2.2.13 - DataOpsServiceSubVersionResponse

Name	Description	Schema
scheduler required	scheduler Example :	string
webserver required	webserver Example :	string
worker required	worker Example :	string

2.2.14 - DataOpsServiceUpdateRequest

Name	Description	Schema
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias optional	host_alias Example : `{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}`	any of [object, null]
node_selector optional	node_selector Example :	any of [string, null]
service_workload optional	service_workload Example : `{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}`	object
worker_type optional	worker_type Example :	string

2.2.15 - DataOpsServiceUpdateResponse

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_dt required	created_dt Example : `2026-02-11T06:41:30.347Z`	string (date-time)
data_ops_id required	data_ops_id Example :	string
data_ops_name required	data_ops_name Example :	string
data_ops_service_id required	data_ops_service_id Example :	string
data_ops_service_name required	data_ops_service_name Example :	string
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias optional	host_alias Example : `{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}`	any of [object, null]
hosts_file optional	hosts_file Example :	any of [string, null]
http_port optional	http_port Example :	any of [integer, null]
https_port optional	https_port Example :	any of [integer, null]
image_id required	image_id Example :	string
ingress_class_name optional	ingress_class_name Example :	any of [string, null]
instance_id required	instance_id Example :	any of [string, null]
modified_dt required	modified_dt Example : `2026-02-11T06:41:30.395Z`	string (date-time)
namespace_name required	namespace_name Example :	string
node_selector optional	node_selector Example :	any of [string, null]
service_workload optional	service_workload Example :	any of [object, null]
state required	state Example :	string
storage_class_name required	storage_class_name Example :	string
version required	version Example :	string
web_url optional	web_url Example :	any of [string, null]

2.2.16 - DataOpsServiceValidateResourceRequest

Name	Description	Schema	Default
service_workload required	service_workload Example : `{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}`	object

2.2.17 - DataOpsUpdateRequest

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias_list optional	host_alias Example : `[{'hostnames': [''], 'ip': ''}]`	any of [array[object], null]
node_selector optional	node_selector Example :	any of [string, null]

2.2.18 - DataOpsUpdateResponse

Name	Description	Schema
account optional	account Example : `{'account_id': '', 'account_password': ''}`	any of [object, null]
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	any of [object, null]
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_dt required	created_dt Example : `2026-02-11T06:41:30.617Z`	string (date-time)
data_ops_id required	data_ops_id Example :	string
data_ops_name required	data_ops_name Example :	string
description optional	description Example :	any of [string, null]
domain optional	domain Example :	any of [string, null]
host_alias_list optional	host_alias Example : `[{'hostnames': [''], 'ip': ''}]`	any of [array[object], null]
hosts_file optional	hosts_file Example :	any of [string, null]
http_port optional	http_port Example :	any of [integer, null]
https_port optional	https_port Example :	any of [integer, null]
image_id required	image_id Example :	string
ingress_class_name optional	ingress_class_name Example :	any of [string, null]
instance_id required	instance_id Example :	any of [string, null]
modified_dt required	modified_dt Example : `2026-02-11T06:41:30.665Z`	string (date-time)
namespace_name required	namespace_name Example :	string
node_selector optional	node_selector Example :	any of [string, null]
state required	state Example :	string
storage_class_name required	storage_class_name Example :	string
version required	version Example :	string
web_url optional	web_url Example :	any of [string, null]

2.2.19 - ImageAttr

Name	Description	Schema
image_attr required	image_attr	QuickQueryImageAttr
image_id required	image_id Example :	string
image_name required	image_name Example :	string
version required	version Example :	string

2.2.20 - ImageVersionsResponse

Name	Description	Schema	Default
contents required	contents	array[ImageAttr]
total_count required	total_count Example :	integer

2.2.21 - ListDataOpsConsoleResponse

Name	Description	Schema	Default
contents optional		array[DataOpsConsoleResponse]
total_count required	total_count Example :	integer

2.2.22 - ListDataOpsConsoleResponseV1Dot1

Name	Description	Schema	Default
contents optional		array[DataOpsConsoleResponseV1Dot1]
total_count required	total_count Example :	integer

2.2.23 - ListDataOpsServicesConsoleResponse

Name	Description	Schema	Default
contents optional		array[DataOpsServicesConsoleResponse]
total_count required	total_count Example :	integer

2.2.24 - ListDataOpsServicesConsoleResponseV1Dot1

Name	Description	Schema	Default
contents optional		array[DataOpsServicesConsoleResponseV1Dot1]
total_count required	total_count Example :	integer

2.2.25 - QuickQueryImageAttr

Name	Description	Schema	Default
k8s.version optional	k8s_version Example :	string
os.type optional	os_type Example :	string

2.2.26 - Tag

Name	Description	Schema	Default
tag_key required	tag_key Example : Pattern : `^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]$` Maximum length* : `128`	string
tag_value optional	tag_value Example : Pattern : `^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]$` Maximum length* : `256`	string

3 - Event Streams

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Event Streams 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	CURRENT	-

OpenAPI URL

https://eventstreams.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

3.1 - APIs

3.1.1 - Add Instances

3.1.1.1 - 1.0

post /v1/clusters/{cluster_id}/add-instances

Description

Add Instances.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		EventStreamsClusterAddInstancesRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/add-instances

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Request body

{
    "instance_count": "",
    "public_ip_ids": [
        ""
    ],
    "service_ip_addresses": [
        ""
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

3.1.2 - Create Cluster

3.1.2.1 - 1.0

post /v1/clusters

Description

Create Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		EventStreamsClusterCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Request body

{
    "akhq_enabled": false,
    "allowable_ip_addresses": [],
    "dbaas_engine_version_id": "",
    "init_config_option": {
        "akhq_id": "",
        "akhq_password": "",
        "broker_port": 9091,
        "broker_sasl_id": "",
        "broker_sasl_password": "",
        "zookeeper_port": 2180,
        "zookeeper_sasl_id": "",
        "zookeeper_sasl_password": ""
    },
    "instance_groups": [
        {
            "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": ""
        }
    ],
    "instance_name_prefix": "",
    "is_combined": false,
    "maintenance_option": {
        "period_hour": "",
        "starting_day_of_week": "MON",
        "starting_time": ""
    },
    "name": "",
    "nat_enabled": false,
    "subnet_id": "",
    "tags": [],
    "timezone": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

3.1.3 - List Clusters

3.1.3.1 - 1.0

get /v1/clusters

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	name:asc
query	name optional	Cluster name Example :	any of [string, null]	None
query	service_state optional	Service state Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ClusterPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "ha_enabled": false,
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "instance_count": 0,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "role_type": "ORIGIN",
            "service_state": "RUNNING"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3.1.4 - List Engine Version Properties

3.1.4.1 - 1.0

get /v1/engine-versions/{dbaas_engine_version_id}/properties

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	dbaas_engine_version_id required	DBaaS engine version ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	EnginePropertyListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/engine-versions/{dbaas_engine_version_id}/properties

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "name": "",
            "value": ""
        }
    ]
}

3.1.5 - List Engine Versions

3.1.5.1 - 1.0

get /v1/engine-versions

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	id optional	DBaaS engine version ID Example :	any of [string, null]	None
query	product_image_type optional	Product image type Example :	any of [enum (PostgreSQL Community, MariaDB Community, MySQL Community, EPAS, Microsoft SQL Server Enterprise, Microsoft SQL Server Standard, Redis OSS Sentinel, Valkey Sentinel, Kafka, Elasticsearch Enterprise, OpenSearch, Vertica Enterprise, Vertica Community, Scalable DB MariaDB Community), null]	None
query	eos_included optional	EoS included Example : `False`	boolean	False

Responses

HTTP Code	Description	Schema
200	OK	EngineListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/engine-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "end_of_service": false,
            "id": "",
            "major_version": "",
            "name": "",
            "os_type": "",
            "os_version": "",
            "product_image_type": "",
            "software_version": ""
        }
    ]
}

3.1.6 - List Parameter Groups

3.1.6.1 - 1.0

get /v1/parameter-groups

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	major_version optional	Software major version Example :	any of [string, null]	None
query	product_image_type optional	Product image type Example :	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	name:asc

Responses

HTTP Code	Description	Schema
200	OK	ParameterGroupListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/parameter-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "id": "",
            "major_version": "",
            "name": "",
            "product_image_type": "",
            "product_type": ""
        }
    ],
    "sort": [
        ""
    ]
}

3.1.7 - List Parameter Values

3.1.7.1 - 1.0

get /v1/clusters/{cluster_id}/parameters

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	ParametersResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/parameters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "allows_value": "",
            "applied_value": "",
            "apply_type": "",
            "data_type": "",
            "default_value": "",
            "description": "",
            "id": "",
            "is_modifiable": "",
            "name": "",
            "software_type": ""
        }
    ],
    "count": "",
    "modified_at": ""
}

3.1.8 - List Parameters

3.1.8.1 - 1.0

get /v1/parameters

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	name:asc
query	dbaas_parameter_group_id required	Parameter group ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	ParameterPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/parameters?dbaas_parameter_group_id={dbaas_parameter_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "dbaas_parameter_group_id": "",
            "default_value": "",
            "description": "",
            "id": "",
            "name": "",
            "software_type": ""
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3.1.9 - List Server Types

3.1.9.1 - 1.0

get /v1/server-types

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	name optional	Server type name Example :	any of [string, null]	None
query	product_image_type optional	Product image type Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ServerTypeListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-types

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "cpu_core": "",
            "description": "",
            "memory_gb": "",
            "name": "",
            "product_image_type": "",
            "product_type": "",
            "purpose": "",
            "type": ""
        }
    ]
}

3.1.10 - Restart Cluster

3.1.10.1 - 1.0

post /v1/clusters/{cluster_id}/restart

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/restart

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

3.1.11 - Set Block Storage Size

3.1.11.1 - 1.0

post /v1/block-storage-groups/{block_storage_group_id}/resize

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	block_storage_group_id required	Block storage group ID Example : `afc33891202643ba8ba1a5298a1affff`	string	None
body	body required		ResizeBlockStorageGroupRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/block-storage-groups/{block_storage_group_id}/resize

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Request body

{
    "size_gb": 16
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

3.1.12 - Set Maintenance

3.1.12.1 - 1.0

post /v1/clusters/{cluster_id}/maintenance

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		MaintenanceRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/maintenance

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Request body

{
    "start_day_of_week": "MON",
    "start_minute": "",
    "start_time": "",
    "term_hour": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

3.1.13 - Set Parameter Values

3.1.13.1 - 1.0

put /v1/clusters/{cluster_id}/parameters

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		ParametersRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/parameters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Request body

{
    "parameters": [
        {
            "id": "",
            "new_value": "",
            "old_value": ""
        }
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

3.1.14 - Set Security Group Rules

3.1.14.1 - 1.0

post /v1/clusters/{cluster_id}/security-group-rules

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		UpdateSecurityGroupRulesRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/security-group-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Request body

{
    "add_ip_addresses": [],
    "del_ip_addresses": []
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

3.1.15 - Set Server Type

3.1.15.1 - 1.0

post /v1/instance-groups/{instance_group_id}/resize

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	instance_group_id required	Instance group ID Example :	string	None
body	body required		InstanceGroupResizeRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/instance-groups/{instance_group_id}/resize

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Request body

{
    "server_type_name": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

3.1.16 - Show Cluster

3.1.16.1 - 1.0

get /v1/clusters/{cluster_id}

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	EventStreamsClusterDetailResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 200

{
    "account_id": "",
    "allowable_ip_addresses": [],
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "dbaas_engine": "",
    "dbaas_engine_version_name": "",
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "init_config_option": {
        "broker_port": 9091,
        "zookeeper_port": 2180
    },
    "instance_count": 0,
    "instance_groups": [
        {
            "block_storage_groups": [
                {
                    "id": "",
                    "name": "",
                    "role_type": "OS",
                    "size_gb": "",
                    "volume_type": "SSD"
                }
            ],
            "id": "",
            "instances": [
                {
                    "name": "",
                    "public_ip_address": "",
                    "public_ip_id": "",
                    "role_type": "",
                    "service_ip_address": "",
                    "service_state": "RUNNING"
                }
            ],
            "role_type": "",
            "server_type_name": ""
        }
    ],
    "is_combined": "",
    "maintenance_option": {
        "period_hour": "",
        "starting_day_of_week": "MON",
        "starting_time": "",
        "use_maintenance_option": false
    },
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "",
    "nat_enabled": "",
    "product_image_type": "",
    "product_type": "Event Streams",
    "role_type": "ORIGIN",
    "service_state": "RUNNING",
    "software_version": "",
    "subnet_id": "",
    "timezone": ""
}

3.1.17 - Show Request

3.1.17.1 - 1.0

get /v1/requests/{request_id}

Description

Show Request.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	request_id required	Request ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	RequestStateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/requests/{request_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 200

{
    "request_id": "",
    "state": ""
}

3.1.18 - Start Cluster

3.1.18.1 - 1.0

post /v1/clusters/{cluster_id}/start

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/start

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

3.1.19 - Stop Cluster

3.1.19.1 - 1.0

post /v1/clusters/{cluster_id}/stop

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/stop

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

3.1.20 - Synchronize Cluster State

3.1.20.1 - 1.0

post /v1/clusters/{cluster_id}/sync-state

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/sync-state

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

3.1.21 - Synchronize Parameter Values

3.1.21.1 - 1.0

post /v1/clusters/{cluster_id}/parameters/sync

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/parameters/sync

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

3.1.22 - Terminate Cluster

3.1.22.1 - 1.0

delete /v1/clusters/{cluster_id}

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

3.1.23 - Unset Maintenance

3.1.23.1 - 1.0

delete /v1/clusters/{cluster_id}/maintenance

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/maintenance

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = eventstreams 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

3.2 - Models

3.2.1 - AsyncResponse

Name	Description	Schema	Default
request_id required	Request ID Example : `req-4f668846-8a3d-49f1-8111-451ebccf445c`	string
resource required	Resource	ResourceInfo

3.2.2 - BlockStorageGroupRequest

Name	Description	Schema	Default
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example : `104` Minimum : `16` Maximum : `5120`	integer
volume_type optional	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)	SSD

3.2.3 - BlockStorageGroupResponse

Name	Description	Schema
id required	ID Example :	string
name required	Name Example :	string
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example :	integer
volume_type required	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)

3.2.4 - ClusterPageResponse

Name	Description	Schema
contents required	Clusters list	any of [array[ClusterResponse], null]
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

3.2.5 - ClusterResponse

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
ha_enabled optional	HA availability Example : `False`	boolean
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
instance_count optional	Instance Count Example : `0`	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster name Example :	string
role_type required	Role type Example : `ORIGIN`	any of [enum (ORIGIN, REPLICA, RECOVERY, SECONDARY, MIGRATION), null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)

3.2.6 - Engine

Name	Description	Schema
end_of_service optional	End of Service Example : `False`	boolean
id required	ID Example :	string
major_version required	Software major version Example :	string
name required	DBaaS engine version name Example :	string
os_type required	OS type Example :	string
os_version required	OS version Example :	string
product_image_type optional	Product type Example :	any of [string, null]
software_version required	Software version Example :	string

3.2.7 - EngineListResponse

Name	Description	Schema	Default
contents required	DBaaS engine list	array[Engine]

3.2.8 - EngineProperty

Name	Description	Schema	Default
name required	DBaas engine property name Example :	string
value required	DBaas engine property value Example :	string

3.2.9 - EnginePropertyListResponse

Name	Description	Schema	Default
contents required	DBaas engine property list	array[EngineProperty]

3.2.10 - EventStreamsClusterAddInstancesRequest

Name	Description	Schema
instance_count required	Instance Count Example :	integer
public_ip_ids optional	Public IP ID List Example :	any of [array[string], null]
service_ip_addresses required	User subnet IP address	array[string]

3.2.11 - EventStreamsClusterCreateRequest

Name	Description	Schema
akhq_enabled optional	AKHQ availability Example : `False`	boolean
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
dbaas_engine_version_id required	DBaaS engine version ID Example :	string
init_config_option required	DB initial configuration option	EventStreamsInitConfigOptionRequest
instance_groups required	Instance groups list	array[InstanceGroupRequest]
instance_name_prefix required	Instance name prefix Example : Pattern : `^[a-z][a-zA-Z0-9\-]$` Minimum length* : `3` Maximum length : `13`	string
is_combined optional	HA availability Example : `False`	boolean
maintenance_option optional	Maintenance option	any of [MaintenanceOption, null]
name required	Cluster name Example : Pattern : `^[a-zA-Z]$` Minimum length* : `3` Maximum length : `20`	string
nat_enabled optional	NAT availability Example : `False`	boolean
subnet_id required	Subnet ID Example :	string
tags optional	tag	any of [array[Tag], null]
timezone required	Timezone Example :	string

3.2.12 - EventStreamsClusterDetailResponse

Name	Description	Schema
account_id required	Account ID Example :	string
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
dbaas_engine required	DBaaS engine Example :	string
dbaas_engine_version_name required	DBaaS engine version name Example :	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
init_config_option required	DB initial configuration option	EventStreamsInitConfigOptionDetail
instance_count optional	Instance Count Example : `0`	integer
instance_groups required	Instance groups list	array[InstanceGroupResponse]
is_combined optional	Master Data server separation state Example :	any of [boolean, null]
maintenance_option optional	Maintenance option	any of [MaintenanceResponseOption, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster name Example :	string
nat_enabled optional	NAT availability Example :	any of [boolean, null]
product_image_type required	Product image type Example :	string
product_type required	Product type Example : `Event Streams`	enum (QOS, PostgreSQL Community, EPAS, MariaDB, MySQL, Redis, Microsoft SQL Server, Search Engine, Event Streams, Vertica, Scalable DB)
role_type required	Role type Example : `ORIGIN`	any of [enum (ORIGIN, REPLICA, RECOVERY, SECONDARY, MIGRATION), null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)
software_version required	Software version Example :	string
subnet_id required	Subnet ID Example :	string
timezone required	Timezone Example :	string

3.2.13 - EventStreamsInitConfigOptionDetail

Name	Description	Schema	Default
broker_port optional	broker port Example : `9091` Minimum : `1024` Maximum : `65535`	integer	9091
zookeeper_port optional	zookeeper port Example : `2180` Minimum : `1024` Maximum : `65535`	integer	2180

3.2.14 - EventStreamsInitConfigOptionRequest

Name	Description	Schema	Default
akhq_id optional	akhq id Example : Pattern : `^[a-z]+$`	any of [string, null]
akhq_password optional	akhq password Example :	any of [string, null]
broker_port optional	broker port Example : `9091` Minimum : `1024` Maximum : `65535`	integer	9091
broker_sasl_id required	broker sasl id Example : Pattern : `^[a-z]+$` Minimum length : `2` Maximum length : `20`	string
broker_sasl_password required	broker sasl password Example : Maximum length : `30`	string
zookeeper_port optional	zookeeper port Example : `2180` Minimum : `1024` Maximum : `65535`	integer	2180
zookeeper_sasl_id required	zookeeper sasl id Example : Pattern : `^[a-z]+$` Minimum length : `2` Maximum length : `20`	string
zookeeper_sasl_password required	zookeeper sasl password Example : Maximum length : `30`	string

3.2.15 - InstanceGroupRequest

Name	Description	Schema
block_storage_groups required	Block storage groups list	array[BlockStorageGroupRequest]
instances optional	Instances list	any of [array[InstanceRequest], null]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, ACTIVE_STANDBY, PRIMARY_SECONDARY, MASTER, MASTER_REPLICA, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, PRIMARY, PRIMARY_NODE, READ_NODE)
server_type_name required	Server type name Example :	string

3.2.16 - InstanceGroupResizeRequest

Name	Description	Schema	Default
server_type_name required	Server type name Example :	string

3.2.17 - InstanceGroupResponse

Name	Description	Schema
block_storage_groups required	Block storage groups list	array[BlockStorageGroupResponse]
id required	ID Example :	string
instances required	Instances list	array[InstanceResponse]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, ACTIVE_STANDBY, PRIMARY_SECONDARY, MASTER, MASTER_REPLICA, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, PRIMARY, PRIMARY_NODE, READ_NODE)
server_type_name required	Server type name Example :	string

3.2.18 - InstanceRequest

Name	Description	Schema
public_ip_id optional	Public IP ID Example :	any of [string, null]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, STANDBY, PRIMARY, SECONDARY, MASTER, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, READ_REPLICA)
service_ip_address optional	User subnet IP address Example :	any of [string, null]

3.2.19 - InstanceResponse

Name	Description	Schema
name required	Name Example :	string
public_ip_address optional	Public IP Address Example :	any of [string, null]
public_ip_id optional	Public IP ID Example :	any of [string, null]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, STANDBY, PRIMARY, SECONDARY, MASTER, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, READ_REPLICA)
service_ip_address optional	User subnet IP address Example :	any of [string, null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)

3.2.20 - MaintenanceOption

Name	Description	Schema
period_hour optional	Period in hours Example : Pattern : `^(0\.5\|[1-5]\.5\|[1-9]\|1[0-9]\|2[0-4])$`	string
starting_day_of_week optional	Starting day of week Example : `MON`	enum (MON, TUE, WED, THU, FRI, SAT, SUN)
starting_time optional	Starting time Example :	string

3.2.21 - MaintenanceRequest

Name	Description	Schema
start_day_of_week required	start_day_of_week Example : `MON`	enum (MON, TUE, WED, THU, FRI, SAT, SUN)
start_minute required	start_minute Example :	string
start_time required	start_time Example :	string
term_hour required	term_hour Example : Pattern : `^(0\.5\|[1-5]\.5\|[1-9]\|1[0-9]\|2[0-4])$`	string

3.2.22 - MaintenanceResponseOption

Name	Description	Schema
period_hour optional	Period in hours Example :	any of [string, null]
starting_day_of_week optional	Starting day of week Example : `MON`	any of [enum (MON, TUE, WED, THU, FRI, SAT, SUN), null]
starting_time optional	Starting time Example :	any of [string, null]
use_maintenance_option optional	Maintenance period usage state Example : `False`	boolean

3.2.23 - ParameterDTO

Name	Description	Schema
allows_value required	Parameter allows value Example :	string
applied_value required	Parameter applied value Example :	string
apply_type required	Parameter apply type Example :	string
data_type required	Parameter data type Example :	string
default_value required	Parameter default value Example :	string
description required	Parameter description Example :	any of [string, null]
id required	Parameter id Example :	string
is_modifiable required	Parameter is_modifiable Example :	boolean
name required	Parameter name Example :	string
software_type required	Parameter software type Example :	any of [string, null]

3.2.24 - ParameterGroup

Name	Description	Schema
id required	Parameter group ID Example :	string
major_version required	Software major version Example :	string
name required	Parameter group name Example :	string
product_image_type required	Product image type Example :	string
product_type required	Product type Example :	string

3.2.25 - ParameterGroupListResponse

Name	Description	Schema	Default
contents required	Parameter group list	array[ParameterGroup]
sort optional	sort Example :	any of [array[string], null]

3.2.26 - ParameterPageResponse

Name	Description	Schema
contents required	Parameter list	array[Parameters]
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

3.2.27 - ParameterRequest

Name	Description	Schema
id required	Parameter id Example :	string
new_value required	Parameter new value Example :	string
old_value required	Parameter old value Example :	string

3.2.28 - Parameters

Name	Description	Schema
dbaas_parameter_group_id required	Parameter id Example :	string
default_value required	Parameter default value Example :	string
description required	Parameter description Example :	string
id required	Parameter id Example :	string
name required	Parameter name Example :	string
software_type required	Parameter software type Example :	any of [string, null]

3.2.29 - ParametersRequest

Name	Description	Schema	Default
parameters required	Parameter request list	array[ParameterRequest]

3.2.30 - ParametersResponse

Name	Description	Schema
contents required	Parameter contents	array[ParameterDTO]
count required	Parameter count Example :	integer
modified_at required	Modification time Example :	string

3.2.31 - RequestStateResponse

Name	Description	Schema	Default
request_id required	Request ID Example :	string
state required	Request state Example :	string

3.2.32 - ResizeBlockStorageGroupRequest

Name	Description	Schema	Default
size_gb required	Size in GB Example : `16` Minimum : `16` Maximum : `5120`	integer

3.2.33 - ResourceInfo

Name	Description	Schema	Default
id required	request resource id Example : `109a585ae67b4e8482fdafc8a4a5be74`	string

3.2.34 - ServerType

Name	Description	Schema
cpu_core required	Server type cpu core Example :	integer
description required	Server type description Example :	string
memory_gb required	Server type memory Example :	integer
name required	Server type name Example :	string
product_image_type required	Product image type Example :	string
product_type required	Product type Example :	string
purpose required	Server type purpose Example :	string
type required	Server type class Example :	string

3.2.35 - ServerTypeListResponse

Name	Description	Schema	Default
contents required	Server type list	array[ServerType]

3.2.36 - Tag

Name	Description	Schema	Default
key optional	Example :	string
value optional	Example :	any of [string, null]

3.2.37 - UpdateSecurityGroupRulesRequest

Name	Description	Schema	Default
add_ip_addresses optional	Allowed IP addresses list	array[string]
del_ip_addresses optional	Allowed IP addresses list	array[string]

4 - Quick Query

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Quick Query 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until

OpenAPI URL

https://quick-query.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

4.1 - APIs

4.1.1 - CheckClusterResourceSizeForQuickQuery

4.1.1.1 - 1.1

post /v1/quick-query/validate-resources

Description

Check if resource is verified to be modified/created

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		QuickQueryValidateResourceRequest

Responses

HTTP Code	Description	Schema
200	OK	QuickQueryValidateResourceResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/validate-resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.1"

Request body

{
    "cluster_id": "",
    "node_pool_validation_request": [
        {
            "auto_scale": "",
            "desired_node_count": "",
            "max_node_count": "",
            "min_node_count": "",
            "scale_name": ""
        }
    ],
    "quick_query_engine_request": {
        "auto_scale": "",
        "cluster_size": "",
        "cpu": "",
        "is_engine_type_private": "",
        "memory": "",
        "replica": ""
    }
}

Example HTTP response

Response 200

{
    "min_spec_node_pool": [
        {
            "cpu": "",
            "is_node_pool_auto_scalable": "",
            "memory": "",
            "replica": ""
        }
    ],
    "result": ""
}

4.1.1.2 - 1.0

post /v1/quick-query/validate-resources

Description

Check if resource is verified to be modified/created

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
body	body required		QuickQueryValidateResourceRequest

Responses

HTTP Code	Description	Schema
200	OK	QuickQueryValidateResourceResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/validate-resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.0"

Request body

{
    "cluster_id": "",
    "node_pool_validation_request": [
        {
            "auto_scale": "",
            "desired_node_count": "",
            "max_node_count": "",
            "min_node_count": "",
            "scale_name": ""
        }
    ],
    "quick_query_engine_request": {
        "auto_scale": "",
        "cluster_size": "",
        "cpu": "",
        "is_engine_type_private": "",
        "memory": "",
        "replica": ""
    }
}

Example HTTP response

Response 200

{
    "min_spec_node_pool": [
        {
            "cpu": "",
            "is_node_pool_auto_scalable": "",
            "memory": "",
            "replica": ""
        }
    ],
    "result": ""
}

4.1.2 - CheckDuplicationQuickQueryName

4.1.2.1 - 1.1

get /v1/quick-query/{quick_query_name}/check-duplication

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	quick_query_name required	quick query name Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	CheckResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_name}/check-duplication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.1"

Example HTTP response

Response 200

{
    "result": ""
}

4.1.2.2 - 1.0

get /v1/quick-query/{quick_query_name}/check-duplication

Description

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

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
path	quick_query_name required	quick query name Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	CheckResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_name}/check-duplication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.0"

Example HTTP response

Response 200

{
    "result": ""
}

4.1.3 - CreateQuickQuery

4.1.3.1 - 1.1

post /v1/quick-query

Description

Create Quick Query.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		QuickQueryTotalCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.1"

Request body

{
    "kubernetes_engine_create_request": {
        "cifs_volume_id": "",
        "cloud_logging_enabled": "",
        "k8s_version": "",
        "kubernetes_engine_name": "",
        "lb_id": "",
        "public_acl_ip_address": "",
        "security_group_id_list": [
            ""
        ],
        "subnet_id": "",
        "tags": [],
        "volume_id": "",
        "vpc_id": ""
    },
    "node_pool_create_requests": [
        {
            "auto_recovery": false,
            "auto_scale": false,
            "desired_node_count": "",
            "image_os": "",
            "image_os_version": "",
            "k8s_version": "",
            "keypair_name": "",
            "max_node_count": "",
            "min_node_count": "",
            "name": "",
            "scale_name": "",
            "volume_size": "",
            "volume_type_name": ""
        }
    ],
    "quick_query_create_request": {
        "description": "",
        "domain": "",
        "dsc_console_ip": "",
        "dsc_domain": "",
        "host_alias_list": [],
        "image_id": "",
        "instance_id": "",
        "is_engine_type_private": "",
        "max_query": "",
        "product_group_id": "",
        "query_engine_spec": {
            "auto_scale": "",
            "cluster_size": "",
            "cpu": "",
            "memory": "",
            "replica": ""
        },
        "quick_query_name": "",
        "version": ""
    },
    "tags": []
}

Example HTTP response

Response 202

{
    "project_id": "10a599e031e749b7b260868f441e862b",
    "request_id": "10a599e031e749b7b260868f441e862b",
    "resource_id": "10a599e031e749b7b260868f441e862b"
}

4.1.3.2 - 1.0

post /v1/quick-query

Description

Create Quick Query.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
body	body required		QuickQueryTotalCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.0"

Request body

{
    "kubernetes_engine_create_request": {
        "cifs_volume_id": "",
        "cloud_logging_enabled": "",
        "k8s_version": "",
        "kubernetes_engine_name": "",
        "lb_id": "",
        "public_acl_ip_address": "",
        "security_group_id_list": [
            ""
        ],
        "subnet_id": "",
        "tags": [],
        "volume_id": "",
        "vpc_id": ""
    },
    "node_pool_create_requests": [
        {
            "auto_recovery": false,
            "auto_scale": false,
            "desired_node_count": "",
            "image_os": "",
            "image_os_version": "",
            "k8s_version": "",
            "keypair_name": "",
            "max_node_count": "",
            "min_node_count": "",
            "name": "",
            "scale_name": "",
            "volume_size": "",
            "volume_type_name": ""
        }
    ],
    "quick_query_create_request": {
        "description": "",
        "domain": "",
        "dsc_console_ip": "",
        "dsc_domain": "",
        "host_alias_list": [],
        "image_id": "",
        "instance_id": "",
        "is_engine_type_private": "",
        "max_query": "",
        "product_group_id": "",
        "query_engine_spec": {
            "auto_scale": "",
            "cluster_size": "",
            "cpu": "",
            "memory": "",
            "replica": ""
        },
        "quick_query_name": "",
        "version": ""
    },
    "tags": []
}

Example HTTP response

Response 202

{
    "project_id": "10a599e031e749b7b260868f441e862b",
    "request_id": "10a599e031e749b7b260868f441e862b",
    "resource_id": "10a599e031e749b7b260868f441e862b"
}

4.1.4 - DeleteQuickQuery

4.1.4.1 - 1.1

delete /v1/quick-query/{quick_query_id}

Description

delete quick query

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	quick_query_id required	quick_query_id Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.1"

Example HTTP response

Response 202

{
    "project_id": "10a599e031e749b7b260868f441e862b",
    "request_id": "10a599e031e749b7b260868f441e862b",
    "resource_id": "10a599e031e749b7b260868f441e862b"
}

4.1.4.2 - 1.0

delete /v1/quick-query/{quick_query_id}

Description

delete quick query

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
path	quick_query_id required	quick_query_id Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.0"

Example HTTP response

Response 202

{
    "project_id": "10a599e031e749b7b260868f441e862b",
    "request_id": "10a599e031e749b7b260868f441e862b",
    "resource_id": "10a599e031e749b7b260868f441e862b"
}

4.1.5 - ListQuickQuery

4.1.5.1 - 1.1

get /v1/quick-query

Description

get quick query list console

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	sort optional	sort Example : `created_at:desc`	string	created_dt:desc
query	cluster_name optional	cluster_name Example :	string	None
query	created_by optional	created_by Example :	string	None
query	quick_query_state optional	state Example :	enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING)	None
query	version optional	version Example :	string	None
query	quick_query_name optional	quick_query_name Example :	string	None
query	size required	size Example : `20`	integer	None
query	page required	page Example : `0`	integer	None

Responses

HTTP Code	Description	Schema
200	OK	QuickQueryListSearchResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query?size={size}&page={page}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "cluster_id": "",
            "cluster_name": "",
            "cluster_permission": {},
            "cluster_request_failed": false,
            "created_by": "",
            "created_dt": "2026-02-11T06:43:39.763Z",
            "modified_by": "",
            "modified_dt": "",
            "quick_query_id": "",
            "quick_query_name": "",
            "quick_query_state": "",
            "quick_query_version": ""
        }
    ],
    "page": "",
    "size": "",
    "sort": [
        ""
    ],
    "total_count": ""
}

4.1.5.2 - 1.0

get /v1/quick-query

Description

get quick query list console

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
query	sort optional	sort Example : `created_at:desc`	string	created_dt:desc
query	cluster_name optional	cluster_name Example :	string	None
query	created_by optional	created_by Example :	string	None
query	quick_query_state optional	state Example :	enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING)	None
query	version optional	version Example :	string	None
query	quick_query_name optional	quick_query_name Example :	string	None
query	size required	size Example : `20`	integer	None
query	page required	page Example : `0`	integer	None

Responses

HTTP Code	Description	Schema
200	OK	QuickQueryListSearchResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query?size={size}&page={page}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "cluster_id": "",
            "cluster_name": "",
            "cluster_permission": {},
            "cluster_request_failed": false,
            "created_by": "",
            "created_dt": "2026-02-11T06:43:39.763Z",
            "modified_by": "",
            "modified_dt": "",
            "quick_query_id": "",
            "quick_query_name": "",
            "quick_query_state": "",
            "quick_query_version": ""
        }
    ],
    "page": "",
    "size": "",
    "sort": [
        ""
    ],
    "total_count": ""
}

4.1.6 - ListQuickQueryImages

4.1.6.1 - 1.1

get /v1/quick-query/image-versions

Description

get quick query image versions

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Responses

HTTP Code	Description	Schema
200	OK	ImageVersionsResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/image-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "image_attr": {
                "k8s.version": "",
                "os.type": ""
            },
            "image_id": "",
            "image_name": "",
            "version": ""
        }
    ],
    "total_count": ""
}

4.1.6.2 - 1.0

get /v1/quick-query/image-versions

Description

get quick query image versions

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Responses

HTTP Code	Description	Schema
200	OK	ImageVersionsResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/image-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "image_attr": {
                "k8s.version": "",
                "os.type": ""
            },
            "image_id": "",
            "image_name": "",
            "version": ""
        }
    ],
    "total_count": ""
}

4.1.7 - ShowQuickQuery

4.1.7.1 - 1.1

get /v1/quick-query/{quick_query_id}

Description

Get Quick Query details.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	quick_query_id required	quick_query_id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	QuickQueryDetailResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.1"

Example HTTP response

Response 200

{
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "created_dt": "2026-02-11T06:43:40.135Z",
    "description": "",
    "domain": "",
    "dsc_console_domain": "",
    "dsc_domain": "",
    "dsc_oidc_domain": "",
    "host_alias_list": [
        {}
    ],
    "hosts_file": "",
    "is_active_image": "",
    "is_engine_type_private": "",
    "max_query": "",
    "modified_dt": "2026-02-11T06:43:40.159Z",
    "namespace_name": "",
    "node_information": [],
    "provisioning_state": "",
    "query_engine_spec": "",
    "quick_query_id": "",
    "quick_query_name": "",
    "quick_query_state": "",
    "quick_query_version": ""
}

4.1.7.2 - 1.0

get /v1/quick-query/{quick_query_id}

Description

Get Quick Query details.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
path	quick_query_id required	quick_query_id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	QuickQueryDetailResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.0"

Example HTTP response

Response 200

{
    "cluster_id": "",
    "cluster_name": "",
    "cluster_permission": {},
    "cluster_request_failed": false,
    "created_dt": "2026-02-11T06:43:40.135Z",
    "description": "",
    "domain": "",
    "dsc_console_domain": "",
    "dsc_domain": "",
    "dsc_oidc_domain": "",
    "host_alias_list": [
        {}
    ],
    "hosts_file": "",
    "is_active_image": "",
    "is_engine_type_private": "",
    "max_query": "",
    "modified_dt": "2026-02-11T06:43:40.159Z",
    "namespace_name": "",
    "node_information": [],
    "provisioning_state": "",
    "query_engine_spec": "",
    "quick_query_id": "",
    "quick_query_name": "",
    "quick_query_state": "",
    "quick_query_version": ""
}

4.1.8 - UpdateQuickQueryDescription

4.1.8.1 - 1.1

put /v1/quick-query/{quick_query_id}/description

Description

update quick query description

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	quick_query_id required	quick_query_id Example :	string	None
body	body required		QuickQueryDescriptionRequest

Responses

HTTP Code	Description	Schema
202	Accepted	QuickQueryDescriptionResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.1"

Request body

{
    "description": ""
}

Example HTTP response

Response 202

{
    "description": "",
    "quick_query_id": ""
}

4.1.8.2 - 1.0

put /v1/quick-query/{quick_query_id}/description

Description

update quick query description

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
path	quick_query_id required	quick_query_id Example :	string	None
body	body required		QuickQueryDescriptionRequest

Responses

HTTP Code	Description	Schema
202	Accepted	QuickQueryDescriptionResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.0"

Request body

{
    "description": ""
}

Example HTTP response

Response 202

{
    "description": "",
    "quick_query_id": ""
}

4.1.9 - UpdateQuickQueryDomain

4.1.9.1 - 1.1

put /v1/quick-query/{quick_query_id}/domain

Description

update quick query domain

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	quick_query_id required	quick_query_id Example :	string	None
body	body required		QuickQueryDomainRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_id}/domain

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.1"

Request body

{
    "domain": ""
}

Example HTTP response

Response 202

{
    "project_id": "10a599e031e749b7b260868f441e862b",
    "request_id": "10a599e031e749b7b260868f441e862b",
    "resource_id": "10a599e031e749b7b260868f441e862b"
}

4.1.9.2 - 1.0

put /v1/quick-query/{quick_query_id}/domain

Description

update quick query domain

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
path	quick_query_id required	quick_query_id Example :	string	None
body	body required		QuickQueryDomainRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_id}/domain

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.0"

Request body

{
    "domain": ""
}

Example HTTP response

Response 202

{
    "project_id": "10a599e031e749b7b260868f441e862b",
    "request_id": "10a599e031e749b7b260868f441e862b",
    "resource_id": "10a599e031e749b7b260868f441e862b"
}

4.1.10 - UpdateQuickQueryDscDomain

4.1.10.1 - 1.1

put /v1/quick-query/{quick_query_id}/dsc-domain

Description

update quick query dsc domain

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	quick_query_id required	quick_query_id Example :	string	None
body	body required		QuickQueryDscDomainRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_id}/dsc-domain

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.1"

Request body

{
    "dsc_domain": ""
}

Example HTTP response

Response 202

{
    "project_id": "10a599e031e749b7b260868f441e862b",
    "request_id": "10a599e031e749b7b260868f441e862b",
    "resource_id": "10a599e031e749b7b260868f441e862b"
}

4.1.10.2 - 1.0

put /v1/quick-query/{quick_query_id}/dsc-domain

Description

update quick query dsc domain

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
path	quick_query_id required	quick_query_id Example :	string	None
body	body required		QuickQueryDscDomainRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_id}/dsc-domain

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.0"

Request body

{
    "dsc_domain": ""
}

Example HTTP response

Response 202

{
    "project_id": "10a599e031e749b7b260868f441e862b",
    "request_id": "10a599e031e749b7b260868f441e862b",
    "resource_id": "10a599e031e749b7b260868f441e862b"
}

4.1.11 - UpdateQuickQueryEngine

4.1.11.1 - 1.1

put /v1/quick-query/{quick_query_id}/engine

Description

update quick query engine

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	quick_query_id required	quick_query_id Example :	string	None
body	body required		QuickQueryUpdateEngineRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_id}/engine

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.1"

Request body

{
    "cluster_size": "",
    "cpu": "",
    "memory": "",
    "replica": ""
}

Example HTTP response

Response 202

{
    "project_id": "10a599e031e749b7b260868f441e862b",
    "request_id": "10a599e031e749b7b260868f441e862b",
    "resource_id": "10a599e031e749b7b260868f441e862b"
}

4.1.11.2 - 1.0

put /v1/quick-query/{quick_query_id}/engine

Description

update quick query engine

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
path	quick_query_id required	quick_query_id Example :	string	None
body	body required		QuickQueryUpdateEngineRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_id}/engine

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.0"

Request body

{
    "cluster_size": "",
    "cpu": "",
    "memory": "",
    "replica": ""
}

Example HTTP response

Response 202

{
    "project_id": "10a599e031e749b7b260868f441e862b",
    "request_id": "10a599e031e749b7b260868f441e862b",
    "resource_id": "10a599e031e749b7b260868f441e862b"
}

4.1.12 - UpdateQuickQueryHostAlias

4.1.12.1 - 1.1

put /v1/quick-query/{quick_query_id}/host-alias

Description

update quick query host alias

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	quick_query_id required	quick_query_id Example :	string	None
body	body required		QuickQueryHostAliasRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_id}/host-alias

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.1"

Request body

{
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ]
}

Example HTTP response

Response 202

{
    "project_id": "10a599e031e749b7b260868f441e862b",
    "request_id": "10a599e031e749b7b260868f441e862b",
    "resource_id": "10a599e031e749b7b260868f441e862b"
}

4.1.12.2 - 1.0

put /v1/quick-query/{quick_query_id}/host-alias

Description

update quick query host alias

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260701

Parameters

Type	Name	Description	Schema	Default
path	quick_query_id required	quick_query_id Example :	string	None
body	body required		QuickQueryHostAliasRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/quick-query/{quick_query_id}/host-alias

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quick-query 1.0"

Request body

{
    "host_alias_list": [
        {
            "hostnames": [
                ""
            ],
            "ip": ""
        }
    ]
}

Example HTTP response

Response 202

{
    "project_id": "10a599e031e749b7b260868f441e862b",
    "request_id": "10a599e031e749b7b260868f441e862b",
    "resource_id": "10a599e031e749b7b260868f441e862b"
}

4.2 - Models

4.2.1 - AsyncResponse

Name	Description	Schema
project_id required	Project ID Example : `10a599e031e749b7b260868f441e862b`	any of [string, null]
request_id required	Request ID Example : `10a599e031e749b7b260868f441e862b`	string
resource_id required	Resource ID Example : `10a599e031e749b7b260868f441e862b`	string

4.2.2 - CheckResponse

Name	Description	Schema	Default
result required	check result Example :	boolean

4.2.3 - HostAliasList

Name	Description	Schema	Default
hostnames optional	hostnames	array[string]
ip optional	ip Example :	string

4.2.4 - ImageAttr

Name	Description	Schema
image_attr required	image_attr	QuickQueryImageAttr
image_id required	image_id Example :	string
image_name required	image_name Example :	string
version required	version Example :	string

4.2.5 - ImageVersionsResponse

Name	Description	Schema	Default
contents required	contents	array[ImageAttr]
total_count required	total_count Example :	integer

4.2.6 - InternalNodeSummary

Name	Description	Schema
age required	age Example :	string
cluster_id required	cluster id Example :	string
container_version required	Container Version Example :	any of [string, null]
created_at required	created at Example : `2026-02-11T06:43:40.292Z`	string (date-time)
external_ip_address required	External IP Address Example :	any of [string, null]
gpu_name required	GPU Name Example :	any of [string, null]
ip required	IP Example :	any of [string, null]
kernel_version required	Kernel Version Example :	any of [string, null]
kubernetes_version required	Kubernetes Version Example :	any of [string, null]
name required	name Example :	string
node_capacities required	Node Capacities	array[NodeCapacity]
node_status required	node status Example :	string
number_of_allocated_pods required	Number of allocated pods Example :	string
number_of_gpu required	Number of GPU Example :	any of [integer, null]
os_image required	OS Image Example :	any of [string, null]
uid required	uid Example :	string

4.2.7 - KubernetesEngineCreateRequest

Name	Description	Schema
cifs_volume_id optional	cifs_volume_id Example :	any of [string, null]
cloud_logging_enabled required	cloud_logging_enabled Example :	boolean
k8s_version required	k8s_version Example :	string
kubernetes_engine_name required	kubernetes_engine_name Example : Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `30`	string
lb_id optional	lb_id Example :	any of [string, null]
public_acl_ip_address optional	public_acl_ip_address Example :	any of [string, null]
security_group_id_list required	security_group_id_list	array[string]
subnet_id required	subnet_id Example :	string
tags optional	tags	array[Tag]
volume_id required	volume_id Example :	string
vpc_id required	vpc_id Example :	string

4.2.8 - NodeCapacity

Name	Description	Schema
cpu required	CPU Example :	string
ephemeral_storage required	Ephemeral Storage Example :	string
gpu optional	GPU Example :	any of [string, null]
hugepages_1Gi required	Hugepages 1Gi Example :	string
hugepages_2Mi required	Hugepages 2Mi Example :	string
memory required	Memory Example :	string
node_capacity_type required	Node Capacity Type Example :	string
pod_count required	Pod Count Example :	string

4.2.9 - NodePoolCreateRequest

Name	Description	Schema
auto_recovery optional	is_auto_recovery Example : `False`	boolean
auto_scale optional	is_auto_scale Example : `False`	boolean
desired_node_count optional	desired_node_count Example :	any of [integer, null]
image_os required	image_os Example :	string
image_os_version required	image_os_version Example :	string
k8s_version required	k8s_version Example :	string
keypair_name required	keypair_name Example :	string
max_node_count optional	max_node_count Example :	any of [integer, null]
min_node_count optional	min_node_count Example :	any of [integer, null]
name required	name Example : Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `20`	string
scale_name required	scale_name Example :	string
volume_size required	volume_size Example : Minimum : `104` Maximum : `1000`	integer
volume_type_name required	volume_type_name Example :	string

4.2.10 - NodePoolResourceValidationRequest

Name	Description	Schema
auto_scale required	auto_scale Example :	boolean
desired_node_count required	desired_node_count Example :	integer
max_node_count optional	max_node_count Example :	any of [integer, null]
min_node_count optional	min_node_count Example :	any of [integer, null]
scale_name required	scale_name Example :	string

4.2.11 - NodePoolSpecResponse

Name	Description	Schema
cpu optional	cpu Example :	string
is_node_pool_auto_scalable required	is_node_pool_auto_scalable Example :	boolean
memory optional	memory Example :	string
replica optional	replica Example :	string

4.2.12 - QueryEngineSpec

Name	Description	Schema
auto_scale optional	auto_scale Example :	any of [boolean, null]
cluster_size optional	cluster_size Example :	any of [string, null]
cpu optional	cpu Example : Pattern : `^(0\|4\|6\|8\|10\|12\|14\|16\|18\|20\|22\|24)$`	any of [string, null]
memory optional	memory Example : Pattern : `^(0\|8\|16\|32\|64\|128\|192\|256)$`	any of [string, null]
replica optional	replica Example : Pattern : `^(0\|1\|2\|3\|4\|5\|6\|7\|8\|9)$`	any of [string, null]

4.2.13 - QuickQueryCreateRequest

Name	Description	Schema
description optional	description Example :	any of [string, null]
domain required	domain Example : Minimum length : `3` Maximum length : `50`	string
dsc_console_ip optional	dsc_console_ip Example :	any of [string, null]
dsc_domain required	dsc_domain Example : Minimum length : `3` Maximum length : `50`	string
host_alias_list optional	host_alias_list	array[HostAliasList]
image_id required	image_id Example :	string
instance_id optional	instance_id Example :	any of [string, null]
is_engine_type_private required	is_engine_type_private Example :	boolean
max_query required	max_query Example : Pattern : `^(32\|64\|96\|128)$`	string
product_group_id optional	product_group_id Example :	any of [string, null]
query_engine_spec required	query_engine_spec	QueryEngineSpec
quick_query_name required	quick_query_name Example : Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `30`	string
version required	version Example :	string

4.2.14 - QuickQueryDescriptionRequest

Name	Description	Schema	Default
description required	description Example :	string

4.2.15 - QuickQueryDescriptionResponse

Name	Description	Schema	Default
description required	description Example :	string
quick_query_id required	quick_query_id Example :	string

4.2.16 - QuickQueryDetailResponse

Name	Description	Schema
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	string
cluster_permission optional	cluster_permission Example :	object
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_dt required	created_dt Example : `2026-02-11T06:43:40.135Z`	string (date-time)
description optional	description Example :	any of [string, null]
domain optional	domain Example :	string
dsc_console_domain optional	dsc_console_domain Example :	any of [string, null]
dsc_domain optional	dsc_domain Example :	string
dsc_oidc_domain optional	dsc_oidc_domain Example :	any of [string, null]
host_alias_list optional	domain	array[object]
hosts_file optional	hosts_file Example :	any of [string, null]
is_active_image optional	is_active_image Example :	boolean
is_engine_type_private optional	is_engine_type_private Example :	boolean
max_query optional	max_query Example :	string
modified_dt required	modified_dt Example : `2026-02-11T06:43:40.159Z`	string (date-time)
namespace_name optional	namespace_name Example :	string
node_information optional	node_information	array[InternalNodeSummary]
provisioning_state required	provisioning_state Example :	string
query_engine_spec optional	query_engine_spec Example :	object
quick_query_id required	quick_query_id Example :	string
quick_query_name required	quick_query_name Example :	string
quick_query_state required	quick_query_state Example :	string
quick_query_version required	quick_query_version Example :	string

4.2.17 - QuickQueryDomainRequest

Name	Description	Schema	Default
domain required	domain Example :	string

4.2.18 - QuickQueryDscDomainRequest

Name	Description	Schema	Default
dsc_domain required	dsc_domain Example :	string

4.2.19 - QuickQueryEngineRequest

Name	Description	Schema
auto_scale optional	auto_scale Example :	boolean
cluster_size optional	cluster_size Example :	any of [string, null]
cpu optional	cpu Example :	any of [string, null]
is_engine_type_private optional	is_engine_type_private Example :	boolean
memory optional	memory Example :	any of [string, null]
replica optional	replica Example :	any of [string, null]

4.2.20 - QuickQueryHostAliasRequest

Name	Description	Schema	Default
host_alias_list optional	host_alias_list	array[HostAliasList]

4.2.21 - QuickQueryImageAttr

Name	Description	Schema	Default
k8s.version optional	k8s_version Example :	string
os.type optional	os_type Example :	string

4.2.22 - QuickQueryListResponse

Name	Description	Schema
cluster_id required	cluster_id Example :	string
cluster_name optional	cluster_name Example :	any of [string, null]
cluster_permission optional	cluster_permission Example :	object
cluster_request_failed optional	cluster_request_failed Example : `False`	boolean
created_by required	created_by Example :	string
created_dt required	created_at Example : `2026-02-11T06:43:39.763Z`	string (date-time)
modified_by optional	modified_by Example :	any of [string, null]
modified_dt optional	modified_at Example :	any of [string (date-time), null]
quick_query_id required	quick_query_id Example :	string
quick_query_name required	quick_query_name Example :	string
quick_query_state required	quick_query_state Example :	string
quick_query_version required	quick_query_version Example :	string

4.2.23 - QuickQueryListSearchResponse

Name	Description	Schema
contents required	contents	array[QuickQueryListResponse]
page required	page Example :	integer
size required	size Example :	integer
sort required	sort	array[string]
total_count required	total_count Example :	integer

4.2.24 - QuickQueryTotalCreateRequest

Name	Description	Schema
kubernetes_engine_create_request required	kubernetes_engine_create_request	KubernetesEngineCreateRequest
node_pool_create_requests required	node_pool_create_requests	array[NodePoolCreateRequest]
quick_query_create_request required	quick_query_create_request	QuickQueryCreateRequest
tags optional	tags	array[Tag]

4.2.25 - QuickQueryUpdateEngineRequest

Name	Description	Schema
cluster_size optional	cluster_size Example :	any of [string, null]
cpu required	cpu Example :	string
memory required	memory Example :	string
replica required	replica Example :	string

4.2.26 - QuickQueryValidateResourceRequest

Name	Description	Schema
cluster_id optional	cluster_id Example :	string
node_pool_validation_request required	node_pool_validation_request	array[NodePoolResourceValidationRequest]
quick_query_engine_request required	quick_query_engine_request	QuickQueryEngineRequest

4.2.27 - QuickQueryValidateResourceResponse

Name	Description	Schema	Default
min_spec_node_pool optional	min_spec_node_pool	array[NodePoolSpecResponse]
result required	result Example :	boolean

4.2.28 - Tag

Name	Description	Schema	Default
tag_key required	tag_key Example : Pattern : `^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]$` Maximum length* : `128`	string
tag_value optional	tag_value Example : Pattern : `^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]$` Maximum length* : `256`	string

5 - Search Engine

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Search Engine 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	CURRENT	-

OpenAPI URL

https://searchengine.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

5.1 - APIs

5.1.1 - Add Block Storages

5.1.1.1 - 1.0

post /v1/instance-groups/{instance_group_id}/block-storage-groups

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	instance_group_id required	Instance group ID Example :	string	None
body	body required		AddBlockStoragesRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/instance-groups/{instance_group_id}/block-storage-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Request body

{
    "role_type": "",
    "size_gb": 104,
    "volume_type": "SSD"
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.2 - Add Instances

5.1.2.1 - 1.0

post /v1/clusters/{cluster_id}/add-instances

Description

Add Instances.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		SearchEngineClusterAddInstancesRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/add-instances

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Request body

{
    "instance_count": "",
    "public_ip_ids": [
        ""
    ],
    "service_ip_addresses": [
        ""
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.3 - Create Cluster

5.1.3.1 - 1.0

post /v1/clusters

Description

Create Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SearchEngineClusterCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Request body

{
    "allowable_ip_addresses": [],
    "dbaas_engine_version_id": "",
    "init_config_option": {
        "backup_option": {
            "retention_period_day": "",
            "starting_time_hour": ""
        },
        "database_port": 9200,
        "database_user_name": "",
        "database_user_password": ""
    },
    "instance_groups": [
        {
            "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": ""
        }
    ],
    "instance_name_prefix": "",
    "is_combined": false,
    "license": "",
    "maintenance_option": {
        "period_hour": "",
        "starting_day_of_week": "MON",
        "starting_time": ""
    },
    "name": "",
    "nat_enabled": false,
    "subnet_id": "",
    "tags": [],
    "timezone": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.4 - Create Restore Cluster

5.1.4.1 - 1.0

post /v1/clusters/{cluster_id}/restore

Description

Create Restore Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		SearchEngineClusterRestoreRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/restore

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Request body

{
    "allowable_ip_addresses": [],
    "backup_history_number": "",
    "instance_groups": [
        {
            "block_storage_groups": [
                {
                    "role_type": "",
                    "size_gb": 104,
                    "volume_type": "SSD"
                }
            ],
            "role_type": "ACTIVE"
        }
    ],
    "instance_name_prefix": "",
    "license": "",
    "maintenance_option": {
        "period_hour": "",
        "starting_day_of_week": "MON",
        "starting_time": ""
    },
    "name": "",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.5 - List Backup Histories

5.1.5.1 - 1.0

get /v1/clusters/{cluster_id}/backup-histories

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
query	limit optional	Number of backup lists Example :	any of [integer, null]	None
query	page optional	Backup list page Example :	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupHistoryListApiResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backup-histories

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_end_at": "",
            "backup_history_number": "",
            "backup_size_gb": "",
            "backup_start_at": "",
            "backup_state": "",
            "backup_state_detail": "",
            "software_version": ""
        }
    ],
    "total_count": ""
}

5.1.6 - List Clusters

5.1.6.1 - 1.0

get /v1/clusters

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	name:asc
query	name optional	Cluster name Example :	any of [string, null]	None
query	service_state optional	Service state Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ClusterPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "ha_enabled": false,
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "instance_count": 0,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "role_type": "ORIGIN",
            "service_state": "RUNNING"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5.1.7 - List Engine Version Properties

5.1.7.1 - 1.0

get /v1/engine-versions/{dbaas_engine_version_id}/properties

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	dbaas_engine_version_id required	DBaaS engine version ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	EnginePropertyListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/engine-versions/{dbaas_engine_version_id}/properties

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "name": "",
            "value": ""
        }
    ]
}

5.1.8 - List Engine Versions

5.1.8.1 - 1.0

get /v1/engine-versions

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	id optional	DBaaS engine version ID Example :	any of [string, null]	None
query	product_image_type optional	Product image type Example :	any of [enum (PostgreSQL Community, MariaDB Community, MySQL Community, EPAS, Microsoft SQL Server Enterprise, Microsoft SQL Server Standard, Redis OSS Sentinel, Valkey Sentinel, Kafka, Elasticsearch Enterprise, OpenSearch, Vertica Enterprise, Vertica Community, Scalable DB MariaDB Community), null]	None
query	eos_included optional	EoS included Example : `False`	boolean	False

Responses

HTTP Code	Description	Schema
200	OK	EngineListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/engine-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "end_of_service": false,
            "id": "",
            "major_version": "",
            "name": "",
            "os_type": "",
            "os_version": "",
            "product_image_type": "",
            "software_version": ""
        }
    ]
}

5.1.9 - List Server Types

5.1.9.1 - 1.0

get /v1/server-types

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	name optional	Server type name Example :	any of [string, null]	None
query	product_image_type optional	Product image type Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ServerTypeListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-types

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "cpu_core": "",
            "description": "",
            "memory_gb": "",
            "name": "",
            "product_image_type": "",
            "product_type": "",
            "purpose": "",
            "type": ""
        }
    ]
}

5.1.10 - Remove Backup Histories

5.1.10.1 - 1.0

put /v1/clusters/{cluster_id}/backup-histories

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		BackupHistoryNumberRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backup-histories

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Request body

{
    "backup_history_number": [
        ""
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.11 - Restart Cluster

5.1.11.1 - 1.0

post /v1/clusters/{cluster_id}/restart

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/restart

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.12 - Set Backup

5.1.12.1 - 1.0

post /v1/clusters/{cluster_id}/backups

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		BackupSettingExcludingArchiveRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Request body

{
    "retention_period_day": "",
    "starting_time_hour": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.13 - Set Block Storage Size

5.1.13.1 - 1.0

post /v1/block-storage-groups/{block_storage_group_id}/resize

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	block_storage_group_id required	Block storage group ID Example : `afc33891202643ba8ba1a5298a1affff`	string	None
body	body required		ResizeBlockStorageGroupRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/block-storage-groups/{block_storage_group_id}/resize

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Request body

{
    "size_gb": 16
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.14 - Set Maintenance

5.1.14.1 - 1.0

post /v1/clusters/{cluster_id}/maintenance

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		MaintenanceRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/maintenance

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Request body

{
    "start_day_of_week": "MON",
    "start_minute": "",
    "start_time": "",
    "term_hour": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.15 - Set Security Group Rules

5.1.15.1 - 1.0

post /v1/clusters/{cluster_id}/security-group-rules

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		UpdateSecurityGroupRulesRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/security-group-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Request body

{
    "add_ip_addresses": [],
    "del_ip_addresses": []
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.16 - Set Server Type

5.1.16.1 - 1.0

post /v1/instance-groups/{instance_group_id}/resize

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	instance_group_id required	Instance group ID Example :	string	None
body	body required		InstanceGroupResizeRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/instance-groups/{instance_group_id}/resize

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Request body

{
    "server_type_name": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.17 - Show Cluster

5.1.17.1 - 1.0

get /v1/clusters/{cluster_id}

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	SearchEngineClusterDetailResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Example HTTP response

Response 200

{
    "account_id": "",
    "allowable_ip_addresses": [],
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "dbaas_engine": "PostgreSQL",
    "dbaas_engine_version_name": "",
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "init_config_option": {
        "backup_option": {
            "retention_period_day": "",
            "starting_time_hour": ""
        },
        "dashboards_port": "",
        "database_port": 9200,
        "database_user_name": "",
        "kibana_port": ""
    },
    "instance_count": 0,
    "instance_groups": [
        {
            "block_storage_groups": [
                {
                    "id": "",
                    "name": "",
                    "role_type": "OS",
                    "size_gb": "",
                    "volume_type": "SSD"
                }
            ],
            "id": "",
            "instances": [
                {
                    "name": "",
                    "public_ip_address": "",
                    "public_ip_id": "",
                    "role_type": "",
                    "service_ip_address": "",
                    "service_state": "RUNNING"
                }
            ],
            "role_type": "",
            "server_type_name": ""
        }
    ],
    "is_combined": "",
    "license": {
        "license_expiry_date": "",
        "license_status": "",
        "license_type": ""
    },
    "maintenance_option": {
        "period_hour": "",
        "starting_day_of_week": "MON",
        "starting_time": "",
        "use_maintenance_option": false
    },
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "",
    "nat_enabled": "",
    "product_image_type": "",
    "product_type": "Search Engine",
    "service_state": "RUNNING",
    "software_version": "",
    "subnet_id": "",
    "timezone": ""
}

5.1.18 - Show Request

5.1.18.1 - 1.0

get /v1/requests/{request_id}

Description

Show Request.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	request_id required	Request ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	RequestStateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/requests/{request_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Example HTTP response

Response 200

{
    "request_id": "",
    "state": ""
}

5.1.19 - Start Cluster

5.1.19.1 - 1.0

post /v1/clusters/{cluster_id}/start

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/start

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.20 - Stop Cluster

5.1.20.1 - 1.0

post /v1/clusters/{cluster_id}/stop

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/stop

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.21 - Synchronize Cluster State

5.1.21.1 - 1.0

post /v1/clusters/{cluster_id}/sync-state

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/sync-state

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.22 - Terminate Cluster

5.1.22.1 - 1.0

delete /v1/clusters/{cluster_id}

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.23 - Unset Backup

5.1.23.1 - 1.0

delete /v1/clusters/{cluster_id}/backups

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.1.24 - Unset Maintenance

5.1.24.1 - 1.0

delete /v1/clusters/{cluster_id}/maintenance

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/maintenance

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = searchengine 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

5.2 - Models

5.2.1 - AddBlockStoragesRequest

Name	Description	Schema	Default
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example : `104` Minimum : `16` Maximum : `5120`	integer
volume_type optional	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)	SSD

5.2.2 - AsyncResponse

Name	Description	Schema	Default
request_id required	Request ID Example : `req-4f668846-8a3d-49f1-8111-451ebccf445c`	string
resource required	Resource	ResourceInfo

5.2.3 - BackupHistoryApiItem

Name	Description	Schema
backup_end_at required	Backup end time Example :	string
backup_history_number required	Backup id Example :	string
backup_size_gb required	Backup amount(GB) Example :	object
backup_start_at required	Backup start time Example :	string
backup_state required	Backup state Example :	string
backup_state_detail optional	Backup detail state Example :	any of [string, null]
software_version required	Software version Example :	string

5.2.4 - BackupHistoryListApiResponse

Name	Description	Schema	Default
contents required	backup list information	array[BackupHistoryApiItem]
total_count required	total number of backup history Example :	integer

5.2.5 - BackupHistoryNumberRequest

Name	Description	Schema	Default
backup_history_number required	Backup id	array[string]

5.2.6 - BackupSettingExcludingArchiveRequest

Name	Description	Schema	Default
retention_period_day required	Backup retention period (day) Example : Pattern : `^([7-9]\|^[1-2]\d\|^3[0-5])$`	string
starting_time_hour required	Backup starting time (hour) Example : Pattern : `^(\d\|1\d\|2[0-3])$`	string

5.2.7 - BlockStorageGroupRequest

Name	Description	Schema	Default
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example : `104` Minimum : `16` Maximum : `5120`	integer
volume_type optional	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)	SSD

5.2.8 - BlockStorageGroupResponse

Name	Description	Schema
id required	ID Example :	string
name required	Name Example :	string
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example :	integer
volume_type required	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)

5.2.9 - ClusterPageResponse

Name	Description	Schema
contents required	Clusters list	any of [array[ClusterResponse], null]
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

5.2.10 - ClusterResponse

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
ha_enabled optional	HA availability Example : `False`	boolean
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
instance_count optional	Instance Count Example : `0`	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster name Example :	string
role_type required	Role type Example : `ORIGIN`	any of [enum (ORIGIN, REPLICA, RECOVERY, SECONDARY, MIGRATION), null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)

5.2.11 - Engine

Name	Description	Schema
end_of_service optional	End of Service Example : `False`	boolean
id required	ID Example :	string
major_version required	Software major version Example :	string
name required	DBaaS engine version name Example :	string
os_type required	OS type Example :	string
os_version required	OS version Example :	string
product_image_type optional	Product type Example :	any of [string, null]
software_version required	Software version Example :	string

5.2.12 - EngineListResponse

Name	Description	Schema	Default
contents required	DBaaS engine list	array[Engine]

5.2.13 - EngineProperty

Name	Description	Schema	Default
name required	DBaas engine property name Example :	string
value required	DBaas engine property value Example :	string

5.2.14 - EnginePropertyListResponse

Name	Description	Schema	Default
contents required	DBaas engine property list	array[EngineProperty]

5.2.15 - InstanceGroupRequest

Name	Description	Schema
block_storage_groups required	Block storage groups list	array[BlockStorageGroupRequest]
instances optional	Instances list	any of [array[InstanceRequest], null]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, ACTIVE_STANDBY, PRIMARY_SECONDARY, MASTER, MASTER_REPLICA, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, PRIMARY, PRIMARY_NODE, READ_NODE)
server_type_name required	Server type name Example :	string

5.2.16 - InstanceGroupResizeRequest

Name	Description	Schema	Default
server_type_name required	Server type name Example :	string

5.2.17 - InstanceGroupResponse

Name	Description	Schema
block_storage_groups required	Block storage groups list	array[BlockStorageGroupResponse]
id required	ID Example :	string
instances required	Instances list	array[InstanceResponse]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, ACTIVE_STANDBY, PRIMARY_SECONDARY, MASTER, MASTER_REPLICA, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, PRIMARY, PRIMARY_NODE, READ_NODE)
server_type_name required	Server type name Example :	string

5.2.18 - InstanceRequest

Name	Description	Schema
public_ip_id optional	Public IP ID Example :	any of [string, null]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, STANDBY, PRIMARY, SECONDARY, MASTER, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, READ_REPLICA)
service_ip_address optional	User subnet IP address Example :	any of [string, null]

5.2.19 - InstanceResponse

Name	Description	Schema
name required	Name Example :	string
public_ip_address optional	Public IP Address Example :	any of [string, null]
public_ip_id optional	Public IP ID Example :	any of [string, null]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, STANDBY, PRIMARY, SECONDARY, MASTER, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, READ_REPLICA)
service_ip_address optional	User subnet IP address Example :	any of [string, null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)

5.2.20 - MaintenanceOption

Name	Description	Schema
period_hour optional	Period in hours Example : Pattern : `^(0\.5\|[1-5]\.5\|[1-9]\|1[0-9]\|2[0-4])$`	string
starting_day_of_week optional	Starting day of week Example : `MON`	enum (MON, TUE, WED, THU, FRI, SAT, SUN)
starting_time optional	Starting time Example :	string

5.2.21 - MaintenanceRequest

Name	Description	Schema
start_day_of_week required	start_day_of_week Example : `MON`	enum (MON, TUE, WED, THU, FRI, SAT, SUN)
start_minute required	start_minute Example :	string
start_time required	start_time Example :	string
term_hour required	term_hour Example : Pattern : `^(0\.5\|[1-5]\.5\|[1-9]\|1[0-9]\|2[0-4])$`	string

5.2.22 - MaintenanceResponseOption

Name	Description	Schema
period_hour optional	Period in hours Example :	any of [string, null]
starting_day_of_week optional	Starting day of week Example : `MON`	any of [enum (MON, TUE, WED, THU, FRI, SAT, SUN), null]
starting_time optional	Starting time Example :	any of [string, null]
use_maintenance_option optional	Maintenance period usage state Example : `False`	boolean

5.2.23 - RequestStateResponse

Name	Description	Schema	Default
request_id required	Request ID Example :	string
state required	Request state Example :	string

5.2.24 - ResizeBlockStorageGroupRequest

Name	Description	Schema	Default
size_gb required	Size in GB Example : `16` Minimum : `16` Maximum : `5120`	integer

5.2.25 - ResourceInfo

Name	Description	Schema	Default
id required	request resource id Example : `109a585ae67b4e8482fdafc8a4a5be74`	string

5.2.26 - SearchEngineClusterAddInstancesRequest

Name	Description	Schema
instance_count required	Instance Count Example :	integer
public_ip_ids optional	Public IP ID List Example :	any of [array[string], null]
service_ip_addresses required	User subnet IP address	array[string]

5.2.27 - SearchEngineClusterCreateRequest

Name	Description	Schema
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
dbaas_engine_version_id required	DBaaS engine version ID Example :	string
init_config_option required	DB initial configuration option	SearchEngineInitConfigOptionRequest
instance_groups required	Instance groups list	array[InstanceGroupRequest]
instance_name_prefix required	Instance name prefix Example : Pattern : `^[a-z][a-zA-Z0-9\-]$` Minimum length* : `3` Maximum length : `13`	string
is_combined optional	Master Data server separation state Example : `False`	boolean
license optional	license Example :	any of [string, null]
maintenance_option optional	Maintenance option	any of [MaintenanceOption, null]
name required	Cluster name Example : Pattern : `^[a-zA-Z]$` Minimum length* : `3` Maximum length : `20`	string
nat_enabled optional	NAT availability Example : `False`	boolean
subnet_id required	Subnet ID Example :	string
tags optional	tag	any of [array[Tag], null]
timezone required	Timezone Example :	string

5.2.28 - SearchEngineClusterDetailResponse

Name	Description	Schema
account_id required	Account ID Example :	string
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
dbaas_engine required	DBaaS engine Example : `PostgreSQL`	enum (PostgreSQL, Redis, Valkey Sentinel, MariaDB, MySQL, Elasticsearch Enterprise, OpenSearch, EPAS, Microsoft SQL Server, Kafka, Vertica)
dbaas_engine_version_name required	DBaaS engine version name Example :	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
init_config_option required	DB initial configuration option	SearchEngineInitConfigOptionResponse
instance_count optional	Instance Count Example : `0`	integer
instance_groups required	Instance groups list	array[InstanceGroupResponse]
is_combined optional	Master Data server separation state Example :	any of [boolean, null]
license optional	Maintenance option	any of [SearchEngineLicenseResponse, null]
maintenance_option optional	Maintenance option	any of [MaintenanceResponseOption, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster name Example :	string
nat_enabled optional	NAT availability Example :	any of [boolean, null]
product_image_type required	Product image type Example :	string
product_type required	Product type Example : `Search Engine`	enum (QOS, PostgreSQL Community, EPAS, MariaDB, MySQL, Redis, Microsoft SQL Server, Search Engine, Event Streams, Vertica, Scalable DB)
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)
software_version required	Software version Example :	string
subnet_id required	Subnet ID Example :	string
timezone required	Timezone Example :	string

5.2.29 - SearchEngineClusterRestoreRequest

Name	Description	Schema
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
backup_history_number required	Backup id Example :	string
instance_groups required	Instance groups list	array[SearchEngineRestoreInstanceGroup]
instance_name_prefix required	Instance name prefix Example : Pattern : `^[a-z][a-zA-Z0-9\-]$` Minimum length* : `3` Maximum length : `16`	string
license optional	license Example :	any of [string, null]
maintenance_option optional	Maintenance option	any of [MaintenanceOption, null]
name required	Cluster name Example : Pattern : `^[a-zA-Z]$` Minimum length* : `3` Maximum length : `20`	string
tags optional	tag	any of [array[Tag], null]

5.2.30 - SearchEngineInitConfigOptionRequest

Name	Description	Schema	Default
backup_option optional	Backup setting option	any of [BackupSettingExcludingArchiveRequest, null]
database_port optional	Database service port Example : `9200`	any of [integer, null]	9200
database_user_name required	Database User Name Example : Pattern : `^[a-z]$` Minimum length* : `2` Maximum length : `20`	string
database_user_password required	Database user password Example : Minimum length : `8` Maximum length : `30`	string

5.2.31 - SearchEngineInitConfigOptionResponse

Name	Description	Schema	Default
backup_option optional	Backup setting option	any of [BackupSettingExcludingArchiveRequest, null]
dashboards_port optional	Dashboards port Example :	any of [integer, null]
database_port optional	Database service port Example : `9200`	any of [integer, null]	9200
database_user_name required	Database User Name Example :	string
kibana_port optional	Kibana port Example :	any of [integer, null]

5.2.32 - SearchEngineLicenseResponse

Name	Description	Schema
license_expiry_date required	License expiry date Example :	string
license_status required	License state Example :	string
license_type required	License type Example :	string

5.2.33 - SearchEngineRestoreInstanceGroup

Name	Description	Schema	Default
block_storage_groups required	Block storage groups list	array[BlockStorageGroupRequest]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, ACTIVE_STANDBY, PRIMARY_SECONDARY, MASTER, MASTER_REPLICA, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, PRIMARY, PRIMARY_NODE, READ_NODE)

5.2.34 - ServerType

Name	Description	Schema
cpu_core required	Server type cpu core Example :	integer
description required	Server type description Example :	string
memory_gb required	Server type memory Example :	integer
name required	Server type name Example :	string
product_image_type required	Product image type Example :	string
product_type required	Product type Example :	string
purpose required	Server type purpose Example :	string
type required	Server type class Example :	string

5.2.35 - ServerTypeListResponse

Name	Description	Schema	Default
contents required	Server type list	array[ServerType]

5.2.36 - Tag

Name	Description	Schema	Default
key optional	Example :	string
value optional	Example :	any of [string, null]

5.2.37 - UpdateSecurityGroupRulesRequest

Name	Description	Schema	Default
add_ip_addresses optional	Allowed IP addresses list	array[string]
del_ip_addresses optional	Allowed IP addresses list	array[string]

6 - Vertica(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Vertica(DBaaS) 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	CURRENT	-

OpenAPI URL

https://vertica.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

6.1 - APIs

6.1.1 - Add Block Storages

6.1.1.1 - 1.0

post /v1/instance-groups/{instance_group_id}/block-storage-groups

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	instance_group_id required	Instance group ID Example :	string	None
body	body required		AddBlockStoragesRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/instance-groups/{instance_group_id}/block-storage-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Request body

{
    "role_type": "",
    "size_gb": 104,
    "volume_type": "SSD"
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.2 - Create Cluster

6.1.2.1 - 1.0

post /v1/clusters

Description

Create Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VerticaClusterCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Request body

{
    "allowable_ip_addresses": [],
    "dbaas_engine_version_id": "",
    "init_config_option": {
        "backup_option": {
            "retention_period_day": "",
            "starting_time_hour": ""
        },
        "database_locale": "ko_KR.utf8",
        "database_name": "",
        "database_user_name": "",
        "database_user_password": ""
    },
    "instance_groups": [
        {
            "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": ""
        }
    ],
    "instance_name_prefix": "",
    "license": "",
    "maintenance_option": {
        "period_hour": "",
        "starting_day_of_week": "MON",
        "starting_time": ""
    },
    "name": "",
    "nat_enabled": false,
    "subnet_id": "",
    "tags": [],
    "timezone": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.3 - Create Restore Cluster

6.1.3.1 - 1.0

post /v1/clusters/{cluster_id}/restore

Description

Create Restore Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		VerticaClusterRestoreRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/restore

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Request body

{
    "allowable_ip_addresses": [],
    "backup_history_number": "",
    "instance_groups": [
        {
            "block_storage_groups": [
                {
                    "role_type": "",
                    "size_gb": 104,
                    "volume_type": "SSD"
                }
            ],
            "role_type": "ACTIVE",
            "server_type_name": ""
        }
    ],
    "instance_name_prefix": "",
    "license": "",
    "maintenance_option": {
        "period_hour": "",
        "starting_day_of_week": "MON",
        "starting_time": ""
    },
    "name": "",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.4 - List Backup Histories

6.1.4.1 - 1.0

get /v1/clusters/{cluster_id}/backup-histories

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
query	limit optional	Number of backup lists Example :	any of [integer, null]	None
query	page optional	Backup list page Example :	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupHistoryListApiResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backup-histories

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_end_at": "",
            "backup_history_number": "",
            "backup_size_gb": "",
            "backup_start_at": "",
            "backup_state": "",
            "backup_state_detail": "",
            "software_version": ""
        }
    ],
    "total_count": ""
}

6.1.5 - List Clusters

6.1.5.1 - 1.0

get /v1/clusters

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	name:asc
query	name optional	Cluster name Example :	any of [string, null]	None
query	service_state optional	Service state Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	VerticaClusterPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "account_id": "",
            "console_included": false,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "database_name": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "instance_count": 0,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "nat_enabled": "",
            "role_type": "ORIGIN",
            "service_state": "RUNNING"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.6 - List Engine Version Properties

6.1.6.1 - 1.0

get /v1/engine-versions/{dbaas_engine_version_id}/properties

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	dbaas_engine_version_id required	DBaaS engine version ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	EnginePropertyListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/engine-versions/{dbaas_engine_version_id}/properties

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "name": "",
            "value": ""
        }
    ]
}

6.1.7 - List Engine Versions

6.1.7.1 - 1.0

get /v1/engine-versions

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	id optional	DBaaS engine version ID Example :	any of [string, null]	None
query	product_image_type optional	Product image type Example :	any of [enum (PostgreSQL Community, MariaDB Community, MySQL Community, EPAS, Microsoft SQL Server Enterprise, Microsoft SQL Server Standard, Redis OSS Sentinel, Valkey Sentinel, Kafka, Elasticsearch Enterprise, OpenSearch, Vertica Enterprise, Vertica Community, Scalable DB MariaDB Community), null]	None
query	eos_included optional	EoS included Example : `False`	boolean	False

Responses

HTTP Code	Description	Schema
200	OK	EngineListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/engine-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "end_of_service": false,
            "id": "",
            "major_version": "",
            "name": "",
            "os_type": "",
            "os_version": "",
            "product_image_type": "",
            "software_version": ""
        }
    ]
}

6.1.8 - List Server Types

6.1.8.1 - 1.0

get /v1/server-types

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	name optional	Server type name Example :	any of [string, null]	None
query	product_image_type optional	Product image type Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ServerTypeListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-types

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "cpu_core": "",
            "description": "",
            "memory_gb": "",
            "name": "",
            "product_image_type": "",
            "product_type": "",
            "purpose": "",
            "type": ""
        }
    ]
}

6.1.9 - Remove Backup Histories

6.1.9.1 - 1.0

put /v1/clusters/{cluster_id}/backup-histories

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		BackupHistoryNumberRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backup-histories

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Request body

{
    "backup_history_number": [
        ""
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.10 - Restart Cluster

6.1.10.1 - 1.0

post /v1/clusters/{cluster_id}/restart

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/restart

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.11 - Set Backup

6.1.11.1 - 1.0

post /v1/clusters/{cluster_id}/backups

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		BackupSettingExcludingArchiveRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Request body

{
    "retention_period_day": "",
    "starting_time_hour": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.12 - Set Block Storage Size

6.1.12.1 - 1.0

post /v1/block-storage-groups/{block_storage_group_id}/resize

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	block_storage_group_id required	Block storage group ID Example : `afc33891202643ba8ba1a5298a1affff`	string	None
body	body required		ResizeBlockStorageGroupRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/block-storage-groups/{block_storage_group_id}/resize

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Request body

{
    "size_gb": 16
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.13 - Set Maintenance

6.1.13.1 - 1.0

post /v1/clusters/{cluster_id}/maintenance

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		MaintenanceRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/maintenance

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Request body

{
    "start_day_of_week": "MON",
    "start_minute": "",
    "start_time": "",
    "term_hour": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.14 - Set Security Group Rules

6.1.14.1 - 1.0

post /v1/clusters/{cluster_id}/security-group-rules

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		UpdateSecurityGroupRulesRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/security-group-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Request body

{
    "add_ip_addresses": [],
    "del_ip_addresses": []
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.15 - Set Server Type

6.1.15.1 - 1.0

post /v1/instance-groups/{instance_group_id}/resize

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	instance_group_id required	Instance group ID Example :	string	None
body	body required		InstanceGroupResizeRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/instance-groups/{instance_group_id}/resize

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Request body

{
    "server_type_name": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.16 - Show Cluster

6.1.16.1 - 1.0

get /v1/clusters/{cluster_id}

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	VerticaClusterDetailResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Example HTTP response

Response 200

{
    "account_id": "",
    "allowable_ip_addresses": [],
    "console_included": false,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "dbaas_engine": "Vertica",
    "dbaas_engine_version_name": "09c2fe88089040ffa035604e38f7e4e9",
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "init_config_option": {
        "backup_option": {
            "retention_period_day": "",
            "starting_time_hour": ""
        },
        "database_locale": "ko_KR.utf8",
        "database_name": "",
        "database_port": 5433,
        "database_user_name": "",
        "mc_port": ""
    },
    "instance_count": 0,
    "instance_groups": [
        {
            "block_storage_groups": [
                {
                    "id": "",
                    "name": "",
                    "role_type": "OS",
                    "size_gb": "",
                    "volume_type": "SSD"
                }
            ],
            "id": "",
            "instances": [
                {
                    "name": "",
                    "public_ip_address": "",
                    "public_ip_id": "",
                    "role_type": "",
                    "service_ip_address": "",
                    "service_state": "RUNNING"
                }
            ],
            "role_type": "",
            "server_type_name": ""
        }
    ],
    "maintenance_option": {
        "period_hour": "",
        "starting_day_of_week": "MON",
        "starting_time": "",
        "use_maintenance_option": false
    },
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "",
    "nat_enabled": "",
    "product_type": "Vertica",
    "role_type": "ORIGIN",
    "service_state": "RUNNING",
    "software_version": "",
    "subnet_id": "",
    "timezone": ""
}

6.1.17 - Show Request

6.1.17.1 - 1.0

get /v1/requests/{request_id}

Description

Show Request.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	request_id required	Request ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	RequestStateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/requests/{request_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Example HTTP response

Response 200

{
    "request_id": "",
    "state": ""
}

6.1.18 - Start Cluster

6.1.18.1 - 1.0

post /v1/clusters/{cluster_id}/start

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/start

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.19 - Stop Cluster

6.1.19.1 - 1.0

post /v1/clusters/{cluster_id}/stop

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/stop

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.20 - Synchronize Cluster State

6.1.20.1 - 1.0

post /v1/clusters/{cluster_id}/sync-state

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/sync-state

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.21 - Terminate Cluster

6.1.21.1 - 1.0

delete /v1/clusters/{cluster_id}

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.22 - Unset Backup

6.1.22.1 - 1.0

delete /v1/clusters/{cluster_id}/backups

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.1.23 - Unset Maintenance

6.1.23.1 - 1.0

delete /v1/clusters/{cluster_id}/maintenance

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/maintenance

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vertica 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

6.2 - Models

6.2.1 - AddBlockStoragesRequest

Name	Description	Schema	Default
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example : `104` Minimum : `16` Maximum : `5120`	integer
volume_type optional	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)	SSD

6.2.2 - AsyncResponse

Name	Description	Schema	Default
request_id required	Request ID Example : `req-4f668846-8a3d-49f1-8111-451ebccf445c`	string
resource required	Resource	ResourceInfo

6.2.3 - BackupHistoryApiItem

Name	Description	Schema
backup_end_at required	Backup end time Example :	string
backup_history_number required	Backup id Example :	string
backup_size_gb required	Backup amount(GB) Example :	object
backup_start_at required	Backup start time Example :	string
backup_state required	Backup state Example :	string
backup_state_detail optional	Backup detail state Example :	any of [string, null]
software_version required	Software version Example :	string

6.2.4 - BackupHistoryListApiResponse

Name	Description	Schema	Default
contents required	backup list information	array[BackupHistoryApiItem]
total_count required	total number of backup history Example :	integer

6.2.5 - BackupHistoryNumberRequest

Name	Description	Schema	Default
backup_history_number required	Backup id	array[string]

6.2.6 - BackupSettingExcludingArchiveRequest

Name	Description	Schema	Default
retention_period_day required	Backup retention period (day) Example : Pattern : `^([7-9]\|^[1-2]\d\|^3[0-5])$`	string
starting_time_hour required	Backup starting time (hour) Example : Pattern : `^(\d\|1\d\|2[0-3])$`	string

6.2.7 - BlockStorageGroupRequest

Name	Description	Schema	Default
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example : `104` Minimum : `16` Maximum : `5120`	integer
volume_type optional	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)	SSD

6.2.8 - BlockStorageGroupResponse

Name	Description	Schema
id required	ID Example :	string
name required	Name Example :	string
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example :	integer
volume_type required	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)

6.2.9 - Engine

Name	Description	Schema
end_of_service optional	End of Service Example : `False`	boolean
id required	ID Example :	string
major_version required	Software major version Example :	string
name required	DBaaS engine version name Example :	string
os_type required	OS type Example :	string
os_version required	OS version Example :	string
product_image_type optional	Product type Example :	any of [string, null]
software_version required	Software version Example :	string

6.2.10 - EngineListResponse

Name	Description	Schema	Default
contents required	DBaaS engine list	array[Engine]

6.2.11 - EngineProperty

Name	Description	Schema	Default
name required	DBaas engine property name Example :	string
value required	DBaas engine property value Example :	string

6.2.12 - EnginePropertyListResponse

Name	Description	Schema	Default
contents required	DBaas engine property list	array[EngineProperty]

6.2.13 - InstanceGroupRequest

Name	Description	Schema
block_storage_groups required	Block storage groups list	array[BlockStorageGroupRequest]
instances optional	Instances list	any of [array[InstanceRequest], null]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, ACTIVE_STANDBY, PRIMARY_SECONDARY, MASTER, MASTER_REPLICA, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, PRIMARY, PRIMARY_NODE, READ_NODE)
server_type_name required	Server type name Example :	string

6.2.14 - InstanceGroupResizeRequest

Name	Description	Schema	Default
server_type_name required	Server type name Example :	string

6.2.15 - InstanceGroupResponse

Name	Description	Schema
block_storage_groups required	Block storage groups list	array[BlockStorageGroupResponse]
id required	ID Example :	string
instances required	Instances list	array[InstanceResponse]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, ACTIVE_STANDBY, PRIMARY_SECONDARY, MASTER, MASTER_REPLICA, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, PRIMARY, PRIMARY_NODE, READ_NODE)
server_type_name required	Server type name Example :	string

6.2.16 - InstanceRequest

Name	Description	Schema
public_ip_id optional	Public IP ID Example :	any of [string, null]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, STANDBY, PRIMARY, SECONDARY, MASTER, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, READ_REPLICA)
service_ip_address optional	User subnet IP address Example :	any of [string, null]

6.2.17 - InstanceResponse

Name	Description	Schema
name required	Name Example :	string
public_ip_address optional	Public IP Address Example :	any of [string, null]
public_ip_id optional	Public IP ID Example :	any of [string, null]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, STANDBY, PRIMARY, SECONDARY, MASTER, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, READ_REPLICA)
service_ip_address optional	User subnet IP address Example :	any of [string, null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)

6.2.18 - MaintenanceOption

Name	Description	Schema
period_hour optional	Period in hours Example : Pattern : `^(0\.5\|[1-5]\.5\|[1-9]\|1[0-9]\|2[0-4])$`	string
starting_day_of_week optional	Starting day of week Example : `MON`	enum (MON, TUE, WED, THU, FRI, SAT, SUN)
starting_time optional	Starting time Example :	string

6.2.19 - MaintenanceRequest

Name	Description	Schema
start_day_of_week required	start_day_of_week Example : `MON`	enum (MON, TUE, WED, THU, FRI, SAT, SUN)
start_minute required	start_minute Example :	string
start_time required	start_time Example :	string
term_hour required	term_hour Example : Pattern : `^(0\.5\|[1-5]\.5\|[1-9]\|1[0-9]\|2[0-4])$`	string

6.2.20 - MaintenanceResponseOption

Name	Description	Schema
period_hour optional	Period in hours Example :	any of [string, null]
starting_day_of_week optional	Starting day of week Example : `MON`	any of [enum (MON, TUE, WED, THU, FRI, SAT, SUN), null]
starting_time optional	Starting time Example :	any of [string, null]
use_maintenance_option optional	Maintenance period usage state Example : `False`	boolean

6.2.21 - RequestStateResponse

Name	Description	Schema	Default
request_id required	Request ID Example :	string
state required	Request state Example :	string

6.2.22 - ResizeBlockStorageGroupRequest

Name	Description	Schema	Default
size_gb required	Size in GB Example : `16` Minimum : `16` Maximum : `5120`	integer

6.2.23 - ResourceInfo

Name	Description	Schema	Default
id required	request resource id Example : `109a585ae67b4e8482fdafc8a4a5be74`	string

6.2.24 - ServerType

Name	Description	Schema
cpu_core required	Server type cpu core Example :	integer
description required	Server type description Example :	string
memory_gb required	Server type memory Example :	integer
name required	Server type name Example :	string
product_image_type required	Product image type Example :	string
product_type required	Product type Example :	string
purpose required	Server type purpose Example :	string
type required	Server type class Example :	string

6.2.25 - ServerTypeListResponse

Name	Description	Schema	Default
contents required	Server type list	array[ServerType]

6.2.26 - Tag

Name	Description	Schema	Default
key optional	Example :	string
value optional	Example :	any of [string, null]

6.2.27 - UpdateSecurityGroupRulesRequest

Name	Description	Schema	Default
add_ip_addresses optional	Allowed IP addresses list	array[string]
del_ip_addresses optional	Allowed IP addresses list	array[string]

6.2.28 - VerticaClusterCreateRequest

Name	Description	Schema
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
dbaas_engine_version_id required	DBaaS engine version ID Example :	string
init_config_option required	DB initial configuration option	VerticaInitConfigOptionRequest
instance_groups required	Instance groups list	array[InstanceGroupRequest]
instance_name_prefix required	Instance name prefix Example : Pattern : `^[a-z][a-zA-Z0-9\-]$` Minimum length* : `3` Maximum length : `13`	string
license optional	license Example : Maximum length : `5000`	string
maintenance_option optional	Maintenance option	any of [MaintenanceOption, null]
name required	Cluster name Example : Pattern : `^[a-zA-Z]$` Minimum length* : `3` Maximum length : `20`	string
nat_enabled optional	NAT availability Example : `False`	any of [boolean, null]
subnet_id required	Subnet ID Example :	string
tags optional	tag	any of [array[Tag], null]
timezone required	Timezone Example :	string

6.2.29 - VerticaClusterDetailResponse

Name	Description	Schema
account_id required	Account ID Example :	string
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
console_included optional	Management Console included state Example : `False`	boolean
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
dbaas_engine required	DBaaS engine Example : `Vertica`	enum (PostgreSQL, Redis, Valkey Sentinel, MariaDB, MySQL, Elasticsearch Enterprise, OpenSearch, EPAS, Microsoft SQL Server, Kafka, Vertica)
dbaas_engine_version_name required	DBaaS engine version name Example : `09c2fe88089040ffa035604e38f7e4e9`	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
init_config_option required	DB initial configuration option	VerticaInitConfigOptionResponse
instance_count optional	Instance Count Example : `0`	integer
instance_groups required	Instance groups list	array[InstanceGroupResponse]
maintenance_option optional	Maintenance option	any of [MaintenanceResponseOption, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster name Example :	string
nat_enabled optional	NAT availability Example :	any of [boolean, null]
product_type required	Product type Example : `Vertica`	enum (QOS, PostgreSQL Community, EPAS, MariaDB, MySQL, Redis, Microsoft SQL Server, Search Engine, Event Streams, Vertica, Scalable DB)
role_type required	Role type Example : `ORIGIN`	any of [enum (ORIGIN, REPLICA, RECOVERY, SECONDARY, MIGRATION), null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)
software_version required	Software version Example :	string
subnet_id required	Subnet ID Example :	string
timezone required	Timezone Example :	string

6.2.30 - VerticaClusterListResponse

Name	Description	Schema
account_id required	Account ID Example :	string
console_included optional	Management Console included state Example : `False`	boolean
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
database_name required	Database Name Example :	any of [string, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
instance_count optional	Instance Count Example : `0`	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster name Example :	string
nat_enabled optional	NAT availability Example :	any of [boolean, null]
role_type required	Role type Example : `ORIGIN`	any of [enum (ORIGIN, REPLICA, RECOVERY, SECONDARY, MIGRATION), null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)

6.2.31 - VerticaClusterPageResponse

Name	Description	Schema
contents required	Clusters list	any of [array[VerticaClusterListResponse], null]
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

6.2.32 - VerticaClusterRestoreRequest

Name	Description	Schema
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
backup_history_number required	Backup id Example :	string
instance_groups required	Instance groups list	array[VerticaRestoreInstanceGroup]
instance_name_prefix required	Instance name prefix Example : Pattern : `^[a-z][a-zA-Z0-9\-]$` Minimum length* : `3` Maximum length : `16`	string
license optional	license Example : Maximum length : `2000`	string
maintenance_option optional	Maintenance option	any of [MaintenanceOption, null]
name required	Cluster name Example : Pattern : `^[a-zA-Z]$` Minimum length* : `3` Maximum length : `20`	string
tags optional	tag	any of [array[Tag], null]

6.2.33 - VerticaInitConfigOptionRequest

Name	Description	Schema	Default
backup_option optional	Backup setting option	any of [BackupSettingExcludingArchiveRequest, null]
database_locale optional	Database locale information Example : `ko_KR.utf8`	any of [string, null]	ko_KR.utf8
database_name required	Database Name Example : Pattern : `^[a-zA-Z][a-zA-Z0-9]$` Minimum length* : `3` Maximum length : `20`	string
database_user_name required	Database User Name Example : Pattern : `^[a-z]$` Minimum length* : `2` Maximum length : `20`	string
database_user_password required	Database user password Example : Minimum length : `8` Maximum length : `30`	string

6.2.34 - VerticaInitConfigOptionResponse

Name	Description	Schema	Default
backup_option optional	Backup setting option	any of [BackupSettingExcludingArchiveRequest, null]
database_locale optional	Database locale information Example : `ko_KR.utf8`	any of [string, null]	ko_KR.utf8
database_name required	Database Name Example :	string
database_port optional	Database service port Example : `5433`	any of [integer, null]	5433
database_user_name required	Database User Name Example :	string
mc_port required	Database service port Example :	any of [integer, null]

6.2.35 - VerticaRestoreInstanceGroup

Name	Description	Schema
block_storage_groups required	Block storage groups list	array[BlockStorageGroupRequest]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, ACTIVE_STANDBY, PRIMARY_SECONDARY, MASTER, MASTER_REPLICA, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, PRIMARY, PRIMARY_NODE, READ_NODE)
server_type_name required	Server type name Example :	string