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 EngineSDK referencePython SDK
Copy page
Download PDFSDK reference
Python SDK
Copy pageDownload PDFPython SDK
This topic describes how to install and configure the Python SDK of Volcengine Kubernetes Engine (VKE), and offers examples of using the Python SDK to call cloud-based API actions.
Usage notes
Only Python 2.7 or later is supported.
Installation configuration
Examples of using the SDK
Creating a cluster (CreateCluster)
For more information on the parameters in the example below and how to configure them, refer to [CreateCluster](https://www.volcengine.com/docs/6460/115184?LibVersion=Volcano Engine).
# Example Code generated by Southeast Volcano Engine Technology.
from __future__ import print_function
import volcenginesdkcore
import volcenginesdkvke
from volcenginesdkcore.rest import ApiException
if __name__ == '__main__':
# The AccessKey ID and Secret Access Key of your Volcano Engine account, and the Region where your business is located.
configuration = volcenginesdkcore.Configuration()
configuration.ak = "Your AK"
configuration.sk = "Your SK"
configuration.region = "Your Region"
# set default configuration
volcenginesdkcore.Configuration.set_default(configuration)
# use global default configuration
api_instance = volcenginesdkvke.VKEApi()
req_public_access_network_config = volcenginesdkvke.PublicAccessNetworkConfigForCreateClusterInput(
bandwidth=10,
billing_type=3,
)
req_api_server_public_access_config = volcenginesdkvke.ApiServerPublicAccessConfigForCreateClusterInput(
public_access_network_config=req_public_access_network_config,
)
req_cluster_config = volcenginesdkvke.ClusterConfigForCreateClusterInput(
api_server_public_access_config=req_api_server_public_access_config,
api_server_public_access_enabled=True,
resource_public_access_default_enabled=False,
subnet_ids=["subnet-id"],
)
req_flannel_config = volcenginesdkvke.FlannelConfigForCreateClusterInput(
max_pods_per_node=64,
pod_cidrs=["172.17.**.**/19"],
)
req_pods_config = volcenginesdkvke.PodsConfigForCreateClusterInput(
flannel_config=req_flannel_config,
pod_network_mode="Flannel",
)
req_services_config = volcenginesdkvke.ServicesConfigForCreateClusterInput(
service_cidrsv4=["172.25.**.**/17"],
)
req_tags = volcenginesdkvke.TagForCreateClusterInput(
key="tag-key",
value="tag-value",
)
create_cluster_request = volcenginesdkvke.CreateClusterRequest(
client_token="client-token",
cluster_config=req_cluster_config,
delete_protection_enabled=False,
description="cluster-description",
kubernetes_version="1.24",
name="cluster-name",
pods_config=req_pods_config,
services_config=req_services_config,
tags=[req_tags],
)
try:
# Copy and run the sample code, and print the return values of the API action.
api_instance.create_cluster(create_cluster_request)
except ApiException as e:
# Copy and run the sample code, and print the error message returned by the API action.
# print("Exception when calling api: %s\n" % e)
pass
Updating the cluster configuration (UpdateClusterConfig)
For more information on the parameters in the example below and how to configure them, refer to [UpdateClusterConfig](https://www.volcengine.com/docs/6460/115189?LibVersion=Volcano Engine).
# Example Code generated by Southeast Volcano Engine Technology.
from __future__ import print_function
import volcenginesdkcore
import volcenginesdkvke
from volcenginesdkcore.rest import ApiException
if __name__ == '__main__':
# The AccessKey ID and Secret Access Key of your Volcano Engine account, and the Region where your business is located.
configuration = volcenginesdkcore.Configuration()
configuration.ak = "Your AK"
configuration.sk = "Your SK"
configuration.region = "Your Region"
# set default configuration
volcenginesdkcore.Configuration.set_default(configuration)
# use global default configuration
api_instance = volcenginesdkvke.VKEApi()
req_public_access_network_config = volcenginesdkvke.PublicAccessNetworkConfigForUpdateClusterConfigInput(
bandwidth=100,
billing_type=3,
)
req_api_server_public_access_config = volcenginesdkvke.ApiServerPublicAccessConfigForUpdateClusterConfigInput(
public_access_network_config=req_public_access_network_config,
)
req_cluster_config = volcenginesdkvke.ClusterConfigForUpdateClusterConfigInput(
api_server_public_access_config=req_api_server_public_access_config,
api_server_public_access_enabled=True,
)
update_cluster_config_request = volcenginesdkvke.UpdateClusterConfigRequest(
client_token="client-token",
cluster_config=req_cluster_config,
description="cluster-description",
id="cluster-id",
name="cluster-name",
)
try:
# Copy and run the sample code, and print the return values of the API action.
api_instance.update_cluster_config(update_cluster_config_request)
except ApiException as e:
# Copy and run the sample code, and print the error message returned by the API action.
# print("Exception when calling api: %s\n" % e)
pass
Getting the cluster list and details (ListClusters)
For more information on the parameters in the example below and how to configure them, refer to [ListClusters](https://www.volcengine.com/docs/6460/115190?LibVersion=Volcano Engine).
# Example Code generated by Southeast Volcano Engine Technology.
from __future__ import print_function
import volcenginesdkcore
import volcenginesdkvke
from volcenginesdkcore.rest import ApiException
if __name__ == '__main__':
# The AccessKey ID and Secret Access Key of your Volcano Engine account, and the Region where your business is located.
configuration = volcenginesdkcore.Configuration()
configuration.ak = "Your AK"
configuration.sk = "Your SK"
configuration.region = "Your Region"
# set default configuration
volcenginesdkcore.Configuration.set_default(configuration)
# use global default configuration
api_instance = volcenginesdkvke.VKEApi()
req_filter = volcenginesdkvke.FilterForListClustersInput(
ids=["cluster-id"],
)
list_clusters_request = volcenginesdkvke.ListClustersRequest(
filter=req_filter,
page_number=1,
page_size=10,
)
try:
# Copy and run the sample code, and print the return values of the API action.
api_instance.list_clusters(list_clusters_request)
except ApiException as e:
# Copy and run the sample code, and print the error message returned by the API action.
# print("Exception when calling api: %s\n" % e)
pass
Creating a NodePool (CreateNodePool)
For more information on the parameters in the example below and how to configure them, refer to [CreateNodePool](https://www.volcengine.com/docs/6460/115194?LibVersion=Volcano Engine).
# Example Code generated by Southeast Volcano Engine Technology.
from __future__ import print_function
import volcenginesdkcore
import volcenginesdkvke
from volcenginesdkcore.rest import ApiException
if __name__ == '__main__':
# The AccessKey ID and Secret Access Key of your Volcano Engine account, and the Region where your business is located.
configuration = volcenginesdkcore.Configuration()
configuration.ak = "Your AK"
configuration.sk = "Your SK"
configuration.region = "Your Region"
# set default configuration
volcenginesdkcore.Configuration.set_default(configuration)
# use global default configuration
api_instance = volcenginesdkvke.VKEApi()
req_auto_scaling = volcenginesdkvke.AutoScalingForCreateNodePoolInput(
desired_replicas=1,
enabled=True,
max_replicas=100,
min_replicas=0,
priority=10,
)
req_labels = volcenginesdkvke.LabelForCreateNodePoolInput(
key="label-key",
value="label-value",
)
req_taints = volcenginesdkvke.TaintForCreateNodePoolInput(
effect="NoSchedule",
key="taint-key",
value="taint-value",
)
req_kubernetes_config = volcenginesdkvke.KubernetesConfigForCreateNodePoolInput(
cordon=False,
labels=[req_labels],
taints=[req_taints],
)
req_data_volumes = volcenginesdkvke.DataVolumeForCreateNodePoolInput(
size=20,
type="ESSD_PL0",
)
req_login = volcenginesdkvke.LoginForCreateNodePoolInput(
password="***",
)
req_security = volcenginesdkvke.SecurityForCreateNodePoolInput(
login=req_login,
security_strategies=["Hids"],
)
req_system_volume = volcenginesdkvke.SystemVolumeForCreateNodePoolInput(
size=40,
type="ESSD_PL0",
)
req_tags = volcenginesdkvke.TagForCreateNodePoolInput(
key="tag-key",
value="tag-value",
)
req_node_config = volcenginesdkvke.NodeConfigForCreateNodePoolInput(
data_volumes=[req_data_volumes],
image_id="image-id",
instance_charge_type="PostPaid",
instance_type_ids=["instance-type"],
name_prefix="prefix",
security=req_security,
subnet_ids=["subnet-id"],
system_volume=req_system_volume,
tags=[req_tags],
)
req_tags1 = volcenginesdkvke.TagForCreateNodePoolInput(
key="tag-key",
value="tag-value",
)
create_node_pool_request = volcenginesdkvke.CreateNodePoolRequest(
auto_scaling=req_auto_scaling,
client_token="client-token",
cluster_id="cluster-id",
kubernetes_config=req_kubernetes_config,
name="nodepool-name",
node_config=req_node_config,
tags=[req_tags1],
)
try:
# Copy and run the sample code, and print the return values of the API action.
api_instance.create_node_pool(create_node_pool_request)
except ApiException as e:
# Copy and run the sample code, and print the error message returned by the API action.
# print("Exception when calling api: %s\n" % e)
pass
Updating the NodePool configuration (UpdateNodePoolConfig)
For more information on the parameters in the example below and how to configure them, refer to [UpdateNodePoolConfig](https://www.volcengine.com/docs/6460/115195?LibVersion=Volcano Engine).
# Example Code generated by Southeast Volcano Engine Technology.
from __future__ import print_function
import volcenginesdkcore
import volcenginesdkvke
from volcenginesdkcore.rest import ApiException
if __name__ == '__main__':
# The AccessKey ID and Secret Access Key of your Volcano Engine account, and the Region where your business is located.
configuration = volcenginesdkcore.Configuration()
configuration.ak = "Your AK"
configuration.sk = "Your SK"
configuration.region = "Your Region"
# set default configuration
volcenginesdkcore.Configuration.set_default(configuration)
# use global default configuration
api_instance = volcenginesdkvke.VKEApi()
req_auto_scaling = volcenginesdkvke.AutoScalingForUpdateNodePoolConfigInput(
desired_replicas=10,
)
update_node_pool_config_request = volcenginesdkvke.UpdateNodePoolConfigRequest(
auto_scaling=req_auto_scaling,
client_token="client-token",
cluster_id="cluster-id",
id="nodepool-id",
name="nodepool-name",
)
try:
# Copy and run the sample code, and print the return values of the API action.
api_instance.update_node_pool_config(update_node_pool_config_request)
except ApiException as e:
# Copy and run the sample code, and print the error message returned by the API action.
# print("Exception when calling api: %s\n" % e)
pass
Querying the NodePool list and details (ListNodePools)
For more information on the parameters in the example below and how to configure them, refer to [ListNodePools](https://www.volcengine.com/docs/6460/115197?LibVersion=Volcano Engine).
# Example Code generated by Southeast Volcano Engine Technology.
from __future__ import print_function
import volcenginesdkcore
import volcenginesdkvke
from volcenginesdkcore.rest import ApiException
if __name__ == '__main__':
# The AccessKey ID and Secret Access Key of your Volcano Engine account, and the Region where your business is located.
configuration = volcenginesdkcore.Configuration()
configuration.ak = "Your AK"
configuration.sk = "Your SK"
configuration.region = "Your Region"
# set default configuration
volcenginesdkcore.Configuration.set_default(configuration)
# use global default configuration
api_instance = volcenginesdkvke.VKEApi()
req_filter = volcenginesdkvke.FilterForListNodePoolsInput(
cluster_ids=["cluster-id"],
ids=["nodepool-id"],
)
list_node_pools_request = volcenginesdkvke.ListNodePoolsRequest(
filter=req_filter,
page_number=1,
page_size=10,
)
try:
# Copy and run the sample code, and print the return values of the API action.
api_instance.list_node_pools(list_node_pools_request)
except ApiException as e:
# Copy and run the sample code, and print the error message returned by the API action.
# print("Exception when calling api: %s\n" % e)
pass
Installing an add-on (CreateAddon)
For more information on the parameters in the example below and how to configure them, refer to [CreateAddon](https://www.volcengine.com/docs/6460/115202?LibVersion=Volcano Engine).
# Example Code generated by Southeast Volcano Engine Technology.
from __future__ import print_function
import volcenginesdkcore
import volcenginesdkvke
from volcenginesdkcore.rest import ApiException
if __name__ == '__main__':
# The AccessKey ID and Secret Access Key of your Volcano Engine account, and the Region where your business is located.
configuration = volcenginesdkcore.Configuration()
configuration.ak = "Your AK"
configuration.sk = "Your SK"
configuration.region = "Your Region"
# set default configuration
volcenginesdkcore.Configuration.set_default(configuration)
# use global default configuration
api_instance = volcenginesdkvke.VKEApi()
create_addon_request = volcenginesdkvke.CreateAddonRequest(
client_token="client-token",
cluster_id="cluster-id",
deploy_mode="Managed",
deploy_node_type="Node",
name="cluster-autoscaler",
)
try:
# Copy and run the sample code, and print the return values of the API action.
api_instance.create_addon(create_addon_request)
except ApiException as e:
# Copy and run the sample code, and print the error message returned by the API action.
# print("Exception when calling api: %s\n" % e)
pass
Last updated: 2026.03.31 10:58:11
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
