Query the details of clusters that meet the criteria.

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 for your business region.

Request method: POST

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

The following table describes the API request parameters. You also need to provide public parameters when calling this API. See Public parameters for details.

Parameter	Type	Required	Sample value	Description
Action	String	Yes	ListClusters	The API name. The name of the current API is ListClusters.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
Filter	Object of ListClustersFilter	No	-	The filter conditions for the cluster to be queried.
Tags	Array of ListTagFilter	No	-	Query the cluster list based on tags. Each Key of Tags must be unique. The Key and Value in Tags cannot start or end with a space. Up to 10 tags are supported per call.
PageNumber	Integer	No	1	The starting page number of the pagination query, starting from 1. Default value: 1.
PageSize	Integer	No	10	The number of results per page: Minimum value: 1 Maximum value: 100 Default value: 10
ProjectName	String	No	default	The project name. You can filter clusters by the project to which the clusters belong.

ListClustersFilter

Parameter	Type	Required	Sample value	Description
Ids	Array of String	No	["cc9q8p******"]	A list of cluster IDs. 100 IDs can be included at most in a single query. tip If you leave this parameter empty, filtering is performed on all clusters in the region specified in the public parameters within the current account.
Name	String	No	TestCluster	Cluster name. Fuzzy query is supported.
DeleteProtectionEnabled	Boolean	No	false	Specify whether to enable cluster deletion protection. Valid values: true: Enable it. false: Disable it.
PodsConfig.PodNetworkMode	String	No	Flannel	The Pod network model (CNI). Valid values: Flannel: an independent underlay network solution, based on which a high-performance network for clusters can be built along with the global routing capabilities of VPCs. VpcCniShared: VPC-CNI, an Underlay container network solution implemented based on the ENI of private networks.
Statuses	Array of ClusterStatusFilter	No	-	An array of cluster statuses to filter. The logic OR relationship is applied to the elements in the array. Up to 15 status array elements can be provided at a time.
CreateClientToken	String	No	BB928624-11C0-4856-******	The ClientToken generated upon cluster creation. The ClientToken is a string that ensures request idempotency. This string is provided by the caller.
UpdateClientToken	String	No	BB928624-11C0-4856-******	The ClientToken generated for the last successful cluster update. The ClientToken is a string that ensures request idempotency. This string is provided by the caller.
Types	Array of String	No	Managed	The cluster type (exact matching). Valid values: Managed: Managed cluster Registered: [Beta - apply for trial] Registered cluster

ClusterStatusFilter

Parameter	Type	Required	Sample value	Description
Phase	String	No	Creating	The cluster status. Valid values: Creating: It is being created. Running: It is running. Updating: It is being updated. Stopped Deleting: It is being deleted. Failed tip At least one of Phase and Conditions.Type must be provided. Otherwise, it is an invalid array element. For valid combinations of Phase and Conditions.Type, see Resource status description.
Conditions.Type	String	No	Ok	The condition under which the cluster enters the current status. Valid values: Ok: The cluster is in a normal status. CreateError: The cluster fails to be created. Progressing: The cluster is being processed. Balance: Overdue payments exist in the account. ResourceCleanupFailed: The cluster fails to be deleted. Unknown: An unknown error occurs. UpdatingCluster: The configurations of the cluster are being updated. SyncingAddon: The add-on is being updated. SyncingNodePool: The node pool is being updated. ClusterVersionUpgrading: The cluster version is being upgraded. tip At least one of Phase and Conditions.Type must be provided. Otherwise, it is an invalid array element. For valid combinations of Phase and Conditions.Type, see Resource status description.

ListTagFilter

Parameter	Type	Required	Sample value	Description
Key	String	Yes	key	The label key. It cannot start with volc: in ‌any case variation‌. It can only contain language characters, digits, spaces, and the following special characters: _ . : / = + - @。 The length is limited to 1 to 128 characters.
Value	String	No	value	A single tag value. It is used to match one candidate value under the same tag key. It can contain only letters, digits, spaces, and the following special characters: _ . : / = + - @。 Its length does not exceed 256 characters. This can be left blank. tip When both Value and Values are provided, the label values are merged into the same candidate set for matching. They are neither mutually exclusive nor deduplicated.
Values	Array of String	No	["value1","value2"]	The list of tag values. It is used to match multiple candidate values under the same tag key. Each tag value needs to meet the following conditions: It can only contain language characters, digits, spaces, and the following special characters: _ . : / = + - @。 Its length does not exceed 256 characters. Multiple tag values are separated with commas (,). This can be left blank. After you specify the parameter values, clusters matching any tag value in this list will be filtered. tip When both Value and Values are provided, the label values are merged into the same candidate set for matching. They are neither mutually exclusive nor deduplicated.

