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

Return to the regular view of this page.

Kubernetes

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 KUBERNETES service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1CURRENT-

OpenAPI URL

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

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

1 - APIs

1.1 - Create Cluster

1.1.1 - 1.1

post /v1/clusters

Description

create a cluster V1.1

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

ClusterCreateRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "cloud_logging_enabled": "true",
    "kubernetes_version": "v1.29.8",
    "name": "sample-cluster",
    "private_endpoint_access_control_resources": [],
    "public_endpoint_access_control_ip": "192.168.0.0",
    "security_group_id_list": [
        "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79"
    ],
    "service_watch_logging_enabled": "true",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": [],
    "volume_id": [
        "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
    ],
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.1.2 - 1.0

post /v1/clusters

Description

create a cluster

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

ClusterCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "cloud_logging_enabled": "true",
    "kubernetes_version": "v1.29.8",
    "name": "sample-cluster",
    "private_endpoint_access_control_resources": [],
    "public_endpoint_access_control_ip": "192.168.0.0",
    "security_group_id_list": [
        "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79"
    ],
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": [],
    "volume_id": [
        "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
    ],
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.2 - Create Cluster Kubeconfig

1.2.1 - 1.1

get /v1/clusters/{cluster_id}/kubeconfig

Description

Create kubeconfig file for the cluster

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querykubeconfig_type
required
Kubeconfig Type (private/public)
Example : private
enum (private, public)None

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/kubeconfig?kubeconfig_type={kubeconfig_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

1.2.2 - 1.0

get /v1/clusters/{cluster_id}/kubeconfig

Description

Create kubeconfig file for the cluster

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querykubeconfig_type
required
Kubeconfig Type (private/public)
Example : private
enum (private, public)None

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/kubeconfig?kubeconfig_type={kubeconfig_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

1.3 - Create Nodepool

1.3.1 - 1.1

post /v1/nodepools

Description

create a nodepool V1.1

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

NodepoolCreateRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
200OKNodepoolShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "advanced_settings": {
        "allowed_unsafe_sysctls": "kernel.msg*,net.ipv4.route.min_pmtu",
        "container_log_max_files": "5",
        "container_log_max_size": "10",
        "image_gc_high_threshold": "85",
        "image_gc_low_threshold": "80",
        "max_pods": "110",
        "pod_max_pids": "4096"
    },
    "cluster_id": "70a599e031e749b7b260868f441e862b",
    "custom_image_id": "10a599e031e749b7b260868f441e862b",
    "desired_node_count": "2",
    "image_os": "ubuntu",
    "image_os_version": "22.04",
    "is_auto_recovery": "true",
    "is_auto_scale": "true",
    "keypair_name": "test_keypair",
    "kubernetes_version": "v1.29.8",
    "labels": [
        {
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "max_node_count": "5",
    "min_node_count": "1",
    "name": "sample-nodepool",
    "server_group_id": "2b8d33d5-4de5-40a5-a34c-7e30204133xc",
    "server_type_id": "10a599e031e749b7b260868f441e862b",
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "volume_size": "104",
    "volume_type_name": "SSD"
}

Example HTTP response

Response 200

{
    "nodepool": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "advanced_settings": {
            "allowed_unsafe_sysctls": "kernel.msg*,net.ipv4.route.min_pmtu",
            "container_log_max_files": "5",
            "container_log_max_size": "10",
            "image_gc_high_threshold": "85",
            "image_gc_low_threshold": "80",
            "max_pods": "110",
            "pod_max_pids": "4096"
        },
        "auto_recovery_enabled": "true",
        "auto_scale_enabled": "true",
        "cluster": {
            "id": "70a599e031e749b7b260868f441e862b"
        },
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_node_count": "1",
        "desired_node_count": "2",
        "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
        "image": {
            "custom_image_name": "custom-image",
            "os": "ubuntu",
            "os_version": "22.04"
        },
        "keypair": {
            "name": "test_keypair"
        },
        "kubernetes_version": "v1.29.8",
        "labels": [
            {
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "max_node_count": "5",
        "min_node_count": "1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-nodepool",
        "server_group_id": "2b8d33d5-4de5-40a5-a34c-7e30204133xc",
        "server_type": {
            "description": "Standard",
            "id": "10a599e031e749b7b260868f441e862b"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "10a599e031e749b7b260868f441e862b",
            "name": "SSD"
        }
    }
}

1.3.2 - 1.0

post /v1/nodepools

Description

create a nodepool

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

NodepoolCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKNodepoolShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "cluster_id": "70a599e031e749b7b260868f441e862b",
    "custom_image_id": "10a599e031e749b7b260868f441e862b",
    "desired_node_count": "2",
    "image_os": "ubuntu",
    "image_os_version": "22.04",
    "is_auto_recovery": "true",
    "is_auto_scale": "true",
    "keypair_name": "test_keypair",
    "kubernetes_version": "v1.29.8",
    "labels": [
        {
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "max_node_count": "5",
    "min_node_count": "1",
    "name": "sample-nodepool",
    "server_type_id": "10a599e031e749b7b260868f441e862b",
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ],
    "volume_size": "104",
    "volume_type_name": "SSD"
}

Example HTTP response

Response 200

{
    "nodepool": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "auto_recovery_enabled": "true",
        "auto_scale_enabled": "true",
        "cluster": {
            "id": "70a599e031e749b7b260868f441e862b"
        },
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_node_count": "1",
        "desired_node_count": "2",
        "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
        "image": {
            "custom_image_name": "custom-image",
            "os": "ubuntu",
            "os_version": "22.04"
        },
        "keypair": {
            "name": "test_keypair"
        },
        "kubernetes_version": "v1.29.8",
        "labels": [
            {
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "max_node_count": "5",
        "min_node_count": "1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-nodepool",
        "server_type": {
            "description": "Standard",
            "id": "10a599e031e749b7b260868f441e862b"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "10a599e031e749b7b260868f441e862b",
            "name": "SSD"
        }
    }
}

1.4 - Delete Cluster

1.4.1 - 1.1

delete /v1/clusters/{cluster_id}

Description

delete a specific cluster

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.4.2 - 1.0

delete /v1/clusters/{cluster_id}

Description

delete a specific cluster

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.5 - Delete Nodepool

1.5.1 - 1.1

delete /v1/nodepools/{nodepool_id}

Description

delete a nodepool

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.5.2 - 1.0

delete /v1/nodepools/{nodepool_id}

Description

delete a nodepool

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.6 - List Clusters

1.6.1 - 1.1

get /v1/clusters

Description

get clusters list

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryname
optional
Cluster Name
Example : sample-cluster
any of [string, null]None
querystatus
optional
Cluster Status
Example : RUNNING
any of [array[string], string, null]None
querykubernetes_version
optional
Cluster Version
Example : v1.29.8
any of [array[string], string, null]None
querysubnet_id
optional
Cluster Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKClusterListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

{
    "clusters": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "created_at": "2025-03-31T00:23:17Z",
            "id": "70a599e031e749b7b260868f441e862b",
            "kubernetes_version": "v1.29.8",
            "modified_at": "2025-03-31T00:23:17Z",
            "name": "sample-cluster",
            "node_count": "5",
            "status": "RUNNING",
            "subnet_id": "023c57b14f11483689338d085e061492"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

1.6.2 - 1.0

get /v1/clusters

Description

get clusters list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryname
optional
Cluster Name
Example : sample-cluster
any of [string, null]None
querystatus
optional
Cluster Status
Example : RUNNING
any of [array[string], string, null]None
querykubernetes_version
optional
Cluster Version
Example : v1.29.8
any of [array[string], string, null]None
querysubnet_id
optional
Cluster Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKClusterListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

{
    "clusters": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "created_at": "2025-03-31T00:23:17Z",
            "id": "70a599e031e749b7b260868f441e862b",
            "kubernetes_version": "v1.29.8",
            "modified_at": "2025-03-31T00:23:17Z",
            "name": "sample-cluster",
            "node_count": "5",
            "status": "RUNNING",
            "subnet_id": "023c57b14f11483689338d085e061492"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

1.7 - List Kubernetes Versions

1.7.1 - 1.1

get /v1/kubernetes-versions

Description

get kubernetes versions list

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Responses

HTTP CodeDescriptionSchema
200OKKubernetesVersionListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/kubernetes-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

{
    "kubernetes_versions": [
        {
            "description": "v1.29.8",
            "kubernetes_version": "v1.29.8"
        }
    ]
}

1.7.2 - 1.0

get /v1/kubernetes-versions

Description

get kubernetes versions list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Responses

HTTP CodeDescriptionSchema
200OKKubernetesVersionListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/kubernetes-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

{
    "kubernetes_versions": [
        {
            "description": "v1.29.8",
            "kubernetes_version": "v1.29.8"
        }
    ]
}

1.8 - List Nodepool Nodes

1.8.1 - 1.1

get /v1/nodepools/{nodepool_id}/nodes

Description

Get nodepool node list

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querynode_name
optional
Node Name
Example : ske-aug-rhel-0805-1-84d799f767-8dr2p
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKNodeListInNodepoolResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/nodes

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nodes": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "kubernetes_version": "v1.29.8",
            "name": "ske-aug-rhel-0805-1-84d799f767-8dr2p",
            "status": "RUNNING"
        }
    ]
}

1.8.2 - 1.0

get /v1/nodepools/{nodepool_id}/nodes

Description

Get nodepool node list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querynode_name
optional
Node Name
Example : ske-aug-rhel-0805-1-84d799f767-8dr2p
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKNodeListInNodepoolResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/nodes

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nodes": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "kubernetes_version": "v1.29.8",
            "name": "ske-aug-rhel-0805-1-84d799f767-8dr2p",
            "status": "RUNNING"
        }
    ]
}

1.9 - List Nodepools

1.9.1 - 1.1

get /v1/clusters/{cluster_id}/nodepools

Description

get nodepools list

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querynodepool_name
optional
Nodepool Name
Example : sample-nodepool
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKNodepoolListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/nodepools

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nodepools": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "auto_recovery_enabled": "",
            "auto_scale_enabled": "",
            "current_node_count": "1",
            "desired_node_count": "2",
            "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
            "image": {
                "custom_image_name": "custom-image",
                "os": "ubuntu",
                "os_version": "22.04"
            },
            "kubernetes_version": "v1.29.8",
            "name": "sample-nodepool",
            "server_type": {
                "description": "Standard",
                "id": "10a599e031e749b7b260868f441e862b"
            },
            "status": "Running",
            "volume_type": {
                "id": "10a599e031e749b7b260868f441e862b",
                "name": "SSD"
            }
        }
    ]
}

