This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Cloud ML

1: CLIs

1.1: CheckDuplicationNameAndDomainName

1.1.1: 1.0

1.2: CloudMLClusterCheckEstimate

1.2.1: 1.0

1.3: CloudMLImages

1.3.1: 1.0

1.4: ClusterCheckReleasable

1.4.1: 1.0

1.5: ClusterProduct

1.5.1: 1.0

1.6: CreateCloudML

1.6.1: 1.0

1.7: DeleteCloudML

1.7.1: 1.0

1.8: ShowCloudML

1.8.1: 1.0

1.9: UpdateCloudML

1.9.1: 1.0

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Cloud ML service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Status	Not Before
1.0	CURRENT	-

1 - CLIs

1.1 - CheckDuplicationNameAndDomainName

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.)

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
name optional	string	name	-
domain_name optional	string	Domain Name	-
accept optional	string	Accept	-
content_type optional	string	Content-Type	-

Responses

Name	Description	Example
result	Result

1.2 - CloudMLClusterCheckEstimate

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

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`10a599e031e749b7b260868f441e862b`
use_copilot optional	boolean	Use Copilot	-
accept optional	string	Accept	-
content_type optional	string	Content-Type	-

Responses

Name	Description	Example
analytics	Analytics Estimate
application	Application Estimate
copilot	Copilot Estimate

1.3 - CloudMLImages

1.3.1 - 1.0

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

Description

cloud ml images

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
accept optional	string	Accept	-
content_type optional	string	Content-Type	-

Responses

Name	Description	Example
copilot_enabled	Copilot Enabled
display_version	Display Version
image_id	Image ID
image_name	Image Name
k8s_version	K8s Version

1.4 - ClusterCheckReleasable

1.4.1 - 1.0

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

Description

cluster check releasable

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`10a599e031e749b7b260868f441e862b`
accept optional	string	Accept	-
content_type optional	string	Content-Type	-

Responses

Name	Description	Example
default_message	Default Message
detail_message	Detail Message
error_code	Error Code

1.5 - ClusterProduct

1.5.1 - 1.0

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

Description

cluster product

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`10a599e031e749b7b260868f441e862b`
accept optional	string	Accept	-
content_type optional	string	Content-Type	-

Responses

Name	Description	Example
cloud_ml	Cloud ML
cloud_ml_common	Cloud ML Common

1.6 - CreateCloudML

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

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
image_id required	string	Image ID	`10a599e031e749b7b260868f441e862b`
endpoint_type required	string	Endpoint Type	`147@53A69a`
domain_name required	string	Domain Name	`147@53A69a`
custom_registry_host required	string	Custom Registry Host	`10a599e031e749b7b260868f441e862b`
custom_registry_access_secret_key required	string	Custom Registry Access Secret Key	`10a599e031e749b7b260868f441e862b`
custom_registry_access_key required	string	Custom Registry Access Key	`10a599e031e749b7b260868f441e862b`
cluster_id required	string	Cluster ID	`10a599e031e749b7b260868f441e862b`
cloud_ml_name required	string	Cloud ML Name	`aiml-test`
application_resource required	object	Application Resource	`{'cpu': 0, 'memory': 0}`
analytics_resource required	object	Analytics Resource	`{'cpu': 0, 'gpu': '', 'memory': 0}`
copilot optional	object	Copilot	`{'cpu': 0, 'gpu': '', 'memory': 0}`
custom_registry_access_project_id optional	string	Custom Registry Access Project ID	`10a599e031e749b7b260868f441e862b`
custom_registry_access_region optional	string	Custom Registry Access Region	`10a599e031e749b7b260868f441e862b`
description optional	string	Description	`147@53A69a`
product_group_id optional	string	Product Group ID	`10a599e031e749b7b260868f441e862b`
tags optional	array	Tags	-
use_copilot optional	boolean	Use Copilot	`True`
accept optional	string	Accept	-
content_type optional	string	Content-Type	-

Responses

Name	Description	Example
project_id	Project ID	10a599e031e749b7b260868f441e862b
request_id	Request ID	10a599e031e749b7b260868f441e862b
resource_id	Resource ID	10a599e031e749b7b260868f441e862b

1.7 - DeleteCloudML

1.7.1 - 1.0

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

Description

delete cloud ML

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cloud_ml_id required	string	Cluster ID	`10a599e031e749b7b260868f441e862b`
accept optional	string	Accept	-
content_type optional	string	Content-Type	-

1.8 - ShowCloudML

1.8.1 - 1.0

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

Description

get cloud ML

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cloud_ml_id required	string	Cluster ID	`10a599e031e749b7b260868f441e862b`
accept optional	string	Accept	-
content_type optional	string	Content-Type	-

Responses

Name	Description	Example
cloud_ml_id	Cloud ML Id	10a599e031e749b7b260868f441e862b
cloud_ml_name	Cloud ML Name	aiml-test
cloud_ml_state	Cloud ML State	DEPLOYED
cluster_id	Cluster ID	10a599e031e749b7b260868f441e862b
cluster_name	Cluster Name	cluster-test
cluster_permission	Cluster Permission	{}
cluster_request_failed	Cluster Request Fail	False
copilot_enabled	Copilot Enable	False
created_by	Created By	10a599e031e749b7b260868f441e862b
created_dt	Created Datetime	2024-05-17T00:23:17Z
custom_registry_access_key	Custom Registry Access Key	aiml-test
custom_registry_host	Custom Registry Host	aiml-test
description	Description	aiml-test
display_version	Display Version	22.04
domain_name	Domain Name	aiml-test
endpoint_ip_address	Endpoint Ip Address	aiml-test
endpoint_type	Endpoint Type	private
image_id	Image ID	10a599e031e749b7b260868f441e862b
image_name	Image Name	aiml-test
modified_by	Modified By	10a599e031e749b7b260868f441e862b
modified_dt	Modified Datetime	2024-05-17T00:23:17Z
namespace_name	Namepsace Name	aiml-test
product_group_id	Product Group ID	10a599e031e749b7b260868f441e862b
project_id	Project ID	10a599e031e749b7b260868f441e862b
request_id	Request ID	10a599e031e749b7b260868f441e862b
resource_limit_text	Resource Limit Text	aiml-test
resource_request_text	Resource Request Text	aiml-test
storage_class_name	Storage Class Name	aiml-test

1.9 - UpdateCloudML

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

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cloud_ml_id required	string	Cluster ID	`10a599e031e749b7b260868f441e862b`
description required	string	Description	`147@53A69a`
accept optional	string	Accept	-
content_type optional	string	Content-Type	-