Sample requests

Response parameters

The following table contains the response parameters of this API. See Response results for details about public response parameters.

Parameter	Type	Sample value	Description
Items	Array of ClusterResponse	-	The list of detailed information about clusters.
PageNumber	Integer	1	The current page number.
PageSize	Integer	10	The number of clusters displayed per page.
TotalCount	Integer	100	The total number of clusters that meet the conditions.

ClusterResponse

Parameter	Type	Sample value	Description
Id	String	cc9q8p*******	Cluster ID.
CreateClientToken	String	BC028527-33B9-4990-A633-******	The ClientToken generated upon successful creation. The ClientToken is a string that ensures request idempotency. This string is provided by the caller.
UpdateClientToken	String	BC028527-33B9-4990-A633-******	The ClientToken generated for the last successful update. The ClientToken is a string that ensures request idempotency. This string is provided by the caller.
CreateTime	String	2022-05-06T02:49:19Z	The time when the cluster was created. UTC+0 time in standard RFC3339 format.
UpdateTime	String	2022-05-15T03:13:20Z	The time when the cluster was last updated. UTC+0 time in standard RFC3339 format.
KubernetesVersion	String	v1.36.1-vke.2	The Kubernetes version that corresponds to the cluster.
Name	String	TestCluster	Cluster name.
Description	String	A Kubernetes Cluster Managed by VKE	The cluster description.
Status	Object of ClusterStatus	-	The cluster status.
DeleteProtectionEnabled	Boolean	false	Specify whether to enable cluster deletion protection. Valid values: true: Enable deletion protection. false: Disable deletion protection.
ClusterConfig	Object of ClusterConfigResponse	-	The network configurations of the cluster control plane and some nodes.
PodsConfig	Object of PodsConfigResponse	-	The pod network configurations.
ServicesConfig	Object of ServicesConfigResponse	-	The service network configurations.
NodeStatistics	Object of NodeStatistics	-	The statistics on the number of nodes when the cluster is in each primary status.
Tags	Array of TagResponse	-	The tags added to the cluster.
LoggingConfig	Object of ClusterLoggingConfigResponse	-	Log configuration for the cluster.
Type	String	-	The cluster type. Valid values: Managed: Managed cluster Registered: [Beta - apply for trial] Registered cluster
IrsaConfig	Object of IrsaConfigResponse	-	The configurations related to the IRSA capability.
ProjectName	String	default	The project to which the cluster belongs.
ConnectorConfig	Object of ClusterConnectorConfigResponse	-	[Beta - apply for trial] The connection configurations of the registered cluster. tip The registered cluster is currently in beta. The ConnectorConfig parameter and its related sub-parameters described in this topic are returned only after you obtain beta access and use the feature.
KubernetesConfig	Object of ClusterKubernetesConfigResponse	-	Kubernetes-related parameter configuration.
MonitoringConfig	Object of ClusterMonitoringConfigResponse	-	The monitoring configurations of the managed cluster.
MaintenanceWindowConfig	Object of ClusterMaintenanceWindowConfigResponse	-	The O&M configurations of the cluster.
Message	String	CLB clb-rrgk**** deletion failed	The cluster error message.
RegisterMonitoringConfig	Object of RegisterClusterMonitoringConfigResponse	-	[Beta - apply for trial] The monitoring configurations of the registered cluster. tip The registered cluster is currently in beta. The RegisterMonitoringConfig parameter and its related sub-parameters described in this topic are returned only after you obtain beta access and use the feature.

ClusterStatus

Parameter	Type	Sample value	Description
Phase	String	Creating	The cluster status. Valid values: Creating: It is being created. Running: It is running. Updating: It is being updated. Stopped Deleting: It is being deleted. Failed: An abnormality has occurred. tip For valid combinations of Phase and Conditions.Type, see Resource status description.
Conditions	Array of ClusterStatusCondition	-	The condition under which the cluster enters the primary status.

