Cloud ML
Overview
Provides an Application Programming Interface (API) 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 API.
The API is provided as a RESTful API, and it responds in JSON format.
Version
| Version | Status | Supported Until |
|---|
OpenAPI URL
https://cloud-ml.{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.1 - 1.0
get /v1/cloud-ml/check-duplication
Description
check duplication name and domain name(Please use either the ’name’ or ‘domain_name’ query parameter.)
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.0 | - |
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 |
| query | name optional | name Example :
| string | None |
| query | domain_name optional | Domain Name Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/cloud-ml/check-duplication
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = cloud-ml 1.0"
Example HTTP response
Response 200
1.2.1 - 1.0
get /v1/cloud-ml/clusters/{cluster_id}/estimate
Description
cloud ml cluster estimate
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.0 | - |
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 |
| path | cluster_id required | Cluster ID Example : 10a599e031e749b7b260868f441e862b
| string | None |
| query | use_copilot optional | Use Copilot Example : False
| boolean | False |
Responses
Example HTTP request
Request path
/v1/cloud-ml/clusters/{cluster_id}/estimate
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = cloud-ml 1.0"
Example HTTP response
Response 200
{
"analytics": {
"cpu": "",
"gpu": "",
"memory": ""
},
"application": {
"cpu": "",
"memory": ""
},
"copilot": {}
}
1.3.1 - 1.0
get /v1/cloud-ml/images
Description
cloud ml images
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.0 | - |
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 |
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/cloud-ml/images
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = cloud-ml 1.0"
Example HTTP response
Response 200
{
"contents": [
{
"copilot_enabled": "",
"display_version": "",
"image_id": "",
"image_name": "",
"k8s_version": ""
}
],
"total_count": ""
}
1.4.1 - 1.0
get /v1/cloud-ml/clusters/{cluster_id}/check-releasable
Description
cluster check releasable
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.0 | - |
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 |
| path | cluster_id required | Cluster ID Example : 10a599e031e749b7b260868f441e862b
| string | None |
Responses
Example HTTP request
Request path
/v1/cloud-ml/clusters/{cluster_id}/check-releasable
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = cloud-ml 1.0"
Example HTTP response
Response 200
{
"exceptions": [],
"result": true
}
1.5.1 - 1.0
get /v1/cloud-ml/clusters/{cluster_id}
Description
cluster product
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.0 | - |
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 |
| path | cluster_id required | Cluster ID Example : 10a599e031e749b7b260868f441e862b
| string | None |
Responses
Example HTTP request
Request path
/v1/cloud-ml/clusters/{cluster_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = cloud-ml 1.0"
Example HTTP response
Response 200
{
"cloud_ml": {},
"cloud_ml_common": {}
}
1.6.1 - 1.0
post /v1/cloud-ml
Description
create cloud ML
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.0 | - |
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 |
| body | body required |
| CloudMLRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-ml
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = cloud-ml 1.0"
Request body
{
"analytics_resource": {
"cpu": 0,
"gpu": "",
"memory": 0
},
"application_resource": {
"cpu": 0,
"memory": 0
},
"cloud_ml_name": "aiml-test",
"cluster_id": "10a599e031e749b7b260868f441e862b",
"copilot": {
"cpu": 0,
"gpu": "",
"memory": 0
},
"custom_registry_access_key": "10a599e031e749b7b260868f441e862b",
"custom_registry_access_project_id": "10a599e031e749b7b260868f441e862b",
"custom_registry_access_region": "10a599e031e749b7b260868f441e862b",
"custom_registry_access_secret_key": "10a599e031e749b7b260868f441e862b",
"custom_registry_host": "10a599e031e749b7b260868f441e862b",
"description": "147@53A69a",
"domain_name": "147@53A69a",
"endpoint_type": "147@53A69a",
"image_id": "10a599e031e749b7b260868f441e862b",
"product_group_id": "10a599e031e749b7b260868f441e862b",
"tags": [],
"use_copilot": true
}
Example HTTP response
Response 200
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
1.7.1 - 1.0
delete /v1/cloud-ml/{cloud_ml_id}
Description
delete cloud ML
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.0 | - |
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 |
| path | cloud_ml_id required | Cluster ID Example : 10a599e031e749b7b260868f441e862b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/cloud-ml/{cloud_ml_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = cloud-ml 1.0"
Example HTTP response
Response 202
1.8.1 - 1.0
get /v1/cloud-ml/{cloud_ml_id}
Description
get cloud ML
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.0 | - |
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 |
| path | cloud_ml_id required | Cluster ID Example : 10a599e031e749b7b260868f441e862b
| string | None |
Responses
Example HTTP request
Request path
/v1/cloud-ml/{cloud_ml_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = cloud-ml 1.0"
Example HTTP response
Response 200
{
"cloud_ml_id": "10a599e031e749b7b260868f441e862b",
"cloud_ml_name": "aiml-test",
"cloud_ml_state": "DEPLOYED",
"cluster_id": "10a599e031e749b7b260868f441e862b",
"cluster_name": "cluster-test",
"cluster_permission": {},
"cluster_request_failed": false,
"copilot_enabled": false,
"created_by": "10a599e031e749b7b260868f441e862b",
"created_dt": "2024-05-17T00:23:17Z",
"custom_registry_access_key": "aiml-test",
"custom_registry_host": "aiml-test",
"description": "aiml-test",
"display_version": "22.04",
"domain_name": "aiml-test",
"endpoint_ip_address": "aiml-test",
"endpoint_type": "private",
"image_id": "10a599e031e749b7b260868f441e862b",
"image_name": "aiml-test",
"modified_by": "10a599e031e749b7b260868f441e862b",
"modified_dt": "2024-05-17T00:23:17Z",
"namespace_name": "aiml-test",
"product_group_id": "10a599e031e749b7b260868f441e862b",
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_limit_text": "aiml-test",
"resource_request_text": "aiml-test",
"storage_class_name": "aiml-test"
}
1.9.1 - 1.0
put /v1/cloud-ml/{cloud_ml_id}
Description
update cloud ML
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.0 | - |
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 |
| path | cloud_ml_id required | Cluster ID Example : 10a599e031e749b7b260868f441e862b
| string | None |
| body | body required |
| CloudMLUpdateRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | CloudMLDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-ml/{cloud_ml_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = cloud-ml 1.0"
Request body
{
"description": "147@53A69a"
}
Example HTTP response
Response 202
{
"cloud_ml_id": "10a599e031e749b7b260868f441e862b",
"cloud_ml_name": "aiml-test",
"cloud_ml_state": "DEPLOYED",
"cluster_id": "10a599e031e749b7b260868f441e862b",
"cluster_name": "cluster-test",
"cluster_permission": {},
"cluster_request_failed": false,
"copilot_enabled": false,
"created_by": "10a599e031e749b7b260868f441e862b",
"created_dt": "2024-05-17T00:23:17Z",
"custom_registry_access_key": "aiml-test",
"custom_registry_host": "aiml-test",
"description": "aiml-test",
"display_version": "22.04",
"domain_name": "aiml-test",
"endpoint_ip_address": "aiml-test",
"endpoint_type": "private",
"image_id": "10a599e031e749b7b260868f441e862b",
"image_name": "aiml-test",
"modified_by": "10a599e031e749b7b260868f441e862b",
"modified_dt": "2024-05-17T00:23:17Z",
"namespace_name": "aiml-test",
"product_group_id": "10a599e031e749b7b260868f441e862b",
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_limit_text": "aiml-test",
"resource_request_text": "aiml-test",
"storage_class_name": "aiml-test"
}