Available in VPC
Ncloud Kubernetes Service is an open-source platform that automates the containerization, deployment, scaling, and management of applications. Ncloud Kubernetes Service provides APIs for controlling and managing Kubernetes environments in a RESTful form.
Common Ncloud Kubernetes Service settings
The following describes commonly used request and response formats in Ncloud Kubernetes Service APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows:
https://nks.apigw.ntruss.com
Request headers
The following describes the request headers.
| Field | Required | Description |
|---|---|---|
x-ncp-apigw-timestamp |
Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
|
x-ncp-iam-access-key |
Required | Access key issued on NAVER Cloud Platform
|
x-ncp-apigw-signature-v2 |
Required | Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256).
|
Content-Type |
Required | Request data format
|
Response
The following describes the common response format.
Response status codes
The following describes the response status codes.
| HTTP status code | Code | Message | Description |
|---|---|---|---|
| 403 | - | ForbiddenException | It is caused by insufficient permissions when making API calls with Sub Account. |
| 409 | - | ConflictException | It is caused by making a modification request while a cluster or pool of nodes is in operation. |
Note
For information about the HTTP status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
Ncloud Kubernetes Service API
The following describes the APIs provided by the Ncloud Kubernetes Service service.
| API | Description |
|---|---|
| Get cluster list | Get cluster list. |
| Get cluster | Get cluster information. |
| Create cluster | Create new cluster. |
| Upgrade cluster version | Upgrade Kubernetes on a cluster to a new version. |
| Set cluster audit log | Set whether to collect logs through the Cloud Log Analytics service. |
| Add cluster subnet | Add subnet to a cluster. |
| Set cluster OIDC | Add OIDC authentication feature to a cluster. |
| Get cluster OIDC | Get cluster's OIDC configuration information. |
| Set cluster IP ACL | Set IP ACL for a cluster. |
| Get cluster IP ACL | Get IP ACL information configured in a cluster. |
| Edit cluster LB subnet | Set up a new load balancer subnet if the load balancer subnet configured for the cluster has been deleted. |
| Set cluster termination protection | Set termination protection status for a cluster. |
| Set cluster secret encryption | Set secret encryption for a created cluster. |
| Set cluster authentication mode | Edit cluster authentication mode for a cluster. |
| Get cluster IAM access list | Get cluster's IAM access list information. |
| Get cluster IAM access | Get cluster's IAM access information. |
| Create cluster IAM access | Create IAM access for a cluster. |
| Edit cluster IAM access | Edit cluster's IAM access information. |
| Delete cluster IAM access | Delete cluster's IAM access. |
| Delete cluster | Delete cluster. |
| Get WorkerNode | Get the list of worker nodes created in a cluster. |
| Delete WorkerNode | Delete worker nodes created in a cluster. |
| Get NodePool | Get the list of node pools set up to create nodes in a cluster. |
| Create NodePool | Create a node pool that sets the number of worker nodes in the cluster, their specifications, and more. |
| Edit NodePool | Change the number of pinned nodes in an already created node pool or set whether to use autoscaling. |
| Edit NodePool subnet | Edit the assigned subnet band only for NodePools that have been assigned a separate subnet. |
| Edit NodePool label | Edit node pool's label. |
| Edit NodePool taint | Edit node pool's taint. |
| Upgrade NodePool | Upgrade the version of the node pool registered in a cluster. |
| Delete NodePool | Delete a created node pool and the nodes belonging to it from a cluster. |
| Get kubeconfig | Get the kubeconfig configuration file for a cluster. |
| Get supported K8s versions | Check which versions of Kubernetes support cluster creation. |
| Get server image | Get the types of server images available when creating a cluster. |
| Get server specifications | Get server specifications available when creating a cluster or node pool. |
Ncloud Kubernetes Service related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand Ncloud Kubernetes Service APIs.
- Ncloud Kubernetes Service API guides
- Create signature: How to create a signature to add to the request header
- Sub Account User Guides: How to issue the access key to be added to the request header
- Common Ncloud response status codes: Information on common response status codes of NAVER Cloud Platform used by the Ncloud Kubernetes Service service
- How to use the Ncloud Kubernetes Service
- Ncloud Kubernetes Service user guide: How to use Ncloud Kubernetes Service in the NAVER Cloud Platform console
- Ncloud user environment guide: Explore VPC and Classic environments and supported services.
- Pricing and features: View pricing details and key capabilities.
- Latest service news: The latest news on Ncloud Kubernetes Service
- FAQs: Get answers to common Ncloud Kubernetes Service questions.
- Contact Support: Get help if you can't find what you need in the API guide.