Kubernetes
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Kubernetes service and how to call CLI.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|
| 1.2 | CURRENT | - |
| 1.1 | SUPPORTED | 20260919 |
| 1.0 | DEPRECATED | 20251231 |
1 - CLIs
1.1 - Create Cluster
1.1.1 - 1.2
scpcli ske cluster create
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--service_watch_logging_enabled <value>
--security_group_id_list <value>
--name <value>
--kubernetes_version <value>
--cloud_logging_enabled <value>
[--private_endpoint_access_control_resources <value>]
[--public_endpoint_access_control_ip <value>]
[--tags <value>]
Description
create a cluster
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
vpc_id required | string | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
volume_id required | string | Volume ID | ['bfdbabf2-04d9-4e8b-a205-020f8e6da438'] |
subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
service_watch_logging_enabled required | boolean | Service Watch Logging Enabled | true |
security_group_id_list required | array | Security Group ID List | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
name required | string | Cluster Name | sample-cluster |
kubernetes_version required | string | Cluster Version | v1.29.8 |
cloud_logging_enabled required | boolean | Cloud Logging Enabled | true |
private_endpoint_access_control_resources optional | array | Private Endpoint Access Control Resources | '{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}' |
public_endpoint_access_control_ip optional | string | Public Endpoint Access Control IP | 192.168.0.0 |
tags optional | array | Tag list | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| request_id | Request ID | 80a599e031e749b7b260868f441e862b |
| resource_id | Resource ID | 70a599e031e749b7b260868f441e862b |
1.1.2 - 1.1
scpcli ske cluster create
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--service_watch_logging_enabled <value>
--security_group_id_list <value>
--name <value>
--kubernetes_version <value>
--cloud_logging_enabled <value>
[--private_endpoint_access_control_resources <value>]
[--public_endpoint_access_control_ip <value>]
[--tags <value>]
Description
create a cluster
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
vpc_id required | string | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
volume_id required | string | Volume ID | ['bfdbabf2-04d9-4e8b-a205-020f8e6da438'] |
subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
service_watch_logging_enabled required | boolean | Service Watch Logging Enabled | true |
security_group_id_list required | array | Security Group ID List | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
name required | string | Cluster Name | sample-cluster |
kubernetes_version required | string | Cluster Version | v1.29.8 |
cloud_logging_enabled required | boolean | Cloud Logging Enabled | true |
private_endpoint_access_control_resources optional | array | Private Endpoint Access Control Resources | '{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}' |
public_endpoint_access_control_ip optional | string | Public Endpoint Access Control IP | 192.168.0.0 |
tags optional | array | Tag list | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| request_id | Request ID | 80a599e031e749b7b260868f441e862b |
| resource_id | Resource ID | 70a599e031e749b7b260868f441e862b |
1.1.3 - 1.0
scpcli ske cluster create
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--name <value>
--kubernetes_version <value>
--cloud_logging_enabled <value>
[--private_endpoint_access_control_resources <value>]
[--public_endpoint_access_control_ip <value>]
[--tags <value>]
Description
create a cluster V1.0
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
vpc_id required | string | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
volume_id required | string | Volume ID | ['bfdbabf2-04d9-4e8b-a205-020f8e6da438'] |
subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
security_group_id_list required | array | Security Group ID List | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
name required | string | Cluster Name | sample-cluster |
kubernetes_version required | string | Cluster Version | v1.29.8 |
cloud_logging_enabled required | boolean | Cloud Logging Enabled | true |
private_endpoint_access_control_resources optional | array | Private Endpoint Access Control Resources | '{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}' |
public_endpoint_access_control_ip optional | string | Public Endpoint Access Control IP | 192.168.0.0 |
tags optional | array | Tag list | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| request_id | Request ID | 80a599e031e749b7b260868f441e862b |
| resource_id | Resource ID | 70a599e031e749b7b260868f441e862b |
1.2 - Create Cluster Kubeconfig
1.2.1 - 1.2
scpcli ske cluster kubeconfig create
--cluster_id <value>
--kubeconfig_type <value>
Description
Create kubeconfig file for the cluster
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
kubeconfig_type required | **** | Kubeconfig Type (private/public) | private |
Responses
1.2.2 - 1.1
scpcli ske cluster kubeconfig create
--cluster_id <value>
--kubeconfig_type <value>
Description
Create kubeconfig file for the cluster
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
kubeconfig_type required | **** | Kubeconfig Type (private/public) | private |
Responses
1.2.3 - 1.0
scpcli ske cluster kubeconfig create
--cluster_id <value>
--kubeconfig_type <value>
Description
Create kubeconfig file for the cluster
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
kubeconfig_type required | **** | Kubeconfig Type (private/public) | private |
Responses
1.3 - Create Nodepool
1.3.1 - 1.2
scpcli ske nodepool create
--pod_max_pids <value>
--max_pods <value>
--image_gc_low_threshold <value>
--image_gc_high_threshold <value>
--container_log_max_size <value>
--container_log_max_files <value>
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--kubernetes_version <value>
--keypair_name <value>
--is_auto_scale <value>
--is_auto_recovery <value>
--image_os_version <value>
--image_os <value>
--cluster_id <value>
[--custom_image_id <value>]
[--desired_node_count <value>]
[--labels <value>]
[--max_node_count <value>]
[--min_node_count <value>]
[--server_group_id <value>]
[--taints <value>]
[--allowed_unsafe_sysctls <value>]
Description
create a nodepool
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
pod_max_pids required | integer | Pod Max PID Limit | 4096 |
max_pods required | integer | Max Pods Per Node | 110 |
image_gc_low_threshold required | integer | Image GC Low Threshold Percent | 80 |
image_gc_high_threshold required | integer | Image GC High Threshold Percent | 85 |
container_log_max_size required | integer | Max Size Of Container Log (MB) | 10 |
container_log_max_files required | integer | Max Number Of Container Log Files | 5 |
volume_type_name required | string | Volume Type Name | SSD |
volume_size required | integer | Volume Size | 104 |
server_type_id required | string | Server Type ID | 10a599e031e749b7b260868f441e862b |
name required | string | Nodepool Name | sample-nodepool |
kubernetes_version required | string | Kubernetes Version | v1.29.8 |
keypair_name required | string | Keypair Name | test_keypair |
is_auto_scale required | boolean | Is Auto Scale | true |
is_auto_recovery required | boolean | Is Auto Recovery | true |
image_os_version required | string | Image OS Version | 22.04 |
image_os required | string | Image OS | ubuntu |
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
custom_image_id optional | string | Custom Image ID | 10a599e031e749b7b260868f441e862b |
desired_node_count optional | integer | Desired node count (is_auto_scale = false) | 2 |
labels optional | array | Labels | '{"key": "example.com/my-app", "value": "bar"}' |
max_node_count optional | integer | Maximum node count (is_auto_scale = true) | 5 |
min_node_count optional | integer | Minimum node count (is_auto_scale = true) | 1 |
server_group_id optional | string | Server Group ID | 2b8d33d5-4de5-40a5-a34c-7e30204133xc |
taints optional | array | Taints | '{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}' |
allowed_unsafe_sysctls optional | string | Allowed Unsafe sysctls | kernel.msg*,net.ipv4.route.min_pmtu |
Responses
| Name | Description | Example |
|---|
| id | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| advanced_settings | Advanced Settings | |
| auto_recovery_enabled | Is Auto Recovery | true |
| auto_scale_enabled | Is Auto Scale | true |
| cluster | Cluster | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_node_count | Current Node Count | 1 |
| desired_node_count | Desired Node Count | 2 |
| image | Image | |
| keypair | Keypair Name | |
| kubernetes_version | Kubernetes Version | v1.29.8 |
| labels | Labels | |
| max_node_count | Max Node Count | 5 |
| min_node_count | Min Node Count | 1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Nodepool Name | sample-nodepool |
| server_group_id | Server Group ID | 2b8d33d5-4de5-40a5-a34c-7e30204133xc |
| server_type | Server Type | |
| status | Node Pool Status | Running |
| taints | Taints | |
| volume_size | Volume Size | 104 |
| volume_type | Volume Type | |
1.3.2 - 1.1
scpcli ske nodepool create
--pod_max_pids <value>
--max_pods <value>
--image_gc_low_threshold <value>
--image_gc_high_threshold <value>
--container_log_max_size <value>
--container_log_max_files <value>
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--kubernetes_version <value>
--keypair_name <value>
--is_auto_scale <value>
--is_auto_recovery <value>
--image_os_version <value>
--image_os <value>
--cluster_id <value>
[--custom_image_id <value>]
[--desired_node_count <value>]
[--labels <value>]
[--max_node_count <value>]
[--min_node_count <value>]
[--server_group_id <value>]
[--taints <value>]
[--allowed_unsafe_sysctls <value>]
Description
create a nodepool
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
pod_max_pids required | integer | Pod Max PID Limit | 4096 |
max_pods required | integer | Max Pods Per Node | 110 |
image_gc_low_threshold required | integer | Image GC Low Threshold Percent | 80 |
image_gc_high_threshold required | integer | Image GC High Threshold Percent | 85 |
container_log_max_size required | integer | Max Size Of Container Log (MB) | 10 |
container_log_max_files required | integer | Max Number Of Container Log Files | 5 |
volume_type_name required | string | Volume Type Name | SSD |
volume_size required | integer | Volume Size | 104 |
server_type_id required | string | Server Type ID | 10a599e031e749b7b260868f441e862b |
name required | string | Nodepool Name | sample-nodepool |
kubernetes_version required | string | Kubernetes Version | v1.29.8 |
keypair_name required | string | Keypair Name | test_keypair |
is_auto_scale required | boolean | Is Auto Scale | true |
is_auto_recovery required | boolean | Is Auto Recovery | true |
image_os_version required | string | Image OS Version | 22.04 |
image_os required | string | Image OS | ubuntu |
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
custom_image_id optional | string | Custom Image ID | 10a599e031e749b7b260868f441e862b |
desired_node_count optional | integer | Desired node count (is_auto_scale = false) | 2 |
labels optional | array | Labels | '{"key": "example.com/my-app", "value": "bar"}' |
max_node_count optional | integer | Maximum node count (is_auto_scale = true) | 5 |
min_node_count optional | integer | Minimum node count (is_auto_scale = true) | 1 |
server_group_id optional | string | Server Group ID | 2b8d33d5-4de5-40a5-a34c-7e30204133xc |
taints optional | array | Taints | '{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}' |
allowed_unsafe_sysctls optional | string | Allowed Unsafe sysctls | kernel.msg*,net.ipv4.route.min_pmtu |
Responses
| Name | Description | Example |
|---|
| id | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| advanced_settings | Advanced Settings | |
| auto_recovery_enabled | Is Auto Recovery | true |
| auto_scale_enabled | Is Auto Scale | true |
| cluster | Cluster | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_node_count | Current Node Count | 1 |
| desired_node_count | Desired Node Count | 2 |
| image | Image | |
| keypair | Keypair Name | |
| kubernetes_version | Kubernetes Version | v1.29.8 |
| labels | Labels | |
| max_node_count | Max Node Count | 5 |
| min_node_count | Min Node Count | 1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Nodepool Name | sample-nodepool |
| server_group_id | Server Group ID | 2b8d33d5-4de5-40a5-a34c-7e30204133xc |
| server_type | Server Type | |
| status | Node Pool Status | Running |
| taints | Taints | |
| volume_size | Volume Size | 104 |
| volume_type | Volume Type | |
1.3.3 - 1.0
scpcli ske nodepool create
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--kubernetes_version <value>
--keypair_name <value>
--is_auto_scale <value>
--is_auto_recovery <value>
--image_os_version <value>
--image_os <value>
--cluster_id <value>
[--custom_image_id <value>]
[--desired_node_count <value>]
[--labels <value>]
[--max_node_count <value>]
[--min_node_count <value>]
[--taints <value>]
Description
create a nodepool v1.0
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
volume_type_name required | string | Volume Type Name | SSD |
volume_size required | integer | Volume Size | 104 |
server_type_id required | string | Server Type ID | 10a599e031e749b7b260868f441e862b |
name required | string | Nodepool Name | sample-nodepool |
kubernetes_version required | string | Kubernetes Version | v1.29.8 |
keypair_name required | string | Keypair Name | test_keypair |
is_auto_scale required | boolean | Is Auto Scale | true |
is_auto_recovery required | boolean | Is Auto Recovery | true |
image_os_version required | string | Image OS Version | 22.04 |
image_os required | string | Image OS | ubuntu |
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
custom_image_id optional | string | Custom Image ID | 10a599e031e749b7b260868f441e862b |
desired_node_count optional | integer | Desired node count (is_auto_scale = false) | 2 |
labels optional | array | Labels | '{"key": "example.com/my-app", "value": "bar"}' |
max_node_count optional | integer | Maximum node count (is_auto_scale = true) | 5 |
min_node_count optional | integer | Minimum node count (is_auto_scale = true) | 1 |
taints optional | array | Taints | '{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}' |
Responses
| Name | Description | Example |
|---|
| id | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| auto_recovery_enabled | Is Auto Recovery | true |
| auto_scale_enabled | Is Auto Scale | true |
| cluster | Cluster | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_node_count | Current Node Count | 1 |
| desired_node_count | Desired Node Count | 2 |
| image | Image | |
| keypair | Keypair Name | |
| kubernetes_version | Kubernetes Version | v1.29.8 |
| labels | Labels | |
| max_node_count | Max Node Count | 5 |
| min_node_count | Min Node Count | 1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Nodepool Name | sample-nodepool |
| server_type | Server Type | |
| status | Node Pool Status | Running |
| taints | Taints | |
| volume_size | Volume Size | 104 |
| volume_type | Volume Type | |
1.4 - Delete Cluster
1.4.1 - 1.2
scpcli ske cluster delete
--cluster_id <value>
Description
delete a specific cluster
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
1.4.2 - 1.1
scpcli ske cluster delete
--cluster_id <value>
Description
delete a specific cluster
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
1.4.3 - 1.0
scpcli ske cluster delete
--cluster_id <value>
Description
delete a specific cluster
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
1.5 - Delete Nodepool
1.5.1 - 1.2
scpcli ske nodepool delete
--nodepool_id <value>
Description
delete a nodepool
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
1.5.2 - 1.1
scpcli ske nodepool delete
--nodepool_id <value>
Description
delete a nodepool
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
1.5.3 - 1.0
scpcli ske nodepool delete
--nodepool_id <value>
Description
delete a nodepool
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
1.6 - List Clusters
1.6.1 - 1.2
scpcli ske cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--status <value>]
[--kubernetes_version <value>]
[--subnet_id <value>]
Description
get clusters list
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
name optional | string | Cluster Name | sample-cluster |
status optional | array | Cluster Status | R |
kubernetes_version optional | array | Cluster Version | v |
subnet_id optional | string | Cluster Subnet ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|
| id | Cluster ID | 70a599e031e749b7b260868f441e862b |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| created_at | Created At | 2025-03-31T00:23:17Z |
| kubernetes_version | Cluster Version | v1.29.8 |
| modified_at | Modified At | 2025-03-31T00:23:17Z |
| name | Cluster Name | sample-cluster |
| node_count | Cluster Node Count | 5 |
| status | Cluster Status | RUNNING |
| subnet_id | Cluster Subnet ID | 023c57b14f11483689338d085e061492 |
1.6.2 - 1.1
scpcli ske cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--status <value>]
[--kubernetes_version <value>]
[--subnet_id <value>]
Description
get clusters list
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
name optional | string | Cluster Name | sample-cluster |
status optional | array | Cluster Status | R |
kubernetes_version optional | array | Cluster Version | v |
subnet_id optional | string | Cluster Subnet ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|
| id | Cluster ID | 70a599e031e749b7b260868f441e862b |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| created_at | Created At | 2025-03-31T00:23:17Z |
| kubernetes_version | Cluster Version | v1.29.8 |
| modified_at | Modified At | 2025-03-31T00:23:17Z |
| name | Cluster Name | sample-cluster |
| node_count | Cluster Node Count | 5 |
| status | Cluster Status | RUNNING |
| subnet_id | Cluster Subnet ID | 023c57b14f11483689338d085e061492 |
1.6.3 - 1.0
scpcli ske cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--status <value>]
[--kubernetes_version <value>]
[--subnet_id <value>]
Description
get clusters list
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
name optional | string | Cluster Name | sample-cluster |
status optional | array | Cluster Status | R |
kubernetes_version optional | array | Cluster Version | v |
subnet_id optional | string | Cluster Subnet ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|
| id | Cluster ID | 70a599e031e749b7b260868f441e862b |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| created_at | Created At | 2025-03-31T00:23:17Z |
| kubernetes_version | Cluster Version | v1.29.8 |
| modified_at | Modified At | 2025-03-31T00:23:17Z |
| name | Cluster Name | sample-cluster |
| node_count | Cluster Node Count | 5 |
| status | Cluster Status | RUNNING |
| subnet_id | Cluster Subnet ID | 023c57b14f11483689338d085e061492 |
1.7 - List Nodepool Nodes
1.7.1 - 1.2
scpcli ske nodepool node list
--nodepool_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--node_name <value>]
Description
Get nodepool node list
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
node_name optional | string | Node Name | ske-aug-rhel-0805-1-84d799f767-8dr2p |
Responses
| Name | Description | Example |
|---|
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| kubernetes_version | Kubernetes Version | v1.29.8 |
| name | Node Name | ske-aug-rhel-0805-1-84d799f767-8dr2p |
| status | Node Status | RUNNING |
1.7.2 - 1.1
scpcli ske nodepool node list
--nodepool_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--node_name <value>]
Description
Get nodepool node list
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
node_name optional | string | Node Name | ske-aug-rhel-0805-1-84d799f767-8dr2p |
Responses
| Name | Description | Example |
|---|
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| kubernetes_version | Kubernetes Version | v1.29.8 |
| name | Node Name | ske-aug-rhel-0805-1-84d799f767-8dr2p |
| status | Node Status | RUNNING |
1.7.3 - 1.0
scpcli ske nodepool node list
--nodepool_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--node_name <value>]
Description
Get nodepool node list
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
node_name optional | string | Node Name | ske-aug-rhel-0805-1-84d799f767-8dr2p |
Responses
| Name | Description | Example |
|---|
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| kubernetes_version | Kubernetes Version | v1.29.8 |
| name | Node Name | ske-aug-rhel-0805-1-84d799f767-8dr2p |
| status | Node Status | RUNNING |
1.8 - List Nodepools
1.8.1 - 1.2
scpcli ske nodepool list
--cluster_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--nodepool_name <value>]
Description
get nodepools list
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
nodepool_name optional | string | Nodepool Name | sample-nodepool |
Responses
| Name | Description | Example |
|---|
| id | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| auto_recovery_enabled | Is Auto Recovery | |
| auto_scale_enabled | Is Auto Scale | |
| current_node_count | Current Node Count | 1 |
| desired_node_count | Desired Node Count | 2 |
| image | Image | |
| kubernetes_version | Kubernetes Version | v1.29.8 |
| name | Nodepool Name | sample-nodepool |
| server_type | Server Type | |
| status | Node Pool Status | Running |
| volume_type | Volume Type | |
1.8.2 - 1.1
scpcli ske nodepool list
--cluster_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--nodepool_name <value>]
Description
get nodepools list
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
nodepool_name optional | string | Nodepool Name | sample-nodepool |
Responses
| Name | Description | Example |
|---|
| id | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| auto_recovery_enabled | Is Auto Recovery | |
| auto_scale_enabled | Is Auto Scale | |
| current_node_count | Current Node Count | 1 |
| desired_node_count | Desired Node Count | 2 |
| image | Image | |
| kubernetes_version | Kubernetes Version | v1.29.8 |
| name | Nodepool Name | sample-nodepool |
| server_type | Server Type | |
| status | Node Pool Status | Running |
| volume_type | Volume Type | |
1.8.3 - 1.0
scpcli ske nodepool list
--cluster_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--nodepool_name <value>]
Description
get nodepools list
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
nodepool_name optional | string | Nodepool Name | sample-nodepool |
Responses
| Name | Description | Example |
|---|
| id | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| auto_recovery_enabled | Is Auto Recovery | |
| auto_scale_enabled | Is Auto Scale | |
| current_node_count | Current Node Count | 1 |
| desired_node_count | Desired Node Count | 2 |
| image | Image | |
| kubernetes_version | Kubernetes Version | v1.29.8 |
| name | Nodepool Name | sample-nodepool |
| server_type | Server Type | |
| status | Node Pool Status | Running |
| volume_type | Volume Type | |
1.9 - Set Cluster Logging
1.9.1 - 1.2
scpcli ske cluster logging set
--cluster_id <value>
--cloud_logging_enabled <value>
Description
Set logging on the cluster
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
cloud_logging_enabled required | boolean | Cloud Logging Enabled | true |
1.9.2 - 1.1
scpcli ske cluster logging set
--cluster_id <value>
--cloud_logging_enabled <value>
Description
Set logging on the cluster
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
cloud_logging_enabled required | boolean | Cloud Logging Enabled | true |
1.9.3 - 1.0
scpcli ske cluster logging set
--cluster_id <value>
--cloud_logging_enabled <value>
Description
Set logging on the cluster
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
cloud_logging_enabled required | boolean | Cloud Logging Enabled | true |
1.10 - Set Cluster Private Access Control
1.10.1 - 1.2
scpcli ske cluster private access control set
--cluster_id <value>
--private_endpoint_access_control_resources <value>
Description
set a private access control specific cluster
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
private_endpoint_access_control_resources required | array | | '{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}' |
1.10.2 - 1.1
scpcli ske cluster private access control set
--cluster_id <value>
--private_endpoint_access_control_resources <value>
Description
set a private access control specific cluster
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
private_endpoint_access_control_resources required | array | | '{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}' |
1.10.3 - 1.0
scpcli ske cluster private access control set
--cluster_id <value>
--private_endpoint_access_control_resources <value>
Description
set a private access control specific cluster
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
private_endpoint_access_control_resources required | array | | '{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}' |
1.11 - Set Cluster Public Access Control
1.11.1 - 1.2
scpcli ske cluster public access control set
--cluster_id <value>
--public_endpoint_access_control_ip <value>
Description
set a public access control specific cluster
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
public_endpoint_access_control_ip required | string | Public Endpoint Access Control IP | 192.168.0.0 |
1.11.2 - 1.1
scpcli ske cluster public access control set
--cluster_id <value>
--public_endpoint_access_control_ip <value>
Description
set a public access control specific cluster
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
public_endpoint_access_control_ip required | string | Public Endpoint Access Control IP | 192.168.0.0 |
1.11.3 - 1.0
scpcli ske cluster public access control set
--cluster_id <value>
--public_endpoint_access_control_ip <value>
Description
set a public access control specific cluster
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
public_endpoint_access_control_ip required | string | Public Endpoint Access Control IP | 192.168.0.0 |
1.12 - Set Cluster Security Groups
1.12.1 - 1.2
scpcli ske cluster security group set
--cluster_id <value>
--security_group_id_list <value>
Description
Set Cluster Security Groups
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
security_group_id_list required | array | Security Group ID List | b |
1.12.2 - 1.1
scpcli ske cluster security group set
--cluster_id <value>
--security_group_id_list <value>
Description
Set Cluster Security Groups
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
security_group_id_list required | array | Security Group ID List | b |
1.12.3 - 1.0
scpcli ske cluster security group set
--cluster_id <value>
--security_group_id_list <value>
Description
Set Cluster Security Groups
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
security_group_id_list required | array | Security Group ID List | b |
1.13 - Set Cluster Service Watch Logging
1.13.1 - 1.2
scpcli ske cluster service watch logging set
--cluster_id <value>
--service_watch_logging_enabled <value>
Description
Set Service Watch logging on the cluster
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
service_watch_logging_enabled required | boolean | Service Watch Logging Enabled | true |
1.13.2 - 1.1
scpcli ske cluster service watch logging set
--cluster_id <value>
--service_watch_logging_enabled <value>
Description
Set Service Watch logging on the cluster
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
service_watch_logging_enabled required | boolean | Service Watch Logging Enabled | true |
1.14 - Set Cluster Upgrade
1.14.1 - 1.2
scpcli ske cluster upgrade set
--cluster_id <value>
--kubernetes_version <value>
Description
upgrade a specific cluster
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
kubernetes_version required | string | Kubernetes Version | v1.29.8 |
1.14.2 - 1.1
scpcli ske cluster upgrade set
--cluster_id <value>
--kubernetes_version <value>
Description
upgrade a specific cluster
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
kubernetes_version required | string | Kubernetes Version | v1.29.8 |
1.14.3 - 1.0
scpcli ske cluster upgrade set
--cluster_id <value>
--kubernetes_version <value>
Description
upgrade a specific cluster
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
kubernetes_version required | string | Kubernetes Version | v1.29.8 |
1.15 - Set Nodepool
1.15.1 - 1.2
scpcli ske nodepool set
--nodepool_id <value>
[--desired_node_count <value>]
[--is_auto_recovery <value>]
[--is_auto_scale <value>]
[--max_node_count <value>]
[--min_node_count <value>]
Description
set a nodepool
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
desired_node_count optional | integer | Desired Node Count | 2 |
is_auto_recovery optional | boolean | Is Auto Recovery | true |
is_auto_scale optional | boolean | Is Auto Scale | true |
max_node_count optional | integer | Max Node Count | 5 |
min_node_count optional | integer | Min Node Count | 1 |
1.15.2 - 1.1
scpcli ske nodepool set
--nodepool_id <value>
[--desired_node_count <value>]
[--is_auto_recovery <value>]
[--is_auto_scale <value>]
[--max_node_count <value>]
[--min_node_count <value>]
Description
set a nodepool
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
desired_node_count optional | integer | Desired Node Count | 2 |
is_auto_recovery optional | boolean | Is Auto Recovery | true |
is_auto_scale optional | boolean | Is Auto Scale | true |
max_node_count optional | integer | Max Node Count | 5 |
min_node_count optional | integer | Min Node Count | 1 |
1.15.3 - 1.0
scpcli ske nodepool set
--nodepool_id <value>
[--desired_node_count <value>]
[--is_auto_recovery <value>]
[--is_auto_scale <value>]
[--max_node_count <value>]
[--min_node_count <value>]
Description
set a nodepool
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
desired_node_count optional | integer | Desired Node Count | 2 |
is_auto_recovery optional | boolean | Is Auto Recovery | true |
is_auto_scale optional | boolean | Is Auto Scale | true |
max_node_count optional | integer | Max Node Count | 5 |
min_node_count optional | integer | Min Node Count | 1 |
1.16 - Set Nodepool Labels
1.16.1 - 1.2
scpcli ske nodepool labels set
--nodepool_id <value>
--labels <value>
Description
set nodepool labels
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
labels required | array | | '{"key": "example.com/my-app", "value": "bar"}' |
1.16.2 - 1.1
scpcli ske nodepool labels set
--nodepool_id <value>
--labels <value>
Description
set nodepool labels
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
labels required | array | | '{"key": "example.com/my-app", "value": "bar"}' |
1.16.3 - 1.0
scpcli ske nodepool labels set
--nodepool_id <value>
--labels <value>
Description
set nodepool labels
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
labels required | array | | '{"key": "example.com/my-app", "value": "bar"}' |
1.17 - Set Nodepool Taints
1.17.1 - 1.2
scpcli ske nodepool taints set
--nodepool_id <value>
--taints <value>
Description
set nodepool taints
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
taints required | array | | '{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}' |
1.17.2 - 1.1
scpcli ske nodepool taints set
--nodepool_id <value>
--taints <value>
Description
set nodepool taints
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
taints required | array | | '{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}' |
1.17.3 - 1.0
scpcli ske nodepool taints set
--nodepool_id <value>
--taints <value>
Description
set nodepool taints
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
taints required | array | | '{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}' |
1.18 - Set Nodepool Upgrade
1.18.1 - 1.2
scpcli ske nodepool upgrade set
--nodepool_id <value>
--os_version <value>
Description
upgrade a nodepool
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
os_version required | string | Image OS Version | 22.04 |
1.18.2 - 1.1
scpcli ske nodepool upgrade set
--nodepool_id <value>
--os_version <value>
Description
upgrade a nodepool
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
os_version required | string | Image OS Version | 22.04 |
1.18.3 - 1.0
scpcli ske nodepool upgrade set
--nodepool_id <value>
Description
upgrade a nodepool v1.0
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
1.19 - Show Cluster
1.19.1 - 1.2
scpcli ske cluster show
--cluster_id <value>
Description
show a cluster
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| cloud_logging_enabled | Cloud Logging Enabled | true |
| cluster_namespace | Cluster Namespace | sample-cluster-12345 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| kubernetes_version | Cluster Version | v1.29.8 |
| managed_security_group | Managed Security Group | |
| max_node_count | Cluster Max Node Count | 5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster Name | sample-cluster |
| node_count | Cluster Node Count | 5 |
| private_endpoint_access_control_resources | Private Endpoint Access Control Resources | |
| private_endpoint_url | Private Endpoint URL | https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443 |
| private_kubeconfig_download_yn | Private Kubeconfig Downloaded Or Not (Y/N) | N |
| public_endpoint_access_control_ip | Public Endpoint Access Control IP | 192.168.0.0 |
| public_endpoint_url | Public Endpoint URL | https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443 |
| public_kubeconfig_download_yn | Public Kubeconfig Downloaded Or Not (Y/N) | N |
| security_group_list | Connected Security Group List | |
| service_watch_logging_enabled | Service Watch Logging Enabled | true |
| status | Cluster Status | RUNNING |
| subnet | Subnet of Cluster | |
| volume | Connected File Storage | |
| vpc | VPC of Cluster | |
1.19.2 - 1.1
scpcli ske cluster show
--cluster_id <value>
Description
show a cluster
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| cloud_logging_enabled | Cloud Logging Enabled | true |
| cluster_namespace | Cluster Namespace | sample-cluster-12345 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| kubernetes_version | Cluster Version | v1.29.8 |
| managed_security_group | Managed Security Group | |
| max_node_count | Cluster Max Node Count | 5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster Name | sample-cluster |
| node_count | Cluster Node Count | 5 |
| private_endpoint_access_control_resources | Private Endpoint Access Control Resources | |
| private_endpoint_url | Private Endpoint URL | https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443 |
| private_kubeconfig_download_yn | Private Kubeconfig Downloaded Or Not (Y/N) | N |
| public_endpoint_access_control_ip | Public Endpoint Access Control IP | 192.168.0.0 |
| public_endpoint_url | Public Endpoint URL | https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443 |
| public_kubeconfig_download_yn | Public Kubeconfig Downloaded Or Not (Y/N) | N |
| security_group_list | Connected Security Group List | |
| service_watch_logging_enabled | Service Watch Logging Enabled | true |
| status | Cluster Status | RUNNING |
| subnet | Subnet of Cluster | |
| volume | Connected File Storage | |
| vpc | VPC of Cluster | |
1.19.3 - 1.0
scpcli ske cluster show
--cluster_id <value>
Description
show a cluster v1.0
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| cloud_logging_enabled | Cloud Logging Enabled | true |
| cluster_namespace | Cluster Namespace | sample-cluster-12345 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| kubernetes_version | Cluster Version | v1.29.8 |
| managed_security_group | Managed Security Group | |
| max_node_count | Cluster Max Node Count | 5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster Name | sample-cluster |
| node_count | Cluster Node Count | 5 |
| private_endpoint_access_control_resources | Private Endpoint Access Control Resources | |
| private_endpoint_url | Private Endpoint URL | https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443 |
| private_kubeconfig_download_yn | Private Kubeconfig Downloaded Or Not (Y/N) | N |
| public_endpoint_access_control_ip | Public Endpoint Access Control IP | 192.168.0.0 |
| public_endpoint_url | Public Endpoint URL | https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443 |
| public_kubeconfig_download_yn | Public Kubeconfig Downloaded Or Not (Y/N) | N |
| security_group_list | Connected Security Group List | |
| status | Cluster Status | RUNNING |
| subnet | Subnet of Cluster | |
| volume | Connected File Storage | |
| vpc | VPC of Cluster | |
1.20 - Show Cluster User Kubeconfig
1.20.1 - 1.2
scpcli ske cluster user kubeconfig show
--cluster_id <value>
--kubeconfig_type <value>
Description
Show user kubeconfig for the cluster
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
kubeconfig_type required | **** | Kubeconfig Type (private/public) | private |
Responses
1.20.2 - 1.1
scpcli ske cluster user kubeconfig show
--cluster_id <value>
--kubeconfig_type <value>
Description
Show user kubeconfig for the cluster
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
kubeconfig_type required | **** | Kubeconfig Type (private/public) | private |
Responses
1.20.3 - 1.0
scpcli ske cluster user kubeconfig show
--cluster_id <value>
--kubeconfig_type <value>
Description
Show user kubeconfig for the cluster
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 70a599e031e749b7b260868f441e862b |
kubeconfig_type required | **** | Kubeconfig Type (private/public) | private |
Responses
1.21 - Show Nodepool
1.21.1 - 1.2
scpcli ske nodepool show
--nodepool_id <value>
Description
show a nodepool
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
Responses
| Name | Description | Example |
|---|
| id | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| advanced_settings | Advanced Settings | |
| auto_recovery_enabled | Is Auto Recovery | true |
| auto_scale_enabled | Is Auto Scale | true |
| cluster | Cluster | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_node_count | Current Node Count | 1 |
| desired_node_count | Desired Node Count | 2 |
| image | Image | |
| keypair | Keypair Name | |
| kubernetes_version | Kubernetes Version | v1.29.8 |
| labels | Labels | |
| max_node_count | Max Node Count | 5 |
| min_node_count | Min Node Count | 1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Nodepool Name | sample-nodepool |
| server_group_id | Server Group ID | 2b8d33d5-4de5-40a5-a34c-7e30204133xc |
| server_type | Server Type | |
| status | Node Pool Status | Running |
| taints | Taints | |
| volume_size | Volume Size | 104 |
| volume_type | Volume Type | |
1.21.2 - 1.1
scpcli ske nodepool show
--nodepool_id <value>
Description
show a nodepool
State
ACTIVE (SUPPORTED)
| Version | Not Before |
|---|
| 1.1 | 20260919 |
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
Responses
| Name | Description | Example |
|---|
| id | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| advanced_settings | Advanced Settings | |
| auto_recovery_enabled | Is Auto Recovery | true |
| auto_scale_enabled | Is Auto Scale | true |
| cluster | Cluster | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_node_count | Current Node Count | 1 |
| desired_node_count | Desired Node Count | 2 |
| image | Image | |
| keypair | Keypair Name | |
| kubernetes_version | Kubernetes Version | v1.29.8 |
| labels | Labels | |
| max_node_count | Max Node Count | 5 |
| min_node_count | Min Node Count | 1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Nodepool Name | sample-nodepool |
| server_group_id | Server Group ID | 2b8d33d5-4de5-40a5-a34c-7e30204133xc |
| server_type | Server Type | |
| status | Node Pool Status | Running |
| taints | Taints | |
| volume_size | Volume Size | 104 |
| volume_type | Volume Type | |
1.21.3 - 1.0
scpcli ske nodepool show
--nodepool_id <value>
Description
show a nodepool v1.0
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
nodepool_id required | string | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
Responses
| Name | Description | Example |
|---|
| id | Nodepool ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| auto_recovery_enabled | Is Auto Recovery | true |
| auto_scale_enabled | Is Auto Scale | true |
| cluster | Cluster | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_node_count | Current Node Count | 1 |
| desired_node_count | Desired Node Count | 2 |
| image | Image | |
| keypair | Keypair Name | |
| kubernetes_version | Kubernetes Version | v1.29.8 |
| labels | Labels | |
| max_node_count | Max Node Count | 5 |
| min_node_count | Min Node Count | 1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Nodepool Name | sample-nodepool |
| server_type | Server Type | |
| status | Node Pool Status | Running |
| taints | Taints | |
| volume_size | Volume Size | 104 |
| volume_type | Volume Type | |