1.9.2 - 1.0

get /v1/clusters/{cluster_id}/nodepools

Description

get nodepools list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querynodepool_name
optional
Nodepool Name
Example : sample-nodepool
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKNodepoolListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/nodepools

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nodepools": [
        {
            "account_id": "617b3d0e90c24a5fa1f65a3824861354",
            "auto_recovery_enabled": "",
            "auto_scale_enabled": "",
            "current_node_count": "1",
            "desired_node_count": "2",
            "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
            "image": {
                "custom_image_name": "custom-image",
                "os": "ubuntu",
                "os_version": "22.04"
            },
            "kubernetes_version": "v1.29.8",
            "name": "sample-nodepool",
            "server_type": {
                "description": "Standard",
                "id": "10a599e031e749b7b260868f441e862b"
            },
            "status": "Running",
            "volume_type": {
                "id": "10a599e031e749b7b260868f441e862b",
                "name": "SSD"
            }
        }
    ]
}

1.10 - Set Cluster Logging

1.10.1 - 1.1

put /v1/clusters/{cluster_id}/logging

Description

Set logging on the cluster

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterLoggingSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/logging

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "cloud_logging_enabled": "true"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.10.2 - 1.0

put /v1/clusters/{cluster_id}/logging

Description

Set logging on the cluster

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterLoggingSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/logging

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "cloud_logging_enabled": "true"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.11 - Set Cluster Private Access Control