ClusterStatusCondition

Parameter	Type	Sample value	Description
Type	String	Ok	The condition under which the cluster enters the primary status. You can specify multiple conditions. Valid values: Ok: The cluster is in a normal status. CreateError: The cluster fails to be created. Progressing: The cluster is being processed. Balance: Overdue payments exist in the account. ResourceCleanupFailed: The cluster fails to be deleted. Unknown: An unknown error occurs. UpdatingCluster: The configurations of the cluster are being updated. SyncingAddon: The add-on is being updated. SyncingNodePool: The node pool is being updated. ClusterVersionUpgrading: The cluster version is being upgraded. tip For valid combinations of Phase and Conditions.Type, see Resources status description.

ClusterConfigResponse

Parameter	Type	Sample value	Description
VpcId	String	vpc-2d*******	The ID of the VPC where the network of the cluster control plane and some nodes is located.
SubnetIds	Array of String	["subnet-2d73****"]	The IDs of subnets within the VPC for the control plane of the cluster.
SecurityGroupIds	Array of String	["sg-3re8ff****"]	A list of IDs of security groups used by the control plane and nodes of the cluster.
ApiServerPublicAccessEnabled	Boolean	false	Specify whether to enable public access to the API server of the cluster. Valid values: false: Disable it. true: Enable it.
ApiServerPublicAccessConfig	Object of PublicAccessConfigResponse	-	The public access configurations of the API server of the cluster. This parameter is returned only if ApiServerPublicAccessEnable is set to true.
ResourcePublicAccessDefaultEnabled	Boolean	false	The public node access configuration. Valid values: false: Disable it. true: Enable it.
ApiServerEndpoints	Object of ClusterApiServerEndpointsResponse	-	The endpoint used for accessing the API server of the registered cluster.
IpFamily	String	Ipv4	The cluster network protocol stack. Valid values: Ipv4: Single-stack IPv4 Ipv6: [Beta - apply for trial] Single-stack IPv6 DualStack: [Beta - apply for trial] Dual stack IPv4 and IPv6

PublicAccessConfigResponse

Parameter	Type	Sample value	Description
AccessSourceIpsv4	Array of String	["0.0.0.0/0"]	The allowlist for public access via IPv4. If this parameter is left empty, it indicates that all CIDR blocks are allowed (0.0.0.0/0).
PublicAccessNetworkConfig	Object of EipConfigResponse	-	The public access configurations. This parameter is returned only if ApiServerPublicAccessEnable is set to true.

EipConfigResponse

Parameter	Type	Sample value	Description
Isp	String	BGP	The line type of the EIP. Valid values: BGP: BGP (multipath)
Bandwidth	Integer	100	The maximum bandwidth of the EIP. Unit: Mbit/s.
BillingType	Integer	3	The billing type of the EIP. Valid values: 2: Pay-as-you-go - by bandwidth limit 3: Pay-as-you-go - by actual traffic
BandwidthPackageId	String	bwp-2ze********	The ID of the shared bandwidth package. This parameter indicates that the EIP has been added to this shared bandwidth package.

ClusterApiServerEndpointsResponse

Parameter	Type	Sample value	Description
PublicIp	Object of Endpoint	-	The public endpoint address of the cluster API server.
PrivateIp	Object of Endpoint	-	The private endpoint address of the cluster API server.

Endpoint

Parameter	Type	Sample value	Description
Ipv4	String	10.249.xx.xx	The IPv4 address of the endpoint.

PodsConfigResponse

Parameter	Type	Sample value	Description
PodNetworkMode	String	Flannel	The Pod network model (CNI). Valid values: Flannel: Flannel, an independent Underlay container network model. VpcCniShared: VPC-CNI, an Underlay container network model implemented based on the ENI of private networks.
VpcCniConfig	Object of VpcCniConfigResponse	-	The VPC-CNI network configuration.
FlannelConfig	Object of FlannelConfigResponse	-	The Flannel network configurations.

VpcCniConfigResponse

