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 referenceCloud native observabilityListKubernetesObservability
Copy page
Download PDFCloud native observability
ListKubernetesObservability
Copy pageDownload PDFListKubernetesObservability
Queries whether basic observability is enabled for a cluster.
Request description
VKE has deployed services in multiple regions globally to provide a stable and low-latency access experience. See Service addresses and select the most suitable endpoint for the region where your business operates.
- Request method: POST
- Request URL: https://vke.cn-beijing.volcengineapi.com?Action=ListKubernetesObservability&Version=2022-05-12
Debugging
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
The following table describes the API request parameters. You also need to provide public parameters when calling this API. For details about public request parameters, see Public parameters.
Parameter | Type | Required | Sample value | Description |
Parameter | Type | Required | Sample value | Description |
Action | String | Yes | ListKubernetesObservability | The API name. The API name is ListKubernetesObservability. |
Version | String | Yes | May 12, 2022 | The API version. The API version is 2022-05-12. |
Filter | Yes | - | The query filters. | |
PageNumber | Integer | No | 1 | The starting page number for paginated queries. The value starts at 1 and defaults to 1. |
PageSize | Integer | No | 10 | The number of results per page:
|
ClusterFilter
Parameter | Type | Required | Sample value | Description |
Parameter | Type | Required | Sample value | Description |
ClusterIds | Array of String | No | ["ccbm7****", "ccdhm****"] | Cluster ID. |
Sample requests
POST https://vke.cn-beijing.volcengineapi.com?Action=ListKubernetesObservability&Version=2022-05-12
Content-Type: application/json
{
"Filter": {
"ClusterIds": [
"ccbm7****",
"ccdhm****"
]
},
"PageNumber": 1,
"PageSize": 10
}
Response parameter
The following table contains the response parameters of this API. See Response results for details about public response parameters.
Parameter | Type | Sample value | Description |
Parameter | Type | Sample value | Description |
Items | - | The cluster observability configuration. | |
PageNumber | Integer | 1 | The current page number. |
PageSize | Integer | 10 | Number of tasks displayed per page. |
TotalCount | Integer | 2 | The total number of data entries that match the query conditions. |
KubernetesObservabilityConfig
Parameter | Type | Sample value | Description |
Parameter | Type | Sample value | Description |
Enabled | Boolean | true | Whether basic observability is enabled for the cluster. Valid values:
|
ClusterId | String | ccbm7**** | Cluster ID. |
Sample responses
{
"ResponseMetadata": {
"RequestId": "20230604110420**********",
"Action": "ListKubernetesObservability",
"Version": "2022-05-12",
"Service": "vke",
"Region": "cn-beijing"
},
"Result": {
"Items": [
{
"Enabled": true,
"ClusterId": "ccbm*****"
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 2
}
}
Error code
There are no error codes proprietary to this API. See Public error codes for details about public error codes.
Last updated: 2026.10.10 15:03:21
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