1.11.1 - 1.1

put /v1/clusters/{cluster_id}/private-access-control

Description

set a private access control specific cluster

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterPrivateAccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/private-access-control

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "private_endpoint_access_control_resources": [
        {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name",
            "type": "vm"
        }
    ]
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.11.2 - 1.0

put /v1/clusters/{cluster_id}/private-access-control

Description

set a private access control specific cluster

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterPrivateAccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/private-access-control

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "private_endpoint_access_control_resources": [
        {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name",
            "type": "vm"
        }
    ]
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.12 - Set Cluster Public Access Control

1.12.1 - 1.1

put /v1/clusters/{cluster_id}/public-access-control

Description

set a public access control specific cluster

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterPublicAccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/public-access-control

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "public_endpoint_access_control_ip": "192.168.0.0"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.12.2 - 1.0

put /v1/clusters/{cluster_id}/public-access-control

Description

set a public access control specific cluster

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterPublicAccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/public-access-control

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "public_endpoint_access_control_ip": "192.168.0.0"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.13 - Set Cluster Security Groups

1.13.1 - 1.1

put /v1/clusters/{cluster_id}/security-groups

Description

Set Cluster Security Groups

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterSecurityGroupsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/security-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "security_group_id_list": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79"
}

Example HTTP response

Response 200

{
    "cluster": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "cloud_logging_enabled": "true",
        "cluster_namespace": "sample-cluster-12345",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kubernetes_version": "v1.29.8",
        "managed_security_group": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "max_node_count": "5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-cluster",
        "node_count": "5",
        "private_endpoint_access_control_resources": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name",
                "type": "vm"
            }
        ],
        "private_endpoint_url": "N",
        "private_kubeconfig_download_yn": "https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443",
        "public_endpoint_access_control_ip": "192.168.0.0",
        "public_endpoint_url": "https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443",
        "public_kubeconfig_download_yn": "N",
        "security_group_list": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name"
            }
        ],
        "status": "RUNNING",
        "subnet": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "volume": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "vpc": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        }
    }
}

1.13.2 - 1.0

put /v1/clusters/{cluster_id}/security-groups

Description

Set Cluster Security Groups

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterSecurityGroupsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/security-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "security_group_id_list": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79"
}

Example HTTP response

Response 200

{
    "cluster": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "cloud_logging_enabled": "true",
        "cluster_namespace": "sample-cluster-12345",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kubernetes_version": "v1.29.8",
        "managed_security_group": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "max_node_count": "5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-cluster",
        "node_count": "5",
        "private_endpoint_access_control_resources": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name",
                "type": "vm"
            }
        ],
        "private_endpoint_url": "N",
        "private_kubeconfig_download_yn": "https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443",
        "public_endpoint_access_control_ip": "192.168.0.0",
        "public_endpoint_url": "https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443",
        "public_kubeconfig_download_yn": "N",
        "security_group_list": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name"
            }
        ],
        "status": "RUNNING",
        "subnet": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "volume": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "vpc": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        }
    }
}

1.14 - Set Cluster Service Watch Logging

1.14.1 - 1.1

put /v1/clusters/{cluster_id}/service-watch-logging

Description

Set Service Watch logging on the cluster

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterServiceWatchLoggingSetRequest

Responses

HTTP CodeDescriptionSchema
200OKClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/service-watch-logging

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "service_watch_logging_enabled": "true"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.15 - Set Cluster Upgrade

1.15.1 - 1.1

put /v1/clusters/{cluster_id}/upgrade

Description

upgrade a specific cluster

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterUpgradeSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/upgrade

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "kubernetes_version": "v1.29.8"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.15.2 - 1.0

put /v1/clusters/{cluster_id}/upgrade

Description

upgrade a specific cluster

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
bodybody
required

ClusterUpgradeSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedClusterSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/upgrade

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "kubernetes_version": "v1.29.8"
}

Example HTTP response

Response 202

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.16 - Set Nodepool

1.16.1 - 1.1

put /v1/nodepools/{nodepool_id}

Description

set a nodepool

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolUpdateRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "desired_node_count": "2",
    "is_auto_recovery": "true",
    "is_auto_scale": "true",
    "max_node_count": "5",
    "min_node_count": "1"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.16.2 - 1.0

put /v1/nodepools/{nodepool_id}

Description

set a nodepool

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolUpdateRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "desired_node_count": "2",
    "is_auto_recovery": "true",
    "is_auto_scale": "true",
    "max_node_count": "5",
    "min_node_count": "1"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.17 - Set Nodepool Labels

