AI-ML

1 - AI&MLOps Platform

Overview

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

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

Version

VersionStatusSupported Until

1.1 - CLIs

1.1.1 - Check Cluster Version

1.1.1.1 - 1.0

scpcli aimlops-platform check cluster version
--cluster_id <value>
--cluster_version <value>

Description

Check AI&MLOps Platform Cluster Version.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
cluster_version
required
stringVersion1.28.1

Responses

NameDescriptionExample
resultResult

1.1.2 - Check Duplication AI&MLOps Platform Name

1.1.2.1 - 1.0

scpcli aimlops-platform check duplication
--release_name <value>

Description

Check Duplication AI&MLOps Platform Name. (false: no duplicate value, true: duplicate value)

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
release_name
required
stringRelease Nameaiml-test

Responses

NameDescriptionExample
resultResult

1.1.3 - Create AI&MLOps Platform

1.1.3.1 - 1.0

scpcli aimlops-platform create aiml platform
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_os_version <value>
--image_os <value>
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--kubernetes_engine_name <value>
--k8s_version <value>
--release_name <value>
--image_id <value>
--ai_ml_ops_platform_type <value>
[--ai_ml_ops_platform_endpoint_type <value>]
[--cluster_id <value>]
[--initial_user_email <value>]
[--initial_user_password <value>]
[--storage_class_name <value>]
[--tags <value>]
[--cifs_volume_id <value>]
[--cloud_logging_enabled <value>]
[--lb_id <value>]
[--private_acl_ip_resource <value>]
[--public_acl_ip_address <value>]
[--desired_node_count <value>]
[--is_auto_recovery <value>]
[--is_auto_scale <value>]
[--kubernetes_version <value>]
[--max_node_count <value>]
[--min_node_count <value>]

Description

Create AI&MLOps Platform.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
volume_type_name
required
stringVolume Type NameSSD
volume_size
required
integerVolume Size104
server_type_id
required
stringServer Type IDs1v16m64
name
required
stringNodepool Namenodepool-test
keypair_name
required
stringKeypair Namekeypair
image_os_version
required
stringImage OS Version22.04
image_os
required
stringImage OSubuntu
vpc_id
required
stringVPC ID10a599e031e749b7b260868f441e862b
volume_id
required
stringVolume ID10a599e031e749b7b260868f441e862b
subnet_id
required
stringSubnet ID10a599e031e749b7b260868f441e862b
security_group_id_list
required
arrayList Of Security Group ID10a599e031e749b7b260868f441e862b
kubernetes_engine_name
required
stringCluster Namecluster-test
k8s_version
required
stringKubernetes Versionv1.28.1
release_name
required
stringRelease Nameaiml-test
image_id
required
stringImage ID10a599e031e749b7b260868f441e862b
ai_ml_ops_platform_type
required
stringProduct TypeEnterprise
ai_ml_ops_platform_endpoint_type
optional
stringEndpoint Type-
cluster_id
optional
stringCluster ID10a599e031e749b7b260868f441e862b
initial_user_email
optional
stringInitial User Emailexample@gmail.com
initial_user_password
optional
stringInitial User Password147@53A69a
storage_class_name
optional
stringStorage Class Name-
tags
optional
arrayTags-
cifs_volume_id
optional
stringCifs Volume ID-
cloud_logging_enabled
optional
booleanCloud Logging Enabled-
lb_id
optional
stringLoad Balancer ID-
private_acl_ip_resource
optional
arrayPrivate Acl Ip Resource-
public_acl_ip_address
optional
stringPublic Acl Ip Address-
desired_node_count
optional
integerDesired Node Count2
is_auto_recovery
optional
booleanIs Auto RecoveryFalse
is_auto_scale
optional
booleanIs Auto ScaleFalse
kubernetes_version
optional
stringKubernetes Versionv1.28.1
max_node_count
optional
integerMax Node Count3
min_node_count
optional
integerMin Node Count2

Responses

NameDescriptionExample
project_idProject ID10a599e031e749b7b260868f441e862b
request_idRequest ID10a599e031e749b7b260868f441e862b
resource_idResource ID10a599e031e749b7b260868f441e862b

1.1.4 - Delete AI&MLOps Platform

1.1.4.1 - 1.0

scpcli aimlops-platform delete aiml platform
--release_id <value>
[--with_k8s <value>]

Description

Delete AI&MLOps Platform.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
release_id
required
stringRelease ID10a599e031e749b7b260868f441e862b
with_k8s
optional
booleanWith K8s Engine-

