Volcengine Kubernetes Engine
Volcengine Kubernetes Engine
Volcengine Kubernetes Engine
Document
Volcengine Kubernetes Engine
What's New
History feature release notes
Kubernetes version release notes
Containerd runtime release notes
Add-on release notes
Monitoring add-ons
Scheduling add-ons
DNS add-ons
Security add-ons
GPU add-ons
Sandbox add-on
Security announcements
Product Announcement
Historical announcements
Overview
Getting started
User guide
Clusters
Creating clusters
Connecting to clusters
Upgrading clusters
Node pool
Creating node pools
Scaling out/in node pools
Nodes
Authorization management
Image
Namespaces
Networking
Cluster network
Container Network
Service
LoadBalancer
CLB
Ingress
APIG Ingress
ALB Ingress
Customize ALB Ingress forwarding rules
Certificate and security
CLB Ingress
Nginx Ingress
Gateway API
Workloads
Creating workloads
Configure workloads
Pods
Configuration management
Image acceleration
Storage
FSX client
EBS Volumes
TOS Volumes
NAS volumes
FSX access methods
NFS access methods
EFS volumes
vePFS volumes
FSX access methods
vePFS Client access methods
NFS access methods
CloudFS volumes
Local volumes
Autoscale
Node autoscaler
Workload autoscaler
Horizontal Pod Autoscaler (HPA)
Cron Horizontal Pod Autoscaler (CronHPA)
Intelligent Horizontal Pod Autoscaler (IHPA)
Horizontal Pod Autoscaler based on event-driven (KEDA)
Add-on management
Network add-ons
Storage add-ons
Monitoring add-ons
Scheduling add-ons
DNS add-ons
GPU add-ons
Core add-ons
Sandbox add-on
Upgrading add-ons
Heterogeneous computing
NVIDIA GPU
mGPU scheduling
RDMA high-performance computing
Scheduling management
Topology-aware scheduling
QoS-aware scheduling
Observability
Log management
Basic observation
Setup & Configuration
Cluster observation
Storage observation
Other observation
Using metrics
Full stack observation
Alert management
Diagnosis and inspection
Node check and self-healing
Application center
Backup center
Stability
Large-scale cluster management
Best practices
Authorization
Clusters
Nodes and node pools
Networking
Storage
Scheduling
Observability
Solution
Security and compliance
API reference
Cluster management
NodePool management
Node management
Virtual nodes management
Add-on management
Tag management
Access policy management
Instance images management
Cloud native observability
Inspection and diagnosis
Task management
Volcengine Container Instance
Appendix
SDK reference
Development guide
Terraform
FAQs
General FAQs
Cluster FAQ
cluster management
cluster network
cluster upgrade
Node and Node pool FAQs
Authorization FAQs
Workload FAQs
Service and Ingress FAQs
Storage FAQs
Heterogeneous computing FAQs
Observability FAQs
Quota FAQs
Add-on FAQs
Cloud-native AI
ServingKit
LLM applications
ComfyUI application
Deploying the Al inference application through Helm
Deepseek practices
Qwen practices
Kimi practice
Seed practices
Best practices
DeepSeek model deployment
GLM model deployment
MiniMax model deployment
Qwen model deployment
Kimi model deployment
Volcengine Container Instance
What's new
Historical feature release notes
Product Announcement
Overview
Billing
User guide
Integrating with VCI
Virtual node
VKE cluster uses virtual nodes
Self-managed/third-party cluster uses virtual node
Creating an instance
General purpose instance
GPU-accelerated computing instance
VCI Agent Sandbox
Startup acceleration
E2B-based management
Upgrade guide
Networking
Monitoring
Scheduling
Container configuration
VCI Image Cache
Best practices
Security and compliance
FAQs
- Documentation
Volcengine Kubernetes EngineVolcengine Kubernetes EngineAPI referenceAPI overview
Copy page
Download PDFAPI reference
API overview
Copy pageDownload PDFAPI overview
VKE provides the following APIs.
Clusters
API | Description |
API | Description |
Create a cluster. | |
Obtain the list and details of clusters. | |
Update cluster configurations. | |
Obtain the resource types supported by a cluster. | |
Delete a cluster. | |
Generate the Kubeconfig credentials for a cluster. | |
Query the list of Kubeconfig details for clusters that meet the specified criteria. | |
Revoke the Kubeconfig credentials of a cluster. | |
Upgrade the cluster control plane. | |
Upgrade the cluster data plane. |
Node pools
API | Description |
API | Description |
Create a node pool. | |
Create a default node pool. | |
Update node pool configurations. | |
Update node configurations for node pools. | |
Query the list and details of node pools. | |
Delete a node pool. | |
Scale out the specified node pool. | |
Create an elastic scheduled scaling policy for a node pool. | |
Update an elastic scheduled scaling policy for a node pool. | |
Query the list of elastic scheduled scaling rules for node pools. | |
Delete elastic scheduled scaling rules for a node pool. |
Nodes
API | Description |
API | Description |
Add a node. | |
Obtain the list and details of nodes. | |
Remove a node. |
Virtual nodes
tip
[Beta - apply for trial]: APIs related to virtual nodes are in beta. To use these APIs, submit an application.
API | Description |
API | Description |
Create a virtual node. | |
Query the list and details of virtual nodes that meet the specified criteria. | |
Delete a specified virtual node. |
Add-ons
API | Description |
API | Description |
View details of add-ons supported by VKE. | |
Install add-ons for a specified cluster. | |
Update the configurations of a specified add-on in a specified cluster. | |
Update the version of a specified add-on in a specified cluster. | |
Remove a specified add-on from a specified cluster. | |
Query the details of installed add-ons that meet the criteria. |
Tags
API | Description |
API | Description |
Add a tag to a specified resource. | |
Remove a tag from a resource. | |
List all tags for resources that meet the specified conditions. |
Access policy
API | Description |
API | Description |
Grant RBAC access permissions to an IAM user or role. | |
Query RBAC access policy resource information that meets the conditions. | |
Revoke the RBAC permission granted to an IAM user or role by specifying the resource ID of the permission policy. |
Management of supported images for instance specifications
API | Description |
API | Description |
Obtain the list of images supported by ECS instance specifications that correspond to nodes. | |
Obtain the list of labels supported by ECS instance specifications that correspond to nodes. | |
Obtain a list of GPU driver versions supported by the image. | |
Obtain the list of specifications that can be added to VKE nodes within the current account. |
Cloud native observability
API | Description |
API | Description |
Enable basic observability capabilities of cloud-native observability for the specified service. |
Job
API | Description |
API | Description |
Update a task. | |
Query tasks. |
VCI image cache
API | Description |
API | Description |
Create an image cache. | |
Update an image cache. | |
Query the list of image caches that meet the specified criteria. | |
Delete a specified image cache. | |
Update the expiration time of multiple image caches at the same time. |
Inspection and diagnosis
API | Description |
API | Description |
Create an inspection and diagnostic task. | |
Query diagnostic tasks. | |
Query the results of a diagnostic task. | |
Create an inspection policy. | |
Query the inspection policy list. | |
Update the configuration of an inspection policy. | |
Delete an inspection policy. | |
Creates a check and self-healing rule. | |
Update the configuration of the check and self-healing rule. | |
Delete a check and self-healing rule. |
Cluster observability
API | Description |
API | Description |
Enable basic observability for a cluster. | |
Query whether basic observability is enabled for a cluster. |
Last updated: 2026.10.16 17:40:20
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