1.17.1 - 1.1

put /v1/nodepools/{nodepool_id}/labels

Description

set nodepool labels

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolLabelsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/labels

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "labels": [
        {
            "key": "example.com/my-app",
            "value": "bar"
        }
    ]
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.17.2 - 1.0

put /v1/nodepools/{nodepool_id}/labels

Description

set nodepool labels

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolLabelsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/labels

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "labels": [
        {
            "key": "example.com/my-app",
            "value": "bar"
        }
    ]
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.18 - Set Nodepool Taints

1.18.1 - 1.1

put /v1/nodepools/{nodepool_id}/taints

Description

set nodepool taints

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolTaintsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/taints

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ]
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.18.2 - 1.0

put /v1/nodepools/{nodepool_id}/taints

Description

set nodepool taints

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolTaintsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/taints

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Request body

{
    "taints": [
        {
            "effect": "NoSchedule",
            "key": "example.com/my-app",
            "value": "bar"
        }
    ]
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.19 - Set Nodepool Upgrade

1.19.1 - 1.1

put /v1/nodepools/{nodepool_id}/upgrade

Description

upgrade a nodepool

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone
bodybody
required

NodepoolUpgradeSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/upgrade

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Request body

{
    "os_version": "22.04"
}

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.19.2 - 1.0

put /v1/nodepools/{nodepool_id}/upgrade

Description

upgrade a nodepool

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAsyncResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}/upgrade

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

{
    "account_id": "617b3d0e90c24a5fa1f65a3824861354",
    "request_id": "80a599e031e749b7b260868f441e862b",
    "resource_id": "70a599e031e749b7b260868f441e862b"
}

1.20 - Show Cluster

1.20.1 - 1.1

get /v1/clusters/{cluster_id}

Description

show a cluster

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
200OKClusterShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

{
    "cluster": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "cloud_logging_enabled": "true",
        "cluster_namespace": "sample-cluster-12345",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kubernetes_version": "v1.29.8",
        "managed_security_group": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "max_node_count": "5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-cluster",
        "node_count": "5",
        "private_endpoint_access_control_resources": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name",
                "type": "vm"
            }
        ],
        "private_endpoint_url": "N",
        "private_kubeconfig_download_yn": "https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443",
        "public_endpoint_access_control_ip": "192.168.0.0",
        "public_endpoint_url": "https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443",
        "public_kubeconfig_download_yn": "N",
        "security_group_list": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name"
            }
        ],
        "service_watch_logging_enabled": "true",
        "status": "RUNNING",
        "subnet": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "volume": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "vpc": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        }
    }
}

1.20.2 - 1.0

get /v1/clusters/{cluster_id}

Description

show a cluster

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
200OKClusterShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

{
    "cluster": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "cloud_logging_enabled": "true",
        "cluster_namespace": "sample-cluster-12345",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kubernetes_version": "v1.29.8",
        "managed_security_group": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "max_node_count": "5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-cluster",
        "node_count": "5",
        "private_endpoint_access_control_resources": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name",
                "type": "vm"
            }
        ],
        "private_endpoint_url": "N",
        "private_kubeconfig_download_yn": "https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443",
        "public_endpoint_access_control_ip": "192.168.0.0",
        "public_endpoint_url": "https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443",
        "public_kubeconfig_download_yn": "N",
        "security_group_list": [
            {
                "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
                "name": "sample-name"
            }
        ],
        "status": "RUNNING",
        "subnet": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "volume": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        },
        "vpc": {
            "id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
            "name": "sample-name"
        }
    }
}

1.21 - Show Cluster User Kubeconfig

1.21.1 - 1.1

get /v1/clusters/{cluster_id}/user-kubeconfig

Description