1.1.5 - Get AI&MLOps Platform details

1.1.5.1 - 1.0

scpcli aimlops-platform show aiml platform
--release_id <value>

Description

Get AI&MLOps Platform details.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
release_id
required
stringRelease ID10a599e031e749b7b260868f441e862b

Responses

NameDescriptionExample
ai_ml_ops_platform_domain_serviceDomain Service
ai_ml_ops_platform_endpoint_ip_addressEndpoint Ip Address
ai_ml_ops_platform_endpoint_portEndpoint Port
ai_ml_ops_platform_endpoint_typeEndpoint Type
ai_ml_ops_platform_typeProduct TypeEnterprise
cluster_idCluster ID10a599e031e749b7b260868f441e862b
cluster_nameCluster Namecluster-test
cluster_stateCluster StateRUNNING
created_byCreated By10a599e031e749b7b260868f441e862b
created_dtCreated Datetime2024-05-17T00:23:17Z
dashboard_stateDashboard State
image_idImage ID10a599e031e749b7b260868f441e862b
image_nameImage Name
initial_user_emailInitial User Email
modified_byModified By10a599e031e749b7b260868f441e862b
modified_dtModified Datetime2024-05-17T00:23:17Z
project_idProject ID10a599e031e749b7b260868f441e862b
project_nameProject Name
release_idRelease ID10a599e031e749b7b260868f441e862b
release_nameRelease Nameaiml-test
release_stateService StateDEPLOYED
storage_class_nameStorage Class Name
versionProduct Versionv1.7.1

1.1.6 - List AI&MLOps Platform

1.1.6.1 - 1.0

scpcli aimlops-platform list aiml platform
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--release_name <value>]
[--cluster_name <value>]
[--aimlopsplatform_version <value>]
[--kubeflow_type <value>]
[--status <value>]

Description

Get List of AI&MLOps Platform.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integerSize20
page
optional
integerPage0
sort
optional
stringSortcreated_dt:asc
created_by
optional
stringCreated By10a599e031e749b7b260868f441e862b
release_name
optional
stringRelease Nameaiml-test
cluster_name
optional
stringCluster Namecluster-test
aimlopsplatform_version
optional
stringVersionv1.7.1
kubeflow_type
optional
stringKubeflow TypeMini
status
optional
stringService StateDEPLOYED

Responses

NameDescriptionExample
cluster_idCluster ID10a599e031e749b7b260868f441e862b
cluster_nameCluster Namecluster-test
created_byCreated By10a599e031e749b7b260868f441e862b
created_dtCreated Datetime2024-05-17T00:23:17Z
kubeflow_typeProduct TypeEnterprise
modified_byModified By10a599e031e749b7b260868f441e862b
modified_dtModified Datetime2024-05-17T00:23:17Z
release_idRelease ID10a599e031e749b7b260868f441e862b
release_nameRelease Nameaiml-test
statusService StateDEPLOYED
versionProduct Versionv1.7.1

1.1.7 - List Images

1.1.7.1 - 1.0

scpcli aimlops-platform list image
[--size <value>]
[--page <value>]
[--sort <value>]
[--image_name <value>]

Description

Get List of AI&MLOps Platform Images.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integerSize20
page
optional
integerPage0
sort
optional
stringSortcreated_dt:asc
image_name
optional
stringImage Name-

Responses

NameDescriptionExample
base_imageBase Image
categoryCategory
created_byCreated By10a599e031e749b7b260868f441e862b
created_dtCreated Datetime2024-05-17T00:23:17Z
descriptionDescription
icon_fileIcon File
icon_file_nameIcon File Name
image_attrImage Attribute
image_idImage ID
image_nameImage Name
modified_byModified By10a599e031e749b7b260868f441e862b
modified_dtModified Datetime2024-05-17T00:23:17Z
os_typeOS Type
product_typeProduct TypeEnterprise
project_idProject ID10a599e031e749b7b260868f441e862b

1.1.8 - List Nodes

1.1.8.1 - 1.0

scpcli aimlops-platform list node
--cluster_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get List of AI&MLOps Platform Nodes.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
size
optional
integerSize20
page
optional
integerPage0
sort
optional
stringSortcreated_dt:asc

Responses

NameDescriptionExample
ageage
cluster_idcluster_id
container_versioncontainer_version
created_atcreated_at
external_ip_addressexternal_ip_address
gpu_namegpu_name
ipip
kernel_versionkernel_version
kubernetes_versionkubernetes_version
namename
node_capacitiesnode_capacities
node_statusnode_status
number_of_allocated_podsnumber_of_allocated_pods
number_of_gpunumber_of_gpu
os_imageos_image
uiduid