Parameter	Type	Sample value	Description
SubnetIds	Array of String	["subnet-5g39d**","subnet-5g39d**"]	The list of pod subnet IDs in VPC-CNI networking.
VciSubnetIds	Array of String	["subnet-5g39**","subnet-5g39d**"]	A list of IDs of VCI Pod subnets in the VPC-CNI networking.
TrunkEniEnabled	Boolean	false	[Beta - apply for trial] Specify whether the Pod primary ENI supports Trunk ENI. true false This parameter is returned only if the PodNetworkMode parameter is set to VpcCniShared.

FlannelConfigResponse

Parameter	Type	Sample value	Description
PodCidrs	Array of String	["172.168.xx/19"]	The pod CIDR for Flannel pod networking.
SubnetIds	Array of String	["subnet-5g39d**","subnet-5g39d**"]	The list of pod subnet IDs that correspond to the Flannel network model.
MaxPodsPerNode	Integer	64	The maximum number of pod instances per node for Flannel pod networking.

ServicesConfigResponse

Parameter	Type	Sample value	Description
ServiceCidrsv4	Array of String	["172.25.xx/17"]	The private IPv4 address exposed by the Kubernetes Service.

NodeStatistics

Parameter	Type	Sample value	Description
TotalCount	Integer	8	The total number of nodes.
FailedCount	Integer	1	The total number of nodes in the Failed phase.
RunningCount	Integer	1	The total number of nodes in the Running phase.
CreatingCount	Integer	1	The total number of nodes in the Creating phase.
DeletingCount	Integer	1	The total number of nodes in the Deleting phase.
UpdatingCount	Integer	1	The total number of nodes in the Updating phase.

TagResponse

Parameter	Type	Sample value	Description
Key	String	key	The label key.
Type	String	Custom	Tag type. Valid values: System: System tag Custom: User-defined tag
Value	String	value	The label value.

ClusterLoggingConfigResponse

Parameter	Type	Sample value	Description
LogSetups	Array of LogSetupResponse	-	Cluster logging setups.
LogProjectId	String	d94b4eb4-********	The ID of the log project for the cluster. If this parameter is left empty, it indicates that the log project of the cluster has not been created.

LogSetupResponse

Parameter	Type	Sample value	Description
LogTtl	Integer	30	The log retention period in TLS. Unit: days. A value of 3650 indicates permanent storage.
Enabled	Boolean	false	Specify whether to enable this log option. Valid values: true: It is enabled. false: It is disabled.
LogType	String	Audit	The type of enabled logs. Valid values: Audit: Cluster audit log KubeApiServer: kube-apiserver add-on log KubeScheduler: kube-scheduler add-on log KubeControllerManager: kube-controller-manager add-on log
LogTopicId	String	a72b4eba-********	The ID of the TLS log topic for the collection target. If this parameter is left empty, it indicates that the corresponding log topic has not been created.

IrsaConfigResponse