Show user kubeconfig for the cluster

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querykubeconfig_type
required
Kubeconfig Type (private/public)
Example : private
enum (private, public)None

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/user-kubeconfig?kubeconfig_type={kubeconfig_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

1.21.2 - 1.0

get /v1/clusters/{cluster_id}/user-kubeconfig

Description

Show user kubeconfig for the cluster

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathcluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
stringNone
querykubeconfig_type
required
Kubeconfig Type (private/public)
Example : private
enum (private, public)None

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/clusters/{cluster_id}/user-kubeconfig?kubeconfig_type={kubeconfig_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

1.22 - Show Nodepool

1.22.1 - 1.1

get /v1/nodepools/{nodepool_id}

Description

show a nodepool

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone

Responses

HTTP CodeDescriptionSchema
200OKNodepoolShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.1"

Example HTTP response

Response 200

{
    "nodepool": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "advanced_settings": {
            "allowed_unsafe_sysctls": "kernel.msg*,net.ipv4.route.min_pmtu",
            "container_log_max_files": "5",
            "container_log_max_size": "10",
            "image_gc_high_threshold": "85",
            "image_gc_low_threshold": "80",
            "max_pods": "110",
            "pod_max_pids": "4096"
        },
        "auto_recovery_enabled": "true",
        "auto_scale_enabled": "true",
        "cluster": {
            "id": "70a599e031e749b7b260868f441e862b"
        },
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_node_count": "1",
        "desired_node_count": "2",
        "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
        "image": {
            "custom_image_name": "custom-image",
            "os": "ubuntu",
            "os_version": "22.04"
        },
        "keypair": {
            "name": "test_keypair"
        },
        "kubernetes_version": "v1.29.8",
        "labels": [
            {
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "max_node_count": "5",
        "min_node_count": "1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-nodepool",
        "server_group_id": "2b8d33d5-4de5-40a5-a34c-7e30204133xc",
        "server_type": {
            "description": "Standard",
            "id": "10a599e031e749b7b260868f441e862b"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "10a599e031e749b7b260868f441e862b",
            "name": "SSD"
        }
    }
}

1.22.2 - 1.0

get /v1/nodepools/{nodepool_id}

Description

show a nodepool

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnodepool_id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
stringNone

Responses

HTTP CodeDescriptionSchema
200OKNodepoolShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nodepools/{nodepool_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = ske 1.0"

Example HTTP response

Response 200

{
    "nodepool": {
        "account_id": "617b3d0e90c24a5fa1f65a3824861354",
        "auto_recovery_enabled": "true",
        "auto_scale_enabled": "true",
        "cluster": {
            "id": "70a599e031e749b7b260868f441e862b"
        },
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_node_count": "1",
        "desired_node_count": "2",
        "id": "bdfda539-bd2e-4a5c-9021-ec6d52d1ca79",
        "image": {
            "custom_image_name": "custom-image",
            "os": "ubuntu",
            "os_version": "22.04"
        },
        "keypair": {
            "name": "test_keypair"
        },
        "kubernetes_version": "v1.29.8",
        "labels": [
            {
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "max_node_count": "5",
        "min_node_count": "1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "sample-nodepool",
        "server_type": {
            "description": "Standard",
            "id": "10a599e031e749b7b260868f441e862b"
        },
        "status": "Running",
        "taints": [
            {
                "effect": "NoSchedule",
                "key": "example.com/my-app",
                "value": "bar"
            }
        ],
        "volume_size": "104",
        "volume_type": {
            "encrypt": "true",
            "id": "10a599e031e749b7b260868f441e862b",
            "name": "SSD"
        }
    }
}

2 - Models

2.1 - AsyncResponse

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : 617b3d0e90c24a5fa1f65a3824861354
string
request_id
required
Request ID
Example : 80a599e031e749b7b260868f441e862b
string
resource_id
required
Resource ID
Example : 70a599e031e749b7b260868f441e862b
string

2.2 - Cluster

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : 617b3d0e90c24a5fa1f65a3824861354
string
cloud_logging_enabled
required
Cloud Logging Enabled
Example : true
boolean
cluster_namespace
required
Cluster Namespace
Example : sample-cluster-12345
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
kubernetes_version
required
Cluster Version
Example : v1.29.8
string
managed_security_group
required
Managed Security Group
any of [ExternalResource, null]
max_node_count
required
Cluster Max Node Count
Example : 5
any of [integer, null]
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Cluster Name
Example : sample-cluster
string
node_count
required
Cluster Node Count
Example : 5
any of [integer, null]
private_endpoint_access_control_resources
required
Private Endpoint Access Control Resources
any of [array[PrivateEndpointAccessControlResource], null]
private_endpoint_url
required
Private Kubeconfig Download Yn
Example : N
string
private_kubeconfig_download_yn
required
Private Endpoint URL
Example : https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443
string
public_endpoint_access_control_ip
required
Public Endpoint Access Control IP
Example : 192.168.0.0
any of [string, null]
public_endpoint_url
required
Public Endpoint URL
Example : https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443
any of [string, null]
public_kubeconfig_download_yn
required
Public Kubeconfig Download Yn
Example : N
string
security_group_list
required
Connected Security Group List
array[ExternalResource]
status
required
Cluster Status
Example : RUNNING
string
subnet
required
Subnet of Cluster
any of [ExternalResource, null]
volume
required
Connected File Storage
any of [ExternalResource, null]
vpc
required
VPC of Cluster
any of [ExternalResource, null]

2.3 - ClusterCreateRequest

NameDescriptionSchemaDefault
cloud_logging_enabled
required
Cloud Logging Enabled
Example : true
boolean
kubernetes_version
required
Cluster Version
Example : v1.29.8
Pattern : ^v[0-9]{1}\.[0-9]{1,2}\.[0-9]{1,2}$
string
name
required
Cluster Name
Example : sample-cluster
Pattern : ^[a-z][a-z0-9\-]*[a-z0-9]$
Minimum length : 3
Maximum length : 30
string
private_endpoint_access_control_resources
optional
Private Endpoint Access Control Resources
any of [array[PrivateEndpointAccessControlResource], null]
public_endpoint_access_control_ip
optional
Public Endpoint Access Control IP
Example : 192.168.0.0
any of [string, null]
security_group_id_list
required
Security Group ID List
Example : ['bdfda539-bd2e-4a5c-9021-ec6d52d1ca79']
array[string]
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
tags
optional
Tag list
any of [array[Tag], null]
volume_id
required
Volume ID
Example : ['bfdbabf2-04d9-4e8b-a205-020f8e6da438']
string
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

2.4 - ClusterCreateRequestV1Dot1

NameDescriptionSchemaDefault
cloud_logging_enabled
required
Cloud Logging Enabled
Example : true
boolean
kubernetes_version
required
Cluster Version
Example : v1.29.8
Pattern : ^v[0-9]{1}\.[0-9]{1,2}\.[0-9]{1,2}$
string
name
required
Cluster Name
Example : sample-cluster
Pattern : ^[a-z][a-z0-9\-]*[a-z0-9]$
Minimum length : 3
Maximum length : 30
string
private_endpoint_access_control_resources
optional
Private Endpoint Access Control Resources
any of [array[PrivateEndpointAccessControlResource], null]
public_endpoint_access_control_ip
optional
Public Endpoint Access Control IP
Example : 192.168.0.0
any of [string, null]
security_group_id_list
required
Security Group ID List
Example : ['bdfda539-bd2e-4a5c-9021-ec6d52d1ca79']
array[string]
service_watch_logging_enabled
required
Service Watch Enabled
Example : true
boolean
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
tags
optional
Tag list
any of [array[Tag], null]
volume_id
required
Volume ID
Example : ['bfdbabf2-04d9-4e8b-a205-020f8e6da438']
string
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

2.5 - ClusterListResponse

NameDescriptionSchemaDefault
clusters
required

array[ClusterSummary]
count
optional
total count
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]

2.6 - ClusterLoggingSetRequest

NameDescriptionSchemaDefault
cloud_logging_enabled
required
Cloud Logging Enabled
Example : true
boolean

2.7 - ClusterOfNodepool

NameDescriptionSchemaDefault
id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
string

2.8 - ClusterPrivateAccessControlSetRequest

NameDescriptionSchemaDefault
private_endpoint_access_control_resources
required

array[PrivateEndpointAccessControlResource]

2.9 - ClusterPublicAccessControlSetRequest

NameDescriptionSchemaDefault
public_endpoint_access_control_ip
required
Public Endpoint Access Control IP
Example : 192.168.0.0
string

2.10 - ClusterSecurityGroupsSetRequest

NameDescriptionSchemaDefault
security_group_id_list
required
Security Group ID List
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
array[string]

2.11 - ClusterServiceWatchLoggingSetRequest

NameDescriptionSchemaDefault
service_watch_logging_enabled
required
Service Watch Enabled
Example : true
boolean

2.12 - ClusterSetResponse

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : 617b3d0e90c24a5fa1f65a3824861354
string
request_id
required
Request ID
Example : 80a599e031e749b7b260868f441e862b
string
resource_id
required
Resource ID
Example : 70a599e031e749b7b260868f441e862b
string

2.13 - ClusterShowResponse

NameDescriptionSchemaDefault
cluster
required

Cluster

2.14 - ClusterShowResponseV1Dot1

NameDescriptionSchemaDefault
cluster
required

ClusterV1Dot1

2.15 - ClusterSummary

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : 617b3d0e90c24a5fa1f65a3824861354
string
created_at
required
Created At
Example : 2025-03-31T00:23:17Z
string (date-time)
id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
string
kubernetes_version
required
Cluster Version
Example : v1.29.8
string
modified_at
required
Modified At
Example : 2025-03-31T00:23:17Z
string (date-time)
name
required
Cluster Name
Example : sample-cluster
string
node_count
required
Cluster Node Count
Example : 5
any of [integer, null]
status
required
Cluster Status
Example : RUNNING
string
subnet_id
required
Cluster Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]

2.16 - ClusterUpgradeSetRequest

NameDescriptionSchemaDefault
kubernetes_version
required
Kubernetes Version
Example : v1.29.8
string

2.17 - ClusterV1Dot1

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : 617b3d0e90c24a5fa1f65a3824861354
string
cloud_logging_enabled
required
Cloud Logging Enabled
Example : true
boolean
cluster_namespace
required
Cluster Namespace
Example : sample-cluster-12345
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
kubernetes_version
required
Cluster Version
Example : v1.29.8
string
managed_security_group
required
Managed Security Group
any of [ExternalResource, null]
max_node_count
required
Cluster Max Node Count
Example : 5
any of [integer, null]
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Cluster Name
Example : sample-cluster
string
node_count
required
Cluster Node Count
Example : 5
any of [integer, null]
private_endpoint_access_control_resources
required
Private Endpoint Access Control Resources
any of [array[PrivateEndpointAccessControlResource], null]
private_endpoint_url
required
Private Kubeconfig Download Yn
Example : N
string
private_kubeconfig_download_yn
required
Private Endpoint URL
Example : https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443
string
public_endpoint_access_control_ip
required
Public Endpoint Access Control IP
Example : 192.168.0.0
any of [string, null]
public_endpoint_url
required
Public Endpoint URL
Example : https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443
any of [string, null]
public_kubeconfig_download_yn
required
Public Kubeconfig Download Yn
Example : N
string
security_group_list
required
Connected Security Group List
array[ExternalResource]
service_watch_logging_enabled
required
Service Watch Enabled
Example : true
boolean
status
required
Cluster Status
Example : RUNNING
string
subnet
required
Subnet of Cluster
any of [ExternalResource, null]
volume
required
Connected File Storage
any of [ExternalResource, null]
vpc
required
VPC of Cluster
any of [ExternalResource, null]

2.18 - ExternalResource

NameDescriptionSchemaDefault
id
required
External Resource ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
string
name
required
External Resource name
Example : sample-name
string

2.19 - Image

NameDescriptionSchemaDefault
custom_image_name
required
Custom Image Name
Example : custom-image
any of [string, null]
os
required
Image OS
Example : ubuntu
string
os_version
required
Image OS Version
Example : 22.04
string

2.20 - Keypair

NameDescriptionSchemaDefault
name
required
Keypair Name
Example : test_keypair
string

2.21 - KubernetesVersionListResponse

NameDescriptionSchemaDefault
kubernetes_versions
required

array[KubernetesVersionSummary]

2.22 - KubernetesVersionSummary

NameDescriptionSchemaDefault
description
required
Kubernetes Version
Example : v1.29.8
any of [string, null]
kubernetes_version
required
Kubernetes Version
Example : v1.29.8
string

2.23 - NodeInNodepool

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : 617b3d0e90c24a5fa1f65a3824861354
string
kubernetes_version
required
Kubernetes Version
Example : v1.29.8
string
name
required
Node Name
Example : ske-aug-rhel-0805-1-84d799f767-8dr2p
string
status
required
Node Status
Example : RUNNING
string

2.24 - NodeListInNodepoolResponse

NameDescriptionSchemaDefault
count
optional
total count
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
nodes
required
Node List in Node Pool
any of [array[NodeInNodepool], null]

2.25 - Nodepool

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : 617b3d0e90c24a5fa1f65a3824861354
string
auto_recovery_enabled
required
Is Auto Recovery
Example : true
boolean
auto_scale_enabled
required
Is Auto Scale
Example : true
boolean
cluster
required
Cluster
ClusterOfNodepool
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
current_node_count
required
Current Node Count
Example : 1
integer
desired_node_count
required
Desired Node Count
Example : 2
integer
id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
string
image
required
Image
Image
keypair
required
Keypair Name
Keypair
kubernetes_version
required
Kubernetes Version
Example : v1.29.8
string
labels
optional
Node Pool Labels
any of [array[NodepoolLabel], null]
max_node_count
required
Max Node Count
Example : 5
integer
min_node_count
required
Min Node Count
Example : 1
integer
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Nodepool Name
Example : sample-nodepool
string
server_type
required
Server Type
ServerType
status
required
Node Pool Status
Example : Running
string
taints
optional
Node Pool Taints
any of [array[NodepoolTaint], null]
volume_size
required
Volume Size
Example : 104
integer
volume_type
required
Volume Type
VolumeType

2.26 - NodepoolAdvancedSettings

NameDescriptionSchemaDefault
allowed_unsafe_sysctls
optional
Node Pool Allowed unsafe sysctls
Example : kernel.msg*,net.ipv4.route.min_pmtu
string
container_log_max_files
required
Node Pool container log max files
Example : 5
Minimum : 2
Maximum : 10
integer
container_log_max_size
required
Node Pool container log max size
Example : 10
Minimum : 10
Maximum : 100
integer
image_gc_high_threshold
required
Node Pool image GC high threshold percent
Example : 85
Minimum : 10
Maximum : 85
integer
image_gc_low_threshold
required
Node Pool image GC low threshold percent
Example : 80
Minimum : 10
Maximum : 85
integer
max_pods
required
Node Pool max pod number
Example : 110
Minimum : 10
Maximum : 250
integer
pod_max_pids
required
Node Pool Pod Max pids constraint
Example : 4096
Minimum : 1024
Maximum : 4194304
integer

2.27 - NodepoolCreateRequest

NameDescriptionSchemaDefault
cluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
string
custom_image_id
optional
Custom Image ID
Example : 10a599e031e749b7b260868f441e862b
any of [string, null]
desired_node_count
optional
Desired node count (is_auto_scale = false)
Example : 2
any of [integer, null]
image_os
required
Image OS
Example : ubuntu
string
image_os_version
required
Image OS Version
Example : 22.04
string
is_auto_recovery
required
Is Auto Recovery
Example : true
boolean
is_auto_scale
required
Is Auto Scale
Example : true
boolean
keypair_name
required
Keypair Name
Example : test_keypair
string
kubernetes_version
required
Kubernetes Version
Example : v1.29.8
string
labels
optional
Node Pool Labels
any of [array[NodepoolLabel], null]
max_node_count
optional
Maximum node count (is_auto_scale = true)
Example : 5
any of [integer, null]
min_node_count
optional
Minimum node count (is_auto_scale = true)
Example : 1
any of [integer, null]
name
required
Nodepool Name
Example : sample-nodepool
Pattern : ^[a-z][a-z0-9\-]*[a-z0-9]$
Minimum length : 3
Maximum length : 20
string
server_type_id
required
Server Type ID
Example : 10a599e031e749b7b260868f441e862b
string
taints
optional
Node Pool Taints
any of [array[NodepoolTaint], null]
volume_size
required
Volume Size
Example : 104
integer
volume_type_name
required
Volume Type Name
Example : SSD
string

2.28 - NodepoolCreateRequestV1Dot1

NameDescriptionSchemaDefault
advanced_settings
optional
Node Pool Advanced Settings
any of [NodepoolAdvancedSettings, null]
cluster_id
required
Cluster ID
Example : 70a599e031e749b7b260868f441e862b
string
custom_image_id
optional
Custom Image ID
Example : 10a599e031e749b7b260868f441e862b
any of [string, null]
desired_node_count
optional
Desired node count (is_auto_scale = false)
Example : 2
any of [integer, null]
image_os
required
Image OS
Example : ubuntu
string
image_os_version
required
Image OS Version
Example : 22.04
string
is_auto_recovery
required
Is Auto Recovery
Example : true
boolean
is_auto_scale
required
Is Auto Scale
Example : true
boolean
keypair_name
required
Keypair Name
Example : test_keypair
string
kubernetes_version
required
Kubernetes Version
Example : v1.29.8
string
labels
optional
Node Pool Labels
any of [array[NodepoolLabel], null]
max_node_count
optional
Maximum node count (is_auto_scale = true)
Example : 5
any of [integer, null]
min_node_count
optional
Minimum node count (is_auto_scale = true)
Example : 1
any of [integer, null]
name
required
Nodepool Name
Example : sample-nodepool
Pattern : ^[a-z][a-z0-9\-]*[a-z0-9]$
Minimum length : 3
Maximum length : 20
string
server_group_id
optional
Server Group ID
Example : 2b8d33d5-4de5-40a5-a34c-7e30204133xc
any of [string, null]
server_type_id
required
Server Type ID
Example : 10a599e031e749b7b260868f441e862b
string
taints
optional
Node Pool Taints
any of [array[NodepoolTaint], null]
volume_size
required
Volume Size
Example : 104
integer
volume_type_name
required
Volume Type Name
Example : SSD
string

2.29 - NodepoolLabel

NameDescriptionSchemaDefault
key
required
Node Pool Label Key
Example : example.com/my-app
Pattern : ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]$
string
value
optional
Node Pool Label Value
Example : bar
Pattern : ^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$
Maximum length : 63
string

2.30 - NodepoolLabelsSetRequest

NameDescriptionSchemaDefault
labels
required

array[NodepoolLabel]

2.31 - NodepoolListResponse

NameDescriptionSchemaDefault
count
optional
total count
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
nodepools
required
Node Pool List
array[NodepoolSummary]

2.32 - NodepoolShowResponse

NameDescriptionSchemaDefault
nodepool
required

Nodepool

2.33 - NodepoolShowResponseV1Dot1

NameDescriptionSchemaDefault
nodepool
required

NodepoolV1Dot1

2.34 - NodepoolSummary

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : 617b3d0e90c24a5fa1f65a3824861354
string
auto_recovery_enabled
required
Is Auto Recovery
Example :
boolean
auto_scale_enabled
required
Is Auto Scale
Example :
boolean
current_node_count
required
Current Node Count
Example : 1
integer
desired_node_count
required
Desired Node Count
Example : 2
integer
id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
string
image
required
Image
Image
kubernetes_version
required
Kubernetes Version
Example : v1.29.8
string
name
required
Nodepool Name
Example : sample-nodepool
string
server_type
required
Server Type
ServerType
status
required
Node Pool Status
Example : Running
string
volume_type
required
Volume Type
VolumeTypeSummary

2.35 - NodepoolTaint

NameDescriptionSchemaDefault
effect
required
Node Pool Taint Effect
Example : NoSchedule
enum (NoSchedule, NoExecute, PreferNoSchedule)
key
required
Node Pool Taint Key
Example : example.com/my-app
Pattern : ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]$
string
value
optional
Node Pool Taint Value
Example : bar
Pattern : ^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$
Maximum length : 63
string

2.36 - NodepoolTaintsSetRequest

NameDescriptionSchemaDefault
taints
required

array[NodepoolTaint]

2.37 - NodepoolUpdateRequest

NameDescriptionSchemaDefault
desired_node_count
optional
Desired Node Count
Example : 2
any of [integer, null]
is_auto_recovery
optional
Is Auto Recovery
Example : true
any of [boolean, null]
is_auto_scale
optional
Is Auto Scale
Example : true
any of [boolean, null]
max_node_count
optional
Max Node Count
Example : 5
any of [integer, null]
min_node_count
optional
Min Node Count
Example : 1
any of [integer, null]

2.38 - NodepoolUpgradeSetRequest

NameDescriptionSchemaDefault
os_version
required
Image OS Version
Example : 22.04
string

2.39 - NodepoolV1Dot1

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : 617b3d0e90c24a5fa1f65a3824861354
string
advanced_settings
optional
Node Pool Advanced Settings
any of [NodepoolAdvancedSettings, null]
auto_recovery_enabled
required
Is Auto Recovery
Example : true
boolean
auto_scale_enabled
required
Is Auto Scale
Example : true
boolean
cluster
required
Cluster
ClusterOfNodepool
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
current_node_count
required
Current Node Count
Example : 1
integer
desired_node_count
required
Desired Node Count
Example : 2
integer
id
required
Nodepool ID
Example : bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
string
image
required
Image
Image
keypair
required
Keypair Name
Keypair
kubernetes_version
required
Kubernetes Version
Example : v1.29.8
string
labels
optional
Node Pool Labels
any of [array[NodepoolLabel], null]
max_node_count
required
Max Node Count
Example : 5
integer
min_node_count
required
Min Node Count
Example : 1
integer
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Nodepool Name
Example : sample-nodepool
string
server_group_id
optional
Server Group ID
Example : 2b8d33d5-4de5-40a5-a34c-7e30204133xc
any of [string, null]
server_type
required
Server Type
ServerType
status
required
Node Pool Status
Example : Running
string
taints
optional
Node Pool Taints
any of [array[NodepoolTaint], null]
volume_size
required
Volume Size
Example : 104
integer
volume_type
required
Volume Type
VolumeType

2.40 - PrivateEndpointAccessControlResource

NameDescriptionSchemaDefault
id
required
Private Endpoint Access Control Resource ID
Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f
string
name
required
Private Endpoint Access Control Resource Name
Example : sample-name
string
type
required
Private Endpoint Access Control Resource Type
Example : vm
string

2.41 - ServerType

NameDescriptionSchemaDefault
description
required
Server Type Description
Example : Standard
string
id
required
Server Type ID
Example : 10a599e031e749b7b260868f441e862b
string

2.42 - Tag

NameDescriptionSchemaDefault
key
required
Tag Key
Example : Key
string
value
required
Tag Value
Example : Value
string

2.43 - VolumeType

NameDescriptionSchemaDefault
encrypt
required
Volume Type Encrypt
Example : true
boolean
id
required
Volume Type ID
Example : 10a599e031e749b7b260868f441e862b
string
name
required
Volume Type Name
Example : SSD
string

2.44 - VolumeTypeSummary

NameDescriptionSchemaDefault
id
required
Volume Type ID
Example : 10a599e031e749b7b260868f441e862b
string
name
required
Volume Type Name
Example : SSD
string