1.1.9 - List StorageClasses

1.1.9.1 - 1.0

scpcli aimlops-platform list storageclasse
--cluster_id <value>

Description

Get List of AI&MLOps Platform StorageClasses.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b

Responses

NameDescriptionExample
ageage
allow_volume_expansionallow_volume_expansion
cluster_idcluster_id
created_atcreated_at
default_classdefault_class
namename
provisionerprovisioner
pv_reclaim_policypv_reclaim_policy
uiduid
volume_binding_modevolume_binding_mode

1.1.10 - Update AI&MLOps Platform

1.1.10.1 - 1.0

scpcli aimlops-platform set aiml platform
--release_id <value>
[--ai_ml_ops_platform_endpoint_type <value>]
[--dns_id <value>]
[--domain_service_name <value>]
[--ip <value>]
[--operation_type <value>]
[--record_id <value>]
[--record_name <value>]

Description

Update AI&MLOps Platform.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
release_id
required
stringRelease ID10a599e031e749b7b260868f441e862b
ai_ml_ops_platform_endpoint_type
optional
stringEndpoint Type```Public
dns_id
optional
stringDNS IDacdd205d-b1d3-44e7-ab7a-429ca090e941
domain_service_name
optional
stringDomain Service Namesample.aimlopsplatform.com
ip
optional
stringIP192.168.3.197
operation_type
optional
stringOperation Type```CREATE
record_id
optional
stringRecord ID8af744b9-4893-4f98-881d-4df984de7162
record_name
optional
stringRecord Namesample

1.1.11 - Validate Cluster Namespace

1.1.11.1 - 1.0

scpcli aimlops-platform validate namespace
--cluster_id <value>

Description

Validate instability for AI&MLOps Platform. (whether already installed or not)

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b

Responses

NameDescriptionExample
resultResult

1.1.12 - Validate Cluster Resource Size

1.1.12.1 - 1.0

scpcli aimlops-platform validate cluster resource
--cluster_id <value>
--product_type <value>

Description

Validate whether Cluster Resource size is large enough or not for AI&MLOps Platform.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
product_type
required
stringProduct TypeEnterprise

Responses

NameDescriptionExample
resultResult

2 - Cloud ML

Overview

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

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

Version

VersionStatusSupported Until

2.1 - CLIs

2.1.1 - CheckDuplicationNameAndDomainName

2.1.1.1 - 1.0

scpcli cloud-ml check duplication name and domain name
[--name <value>]
[--domain_name <value>]
[--accept <value>]
[--content_type <value>]

Description

check duplication name and domain name(Please use either the ’name’ or ‘domain_name’ query parameter.)

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
optional
stringname-
domain_name
optional
stringDomain Name-
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

Responses

NameDescriptionExample
resultResult

2.1.2 - CloudMLClusterCheckEstimate

2.1.2.1 - 1.0

scpcli cloud-ml cloud ml cluster estimate
--cluster_id <value>
[--use_copilot <value>]
[--accept <value>]
[--content_type <value>]

Description

cloud ml cluster estimate

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
use_copilot
optional
booleanUse Copilot-
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

Responses

NameDescriptionExample
analyticsAnalytics Estimate
applicationApplication Estimate
copilotCopilot Estimate

2.1.3 - CloudMLImages

2.1.3.1 - 1.0

scpcli cloud-ml cloud ml images
[--accept <value>]
[--content_type <value>]

Description

cloud ml images

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

Responses

NameDescriptionExample
copilot_enabledCopilot Enabled
display_versionDisplay Version
image_idImage ID
image_nameImage Name
k8s_versionK8s Version

2.1.4 - ClusterCheckReleasable

2.1.4.1 - 1.0

scpcli cloud-ml cluster check releasable
--cluster_id <value>
[--accept <value>]
[--content_type <value>]

Description

cluster check releasable

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

Responses

NameDescriptionExample
default_messageDefault Message
detail_messageDetail Message
error_codeError Code

2.1.5 - ClusterProduct

2.1.5.1 - 1.0

scpcli cloud-ml cluster product
--cluster_id <value>
[--accept <value>]
[--content_type <value>]

Description

cluster product

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

Responses

NameDescriptionExample
cloud_mlCloud ML
cloud_ml_commonCloud ML Common

2.1.6 - CreateCloudML

2.1.6.1 - 1.0

