Docs

Volcengine Kubernetes Engine

Cloud native observability

UpdateKubernetesObservabilityComponentConfigs

Enable basic observability capabilities of cloud-native observability for the specified service.

warning

Before using this API to enable basic cloud-native observability capabilities for the specified services (such as AI resources, DNS, and CSI storage), confirm that cloud-native observability is enabled in the cluster. For details, see Enabling observability.

Request description

VKE has deployed services in multiple regions globally to provide a stable and low-latency access experience. You can refer to the Service addresses topic and select the most suitable access point based on the region where your business is located.

Request method: POST

Request URL: https://vke.cn-beijing.volcengineapi.com?Action=UpdateKubernetesObservabilityComponentConfigs&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.

Go to debug

Request parameter

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
Action	String	Yes	UpdateKubernetesObservabilityComponentConfigs	The API name. The API name is UpdateKubernetesObservabilityComponentConfigs.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
ClusterId	String	Yes	cc9l74mvqtofjnoj5xxxx	Cluster ID. You can call the ListClusters API to obtain cluster IDs.
ObservabilityComponentConfigs	Array of UpdatableObservabilityComponentConfig	Yes	-	A list of basic observability configurations for services. Each element of the array represents the basic observability toggle configuration for a service. To configure multiple services at the same time, pass multiple objects in the array.

UpdatableObservabilityComponentConfig

Parameter	Type	Required	Sample value	Description
Enabled	Boolean	Yes	true	Whether to enable the basic observability feature for the service. Valid values: true: Enables the feature. The system collects basic observability data from this service. false: Does not enable this feature. The system no longer collects basic observability data from this service.
Component	String	Yes	vko.monitoring.dns	The service for which you want to enable basic observability. Valid values: vko.monitoring.container: Container service vko.monitoring.ctrlPanel: control plane service vko.monitoring.dns: DNS service vko.monitoring.cni: CNI Network vko.monitoring.csi: CSI Storage vko.monitoring.ingress: Ingress service vko.monitoring.imageSpeedup: Image speedup vko.monitoring.imageRegistry: Image repository vko.monitoring.ai: AI resources vko.aiopsRemediation: AIOps remediation

Sample requests

Response parameter

There are no proprietary response parameters for this API. See Response results for details about public response parameters.

Sample responses

Error code

There are no proprietary error codes for this API. See Public error codes for details about public error codes.

Last updated: 2026.08.27 10:27:29