Parameter	Type	Sample value	Description
Issuer	String	https://oidc-vke-region.tos-cn-region.volces.com/****	The URL of the OpenID Connect (OIDC) provider, which is its unique identifier.
Enabled	Boolean	false	Specify whether to enable the IRSA feature. Valid values: true: Enable it. false: Disable it.
JwksUrl	String	https://oidc-vke-region.tos-cn-region.volces.com/****	The JSON Web Key Set (JWKS) URL. The public keys in the file are used to verify any JSON Web Tokens (JWTs) returned by the OIDC provider.
OidcTrn	String	trn:iam::210**:oidc-provider/**	The provider TRN of OIDC.
Audience	String	sts.volcengine.com	The identifier of the token recipient.
OpenIdConfigUrl	String	https://oidc-vke-region.tos-cn-region.volces.com/cluster-id/****	The configuration file in the JSON format of the OIDC provider, which contains information about the OIDC provider.

ClusterConnectorConfigResponse

Parameter	Type	Sample value	Description
Type	String	Direct	The connection type of the registered cluster. Valid values: Direct: Direct connection mode. The cluster is registered and managed through the direct connection mode of the KubeConfig for the target cluster. Proxy: Proxy mode. The cluster is registered and managed through an Agent.
Provider	String	Vke	The provider of the registered cluster. Valid values: Ack: Alibaba Cloud ACK Tke: Tencent Cloud TKE Cce: Huawei Cloud CCE Gke: Google Cloud GKE Eks: Amazon EKS BaiduCce: Baidu Cloud CCE None: custom cluster
ProxyConfig	Object of ProxyConfigResponse	-	The connection configurations of the registered cluster.

ProxyConfigResponse

Parameter	Type	Sample value	Description
VpcId	String	vpc-2d7*******	The ID of the VPC used by registered cluster.
SubnetIds	Array of String	["subnet-2d73mha****"]	The IDs of the subnets used by the registered cluster.
AclEnabled	Boolean	true	Specify whether to enable ACL allowlist control. Valid values: false true
AclIpWhitelist	Array of String	["192.168.1.0/24", "10.0.0.0/16"]	The IP address list in the listener ACL allowlist. This parameter is returned only if AclEnabled is set to true.
ApiServerEndpoints	Object of ClusterApiServerEndpointsResponse	-	The endpoint used for accessing the API server of the registered cluster.
ApiServerPublicAccessConfig	Object of PublicAccessConfigResponse	-	The public access configurations of the API server of the registered cluster. This parameter is returned only if ApiServerPublicAccessEnable is set to true.
ApiServerPublicAccessEnabled	Boolean	false	Specify whether to enable public access to the API server of the registered cluster. Valid values: false: Disable it. true: Enable it.

ClusterKubernetesConfigResponse

Parameter	Type	Sample value	Description
CustomSans	Array of String	["abc.com","192.168.0.10"]	The custom-issued domain name or IP.
ClusterDomain	String	cluster.local	Cluster local domain name.
AdvancedConfig	Object of AdvancedConfig	-	The enhanced configuration for kube-apiserver.
ControlPlaneConfig	Object of KubernetesComponentConfigs	-	The custom parameter configuration for Kubernetes core add-ons.

AdvancedConfig

Parameter	Type	Sample value	Description
InternalDnsEnabled	Boolean	true	Whether to enable private domain access to the API Server for the cluster. Valid values: true: Enable it. Node-side components access the API Server via the private domain. false: Disable it.

KubernetesComponentConfigs

Parameter	Type	Sample value	Description
KubeApiServerConfig	Object of KubeApiServerConfig	-	The custom parameter configuration for the kube-apiserver add-on.
KubeSchedulerConfig	Object of KubeSchedulerConfig	-	The custom parameter configuration for the kube-scheduler add-on.
KubeControllerManagerConfig	Object of KubeControllerManagerConfig	-	The custom parameter configuration for the kube-controller-manager add-on.

KubeApiServerConfig

Parameter	Type	Sample value	Description
FeatureGates	Object of KubeApiServerFeatureGates	-	The feature gates supported by kube-apiserver.
RequestTimeout	String	60s	The request timeout, which is the maximum duration the handler waits for the request to complete before terminating it. Unit: seconds.
AdmissionPlugins	Object of AdmissionPlugins	-	The list of admission control add-ons additionally enabled in kube-apiserver beyond those enabled by default.
DefaultNotReadyTolerationSeconds	Integer	300	The default toleration duration for Pods against the NotReady:NoExecute taint on nodes. Unit: seconds.
DefaultUnreachableTolerationSeconds	Integer	300	The default toleration duration of the Pod for the Unreachable:NoExecute taint on the node. Unit: seconds.

KubeApiServerFeatureGates

Parameter	Type	Sample value	Description
SidecarContainers	Boolean	true	Whether to enable the SidecarContainers feature gate to support native Sidecar containers. Valid values: true: Enable it. false: Disable it. An empty value indicates that this feature gate is determined by the default policy of kube-apiserver.
StatefulSetAutoDeletePVC	Boolean	true	Whether to enable the StatefulSetAutoDeletePVC feature gate to support automatic deletion of PVCs by StatefulSets. Valid values: true: Enable it. false: Disable it. An empty value indicates that this feature gate is determined by the default policy of kube-apiserver.
InPlacePodVerticalScaling	Boolean	true	Whether to enable the InPlacePodVerticalScaling feature gate, which supports in-place vertical scaling for Pods. Valid values: true: Enable it. false: Disable it. An empty value indicates that this feature gate is determined by the default policy of kube-apiserver.
MaxUnavailableStatefulSet	Boolean	true	Whether to enable the MaxUnavailableStatefulSet feature gate to add the maxUnavailable configuration for StatefulSet rolling updates. This allows multiple Pods to be unavailable and updated in parallel during updates. Valid values: true: Enable it. false: Disable it. An empty value indicates that this feature gate is determined by the default policy of kube-apiserver.

AdmissionPlugins

Parameter	Type	Sample value	Description
PodNodeSelector	Boolean	true	Whether to enable the PodNodeSelector admission control add-on. Valid values: true: Enable it. This indicates that a node selector is forcibly or by default attached to all Pods within the namespace. This schedules the Pods only onto nodes with specific labels. false: Disable it.
AlwaysPullImages	Boolean	true	Whether to enable the AlwaysPullImages admission control add-on. Valid values: true: Enable it. It indicates that the image is forcibly re-pulled when each Pod is modified. false: Disable it.
PodTolerationRestriction	Boolean	true	Whether to enable the PodTolerationRestriction admission control add-on. Valid values: true: Enable it. This uniformly manages Pod tolerations within a namespace to prevent the abuse of high-privilege taint tolerations. false: Disable it.

KubeSchedulerConfig

Parameter	Type	Sample value	Description
KubeApiQps	Integer	50	The QPS limit for communication between kube-scheduler and the API server.
Parallelism	Integer	16	The number of Goroutines that kube-scheduler executes in parallel when running the scheduling algorithm.
FeatureGates	Object of KubeSchedulerFeatureGates	-	The feature gate configuration for kube-scheduler.
KubeApiBurst	Integer	100	The maximum burst requests when kube-scheduler communicates with the API Server.
PodMaxBackoffSeconds	Integer	10	The maximum backoff delay for rescheduling pods in seconds. After a pod fails to be scheduled, the pod cannot be rescheduled until the delay ends.
PercentageOfNodesToScore	Integer	50	The evaluated proportion of nodes that can run Pods when Pods are being scheduled. Filtering stops after the specified proportion is reached. Unit: %.
PodInitialBackoffSeconds	Integer	1	The initial backoff time for unschedulable Pods. Unit: seconds.

KubeSchedulerFeatureGates

Parameter	Type	Sample value	Description
SidecarContainers	Boolean	true	Whether to enable the SidecarContainers feature gate to support native Sidecar containers. Valid values: true: Enable it. false: Disable it. An empty value indicates that this feature gate is determined by the default policy of kube-scheduler.
InPlacePodVerticalScaling	Boolean	true	Whether to enable the InPlacePodVerticalScaling feature gate, which supports in-place vertical scaling for Pods. Valid values: true: Enable it. false: Disable it. An empty value indicates that this feature gate is determined by the default policy of kube-scheduler.

KubeControllerManagerConfig

Parameter	Type	Sample value	Description
KubeApiQps	Integer	50	The QPS limit for communication between kube-controller-manager and the API server.
FeatureGates	Object of KubeControllerManagerFeatureGates	-	The feature gate configuration for kube-controller-manager.
KubeApiBurst	Integer	100	The maximum burst requests when kube-controller-manager communicates with the API Server.
NodeEvictionRate	Double	0.1	The Pod eviction rate in node failure scenarios, which controls the number of nodes from which Pods are evicted per second after a node failure when the region is in a healthy state.
NodeMonitorGracePeriod	Integer	50s	The duration after which a node is marked as NotReady or Unknown if it becomes unreachable. Unit: seconds.
UnhealthyZoneThreshold	Double	0.55	The unhealthy threshold for availability zones.
TerminatedPodGCThreshold	Integer	12500	The garbage collection threshold for terminated Pods, which is the maximum number of terminated Pods that can be retained.
LargeClusterSizeThreshold	Integer	50	The large cluster size threshold. The node controller uses this threshold to determine whether the cluster is a large-scale cluster, which determines the Pod eviction policy.
SecondaryNodeEvictionRate	Double	0.01	The secondary node draining rate. When the Region is unhealthy and nodes fail, this parameter specifies the number of nodes from which Pods are evicted per second.
ConcurrentTTLAfterFinishedSyncs	Integer	10	The number of concurrent synchronization goroutines of the TTLAfterFinished controller that is responsible for cleaning up expired Jobs.
HorizontalPodAutoscalerTolerance	Double	0.1	When Horizontal Pod Autoscaler (HPA) is used, if the deviation between the actual metric and the desired metric is less than this tolerance rate, scaling will not be triggered.
HorizontalPodAutoscalerSyncPeriod	String	15s	The period for the HPA to synchronize the number of Pods.
ConcurrentHorizontalPodAutoscalerSyncs	Integer	5	The number of HPA objects that can be concurrently synchronized. A larger value results in faster processing response for HPA objects, but consumes more CPU and network resources.

KubeControllerManagerFeatureGates

Parameter	Type	Sample value	Description
StatefulSetAutoDeletePVC	Boolean	true	Whether to enable the StatefulSetAutoDeletePVC feature gate to support automatic deletion of PVCs by StatefulSets. Valid values: true: Enable it. false: Disable it. An empty value indicates that this feature gate is determined by the default policy of kube-controller-manager.
InPlacePodVerticalScaling	Boolean	true	Whether to enable the InPlacePodVerticalScaling feature gate, which supports in-place vertical scaling for Pods. Valid values: true: Enable it. false: Disable it. An empty value indicates that this feature gate is determined by the default policy of kube-controller-manager.
MaxUnavailableStatefulSet	Boolean	true	Whether to enable the MaxUnavailableStatefulSet feature gate to add the maxUnavailable configuration for StatefulSet rolling updates. This allows multiple Pods to be unavailable and updated in parallel during updates. Valid values: true: Enable it. false: Disable it. An empty value indicates that this feature gate is determined by the default policy of kube-controller-manager.

ClusterMonitoringConfigResponse

Parameter	Type	Sample value	Description
WorkspaceId	String	6fxxx-5cxx-4********	The ID of the VMP workspace used for cluster monitoring.
ComponentConfigs	Array of ClusterMonitoringComponentConfigResponse	-	The configurations of the control plane monitoring for the managed cluster.
EnableMetricsExternalCollection	Boolean	false	Specify whether to enable external Prometheus to collect cluster control plane add-on metrics. Valid values: true: Enable it. false: Disable it.

ClusterMonitoringComponentConfigResponse

Parameter	Type	Sample value	Description
Name	String	KubeApiServer	The control plane add-on of the cluster that needs to be monitored. Valid values: KubeApiServer, KubeScheduler, Etcd, and ClusterAutoscaler.
Enabled	Boolean	true	Specify whether to enable control plane add-on monitoring. Valid values: true: Enable it. false: Disable it.

ClusterMaintenanceWindowConfigResponse

Parameter	Type	Sample value	Description
Duration	Integer	4	The duration of automatic O&M. Unit: hours.
StartTime	String	20:00:00Z	The time when automatic O&M starts.
TaskConfigs	Array of WindowTaskConfig	-	The configurations of the automatic O&M task.
WeeklyCycle	Array of String	["Monday","Tuesday"]	The O&M window cycle. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday
ExemptEndDate	String	20260704	The end time of the automatic O&M exemption window, which is in the format of YYYYMMDD, and applied based on calendar days in Beijing Time (UTC+8).
ExemptStartDate	String	20260702	The start time of the automatic O&M exemption window, which is in the format of YYYYMMDD, and applied based on calendar days in Beijing Time (UTC+8).

WindowTaskConfig

Parameter	Type	Sample value	Description
Group	String	Cluster	The group of automatic O&M tasks. Valid values: Cluster: Control plane O&M. Addon: Data plane O&M.
Action	String	AutoUpgradeAddonVersion	The automatic O&M task. Valid values: AutoUpgradeClusterMinorVersion: A task that automatically upgrades cluster patch versions. AutoUpgradeAddonVersion: A task that automatically upgrades add-on versions.
Targets	Array of String	["metrics-server","cluster-autoscaler"]	The add-on for which automatic version upgrade is performed.

RegisterClusterMonitoringConfigResponse

Parameter	Type	Sample value	Description
QueryUrl	String	http://query.prometheus-xx.xx.com/workspaces/caxx-8xxx-****	The query URL of the VMP workspace when you monitor a registered cluster by using VMP.
WorkspaceId	String	a72bxxxx-83xx-4axx********	The ID of the VMP workspace when you monitor a registered cluster by using VMP.
RemoteWriteUrl	String	http://write.prometheus-xxx.xx.com/workspaces/xxxx-8xxx-4exx-8xxx-1xxx/api/v1/write	The remote write URL of the VMP workspace when you monitor a registered cluster by using VMP.

Sample responses

Error code

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

Volcengine Kubernetes Engine