scpcli cloud-ml create cloud ml
--image_id <value>
--endpoint_type <value>
--domain_name <value>
--custom_registry_host <value>
--custom_registry_access_secret_key <value>
--custom_registry_access_key <value>
--cluster_id <value>
--cloud_ml_name <value>
--application_resource <value>
--analytics_resource <value>
[--copilot <value>]
[--custom_registry_access_project_id <value>]
[--custom_registry_access_region <value>]
[--description <value>]
[--product_group_id <value>]
[--tags <value>]
[--use_copilot <value>]
[--accept <value>]
[--content_type <value>]

Description

create cloud ML

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID10a599e031e749b7b260868f441e862b
endpoint_type
required
stringEndpoint Type147@53A69a
domain_name
required
stringDomain Name147@53A69a
custom_registry_host
required
stringCustom Registry Host10a599e031e749b7b260868f441e862b
custom_registry_access_secret_key
required
stringCustom Registry Access Secret Key10a599e031e749b7b260868f441e862b
custom_registry_access_key
required
stringCustom Registry Access Key10a599e031e749b7b260868f441e862b
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
cloud_ml_name
required
stringCloud ML Nameaiml-test
application_resource
required
objectApplication Resource{'cpu': 0, 'memory': 0}
analytics_resource
required
objectAnalytics Resource{'cpu': 0, 'gpu': '', 'memory': 0}
copilot
optional
objectCopilot{'cpu': 0, 'gpu': '', 'memory': 0}
custom_registry_access_project_id
optional
stringCustom Registry Access Project ID10a599e031e749b7b260868f441e862b
custom_registry_access_region
optional
stringCustom Registry Access Region10a599e031e749b7b260868f441e862b
description
optional
stringDescription147@53A69a
product_group_id
optional
stringProduct Group ID10a599e031e749b7b260868f441e862b
tags
optional
arrayTags-
use_copilot
optional
booleanUse CopilotTrue
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

Responses

NameDescriptionExample
project_idProject ID10a599e031e749b7b260868f441e862b
request_idRequest ID10a599e031e749b7b260868f441e862b
resource_idResource ID10a599e031e749b7b260868f441e862b

2.1.7 - DeleteCloudML

2.1.7.1 - 1.0

scpcli cloud-ml delete cloud ml
--cloud_ml_id <value>
[--accept <value>]
[--content_type <value>]

Description

delete cloud ML

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cloud_ml_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

2.1.8 - ShowCloudML

2.1.8.1 - 1.0

scpcli cloud-ml show cloud ml
--cloud_ml_id <value>
[--accept <value>]
[--content_type <value>]

Description

get cloud ML

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cloud_ml_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

Responses

NameDescriptionExample
cloud_ml_idCloud ML Id10a599e031e749b7b260868f441e862b
cloud_ml_nameCloud ML Nameaiml-test
cloud_ml_stateCloud ML StateDEPLOYED
cluster_idCluster ID10a599e031e749b7b260868f441e862b
cluster_nameCluster Namecluster-test
cluster_permissionCluster Permission{}
cluster_request_failedCluster Request FailFalse
copilot_enabledCopilot EnableFalse
created_byCreated By10a599e031e749b7b260868f441e862b
created_dtCreated Datetime2024-05-17T00:23:17Z
custom_registry_access_keyCustom Registry Access Keyaiml-test
custom_registry_hostCustom Registry Hostaiml-test
descriptionDescriptionaiml-test
display_versionDisplay Version22.04
domain_nameDomain Nameaiml-test
endpoint_ip_addressEndpoint Ip Addressaiml-test
endpoint_typeEndpoint Typeprivate
image_idImage ID10a599e031e749b7b260868f441e862b
image_nameImage Nameaiml-test
modified_byModified By10a599e031e749b7b260868f441e862b
modified_dtModified Datetime2024-05-17T00:23:17Z
namespace_nameNamepsace Nameaiml-test
product_group_idProduct Group ID10a599e031e749b7b260868f441e862b
project_idProject ID10a599e031e749b7b260868f441e862b
request_idRequest ID10a599e031e749b7b260868f441e862b
resource_limit_textResource Limit Textaiml-test
resource_request_textResource Request Textaiml-test
storage_class_nameStorage Class Nameaiml-test

2.1.9 - UpdateCloudML

2.1.9.1 - 1.0

scpcli cloud-ml update-cloud-ml
--cloud_ml_id <value>
--description <value>
[--accept <value>]
[--content_type <value>]

Description

update cloud ML

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cloud_ml_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
description
required
stringDescription147@53A69a
accept
optional
stringAccept-
content_type
optional
stringContent-Type-