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

이 페이지의 일반 화면으로 돌아가기.

APIs

1 - CheckDuplicationNameAndDomainName

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
headeraccept
optional		Accept
Example : application/json
stringapplication/json
headercontent_type
optional		Content-Type
Example : application/json
stringapplication/json
queryname
optional		name
Example :
stringNone
querydomain_name
optional		Domain Name
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKCloudMLCheckDuplicationResponse
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

Example HTTP request

Request path

/v1/cloud-ml/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 = cloud-ml 1.0"

Example HTTP response

Response 200

{
    "result": false
}

2 - CloudMLClusterCheckEstimate

2.1 - 1.0

get /v1/cloud-ml/clusters/{cluster_id}/estimate

Description

cloud ml cluster estimate

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
headeraccept
optional		Accept
Example : application/json
stringapplication/json
headercontent_type
optional		Content-Type
Example : application/json
stringapplication/json
pathcluster_id
required		Cluster ID
Example : 10a599e031e749b7b260868f441e862b
stringNone
queryuse_copilot
optional		Use Copilot
Example : False
booleanFalse

Responses

HTTP CodeDescriptionSchema
200OKCloudMLClusterEstimateResponse
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

Example HTTP request

Request path

/v1/cloud-ml/clusters/{cluster_id}/estimate

Request header

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

Example HTTP response

Response 200

{
    "analytics": {
        "cpu": "",
        "gpu": "",
        "memory": ""
    },
    "application": {
        "cpu": "",
        "memory": ""
    },
    "copilot": {}
}

3 - CloudMLImages

3.1 - 1.0

get /v1/cloud-ml/images

Description

cloud ml images

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
headeraccept
optional		Accept
Example : application/json
stringapplication/json
headercontent_type
optional		Content-Type
Example : application/json
stringapplication/json

Responses

HTTP CodeDescriptionSchema
200OKImageVersionsResponse
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

Example HTTP request

Request path

/v1/cloud-ml/images

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"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": ""
}

4 - ClusterCheckReleasable

4.1 - 1.0

get /v1/cloud-ml/clusters/{cluster_id}/check-releasable

Description

cluster check releasable

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
headeraccept
optional		Accept
Example : application/json
stringapplication/json
headercontent_type
optional		Content-Type
Example : application/json
stringapplication/json
pathcluster_id
required		Cluster ID
Example : 10a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
200OKCloudMLClusterCheckReleasableResponse
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

Example HTTP request

Request path

/v1/cloud-ml/clusters/{cluster_id}/check-releasable

Request header

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

Example HTTP response

Response 200

{
    "exceptions": [],
    "result": true
}

5 - ClusterProduct

5.1 - 1.0

get /v1/cloud-ml/clusters/{cluster_id}

Description

cluster product

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
headeraccept
optional		Accept
Example : application/json
stringapplication/json
headercontent_type
optional		Content-Type
Example : application/json
stringapplication/json
pathcluster_id
required		Cluster ID
Example : 10a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
200OKCloudMLClusterProductsResponse
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

Example HTTP request

Request path

/v1/cloud-ml/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 = cloud-ml 1.0"

Example HTTP response

Response 200

{
    "cloud_ml": {},
    "cloud_ml_common": {}
}

6 - CreateCloudML

6.1 - 1.0

post /v1/cloud-ml

Description

create cloud ML

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
headeraccept
optional		Accept
Example : application/json
stringapplication/json
headercontent_type
optional		Content-Type
Example : application/json
stringapplication/json
bodybody
required
CloudMLRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

Example HTTP request

Request path

/v1/cloud-ml

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"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"
}

7 - DeleteCloudML

7.1 - 1.0

delete /v1/cloud-ml/{cloud_ml_id}

Description

delete cloud ML

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
headeraccept
optional		Accept
Example : application/json
stringapplication/json
headercontent_type
optional		Content-Type
Example : application/json
stringapplication/json
pathcloud_ml_id
required		Cluster ID
Example : 10a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone
500Internal Server ErrorNone

Example HTTP request

Request path

/v1/cloud-ml/{cloud_ml_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 = cloud-ml 1.0"

Example HTTP response

Response 202

8 - ShowCloudML

8.1 - 1.0

get /v1/cloud-ml/{cloud_ml_id}

Description

get cloud ML

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
headeraccept
optional		Accept
Example : application/json
stringapplication/json
headercontent_type
optional		Content-Type
Example : application/json
stringapplication/json
pathcloud_ml_id
required		Cluster ID
Example : 10a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
200OKCloudMLDetailResponse
400Bad RequestCloudMLExceptionResponse
401UnauthorizedCloudMLExceptionResponse
404Not FoundCloudMLExceptionResponse

Example HTTP request

Request path

/v1/cloud-ml/{cloud_ml_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 = 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"
}

9 - UpdateCloudML

9.1 - 1.0

put /v1/cloud-ml/{cloud_ml_id}

Description

update cloud ML

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
headeraccept
optional		Accept
Example : application/json
stringapplication/json
headercontent_type
optional		Content-Type
Example : application/json
stringapplication/json
pathcloud_ml_id
required		Cluster ID
Example : 10a599e031e749b7b260868f441e862b
stringNone
bodybody
required
CloudMLUpdateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedCloudMLDetailResponse
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

Example HTTP request

Request path

/v1/cloud-ml/{cloud_ml_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 = 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"
}