You need to enable JavaScript to run this app.
文档中心
容器服务

容器服务

复制全文
下载 pdf
集群管理
ListClusters - 获取集群列表
复制全文
下载 pdf
ListClusters - 获取集群列表
查询符合条件的集群详情列表。​
请求说明​
VKE 已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地域,选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://vke.cn-beijing.volcengineapi.com?Action=ListClusters&Version=2022-05-12​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
调用该 API 时的请求参数如下,除此之外还需传入公共请求参数。公共请求参数说明,请参见 公共参数。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
ListClusters​
接口名称。当前 API 的名称为 ListClusters。​
Version​
String​
是​
2022-05-12​
接口版本。当前 API 的版本为 2022-05-12。​
Filter​
Object of ListClustersFilter​
否​
-​
待查询集群的筛选条件。​
Tags​
Array of ListTagFilter​
否​
-​
基于标签查询集群列表。​
  • Tags 中各个 Key 不可重复。​
  • Tags 中的 Key、Value 不允许在最前或最后输入空格。​
  • 单次最多支持 10 个标签。​
PageNumber​
Integer​
否​
1​
分页查询时的起始页码,从 1 开始,默认为 1。​
PageSize​
Integer​
否​
10​
分页查询时每页显示的记录数,参数值说明:​
  • 最小值:1​
  • 最大值:100​
  • 默认值:10​
ProjectName​
String​
否​
default​
项目名称,即按照集群所属的项目筛选查询集群。​
​
ListClustersFilter​
​
参数​
类型​
是否必选​
示例值​
描述​
Ids​
Array of String​
否​
["cc9q8p******"]​
集群 ID 列表。​
单次最多填写 100 个 ID。​
说明​
此参数为空数组时,筛选您本账号下公共参数中指定地域的所有集群。​
Name​
String​
否​
TestCluster​
集群名称。支持模糊查询。​
DeleteProtectionEnabled​
Boolean​
否​
false​
集群删除保护,参数值说明:​
  • true:开启​
  • false:关闭​
PodsConfig.PodNetworkMode​
String​
否​
Flannel​
容器网络模型(Pod CNI),参数值说明:​
  • Flannel:Flannel 网络模型,独立的 Underlay 容器网络方案,配合 VPC 的全局路由能力,实现集群高性能的网络体验。​
  • VpcCniShared:VPC-CNI 网络模型,基于私有网络的弹性网卡 ENI 实现的 Underlay 容器网络方案。​
Statuses​
否​
-​
需要筛选的集群状态数组。​
数组各个元素间是逻辑「或」关系。单次最多填写 15 个状态数组元素。​
CreateClientToken​
String​
否​
BB928624-11C0-4856-******​
创建集群成功时的 ClientToken。​
ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。​
UpdateClientToken​
String​
否​
BB928624-11C0-4856-******​
最后一次更新集群成功时的 ClientToken。​
ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。​
Types​
Array of String​
否​
Managed​
集群类型,精确匹配,参数值说明:​
  • Managed:托管集群​
​
ClusterStatusFilter​
​
参数​
类型​
是否必选​
示例值​
描述​
Phase​
String​
否​
Creating​
集群状态,枚举值如下:​
  • Creating:创建中​
  • Running:运行中​
  • Updating:更新中​
  • Stopped:已停止​
  • Deleting:删除中​
  • Failed:异常​
说明​
Phase 和 Conditions.Type 两者至少有一个参数必填,否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合,请参见 资源状态说明。​
Conditions.Type​
String​
否​
Ok​
集群当前状态下的状态条件,枚举值如下:​
  • Ok: 正常​
  • CreateError: 创建失败​
  • Progressing: 处理中​
  • Balance: 欠费​
  • ResourceCleanupFailed: 删除失败​
  • Unknown: 未知错误​
  • UpdatingCluster:集群配置更新中​
  • SyncingAddon:组件变更中​
  • SyncingNodePool:节点池变更中​
  • ClusterVersionUpgrading:集群版本升级中​
说明​
Phase 和 Conditions.Type 两者至少有一个参数必填,否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合,请参见 资源状态说明。​
​
ListTagFilter​
​
参数​
类型​
是否必选​
示例值​
描述​
Key​
String​
是​
key​
标签键。​
  • 不能以任何大小写形式的volc:开头。​
  • 只能包含语言字符、数字、空格和特殊符号_ . : / = + - @。​
  • 长度限制为 1~128 个字符。​
Value​
String​
否​
value​
单个标签值,用于在同一个标签键下匹配一个候选值。​
  • 只能包含语言字符、数字、空格和特殊符号_ . : / = + - @。​
  • 长度不超过 256 个字符。​
  • 可以为空。​
说明​
与 Values 同时传入时,标签值合并为同一候选值集合进行匹配,不互斥、不去重。​
Values​
Array of String​
否​
["value1","value2"]​
标签值列表,用于在同一个标签键下匹配多个候选值。​
  • 每个标签值需满足如下条件:​
  • 只能包含语言字符、数字、空格和特殊符号_ . : / = + - @。​
  • 长度不超过 256 个字符。​
  • 多个标签值之间使用半角逗号(,)分隔。​
  • 可以为空。​
  • 传入参数值后,集群命中该列表中任意一个标签值均会被筛选。​
说明​
与 Value 同时传入时,标签值合并为同一候选值集合进行匹配,不互斥、不去重。​
​
请求示例​
​
POST https://vke.cn-beijing.volcengineapi.com?Action=ListClusters&Version=2022-05-12 HTTP/1.1​
Content-Type:application/json​
{​
"PageNumber": 1,​
"PageSize": 10,​
"Filter": {​
"Name": "test",​
"Ids": [​
"cc9q8pbfqtofn8j******"​
],​
"DeleteProtectionEnabled": true,​
"Statuses": [​
{​
"Phase": "Running"​
}​
]​
},​
"Tags": [​
{​
"Key": "key",​
"Value": "value"​
}​
]​
}​
​
返回参数​
本接口返回参数如下表所示,公共返回参数请参见 返回结果。​
​
参数​
类型​
示例值​
描述​
Items​
Array of ClusterResponse​
-​
集群的详细信息列表。​
PageNumber​
Integer​
1​
当前页码。​
PageSize​
Integer​
10​
每页显示的集群数。​
TotalCount​
Integer​
100​
符合条件的集群总数。​
​
ClusterResponse​
​
参数​
类型​
示例值​
描述​
Id​
String​
cc9q8p*******​
集群 ID。​
CreateClientToken​
String​
BC028527-33B9-4990-A633-******​
创建成功时的 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。​
UpdateClientToken​
String​
BC028527-33B9-4990-A633-******​
最后一次更新成功时 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。​
CreateTime​
String​
2022-05-06T02:49:19Z​
集群创建时间。​
标准 RFC3339 格式的 UTC+0 时间。​
UpdateTime​
String​
2022-05-15T03:13:20Z​
集群最近一次更新的时间。​
标准 RFC3339 格式的 UTC+0 时间。​
KubernetesVersion​
String​
v1.36.1-vke.2​
集群对应的 Kubernetes 版本信息。​
Name​
String​
TestCluster​
集群名称。​
Description​
String​
A Kubernetes Cluster Managed by VKE​
集群描述信息。​
Status​
Object of ClusterStatus​
-​
集群状态。​
DeleteProtectionEnabled​
Boolean​
false​
集群删除保护,参数值说明:​
  • true:已开启删除保护。​
  • false:已关闭删除保护。​
ClusterConfig​
-​
集群控制面及部分节点的网络配置。​
PodsConfig​
Object of PodsConfigResponse​
-​
Pod 的网络配置。​
ServicesConfig​
-​
服务的网络配置。​
NodeStatistics​
Object of NodeStatistics​
-​
集群中各主状态下对应的节点数量统计。​
Tags​
Array of TagResponse​
-​
集群绑定的标签信息。​
LoggingConfig​
-​
集群的日志配置信息。​
Type​
String​
-​
集群类型,参数值说明:​
  • Managed:托管集群​
IrsaConfig​
Object of IrsaConfigResponse​
-​
IRSA(IAM Role for Service Account)能力相关参数配置。​
ProjectName​
String​
default​
集群所属的项目。​
ConnectorConfig​
-​
【邀测·申请试用】注册集群的链接配置。​
说明​
注册集群目前处于 邀测 阶段。本文中 ConnectorConfig 及其相关子参数,在申请邀测权限并使用功能后才返回。​
KubernetesConfig​
-​
Kubernetes 相关参数设置。​
MonitoringConfig​
-​
托管集群的监控配置信息。​
MaintenanceWindowConfig​
-​
集群的运维配置信息。​
Message​
String​
CLB clb-rrgk**** deletion failed​
集群异常信息。​
RegisterMonitoringConfig​
-​
【邀测·申请试用】注册集群的监控配置信息。​
说明​
注册集群目前处于 邀测 阶段。本文中 RegisterMonitoringConfig 及其相关子参数,在申请邀测权限并使用功能后才返回。​
​
ClusterStatus​
​
参数​
类型​
示例值​
描述​
Phase​
String​
Creating​
集群的状态。参数值有:​
  • Creating:创建中​
  • Running:运行中​
  • Updating:更新中​
  • Stopped:已停止​
  • Deleting:删除中​
  • Failed:异常​
说明​
合法的 Phase 和 Conditions.Type 组合请参见 资源状态说明。​
Conditions​
-​
集群当前主状态下的状态条件,即进入该主状态的原因。​
​
ClusterStatusCondition​
​
参数​
类型​
示例值​
描述​
Type​
String​
Ok​
集群当前主状态下的状态条件,即进入该主状态的原因,可以有多个原因,参数值有:​
  • Ok: 正常​
  • CreateError: 创建失败​
  • Progressing: 处理中​
  • Balance: 欠费​
  • ResourceCleanupFailed: 删除失败​
  • Unknown: 未知错误​
  • UpdatingCluster:集群配置更新中​
  • SyncingAddon:组件变更中​
  • SyncingNodePool:节点池变更中​
  • ClusterVersionUpgrading:集群版本升级中​
说明​
合法的 Phase 和 Conditions.Type 组合请参见 资源状态说明。​
​
ClusterConfigResponse​
​
参数​
类型​
示例值​
描述​
VpcId​
String​
vpc-2d*******​
集群控制面及部分节点的网络所在的私有网络(VPC)ID。​
SubnetIds​
Array of String​
["subnet-2d73****"]​
集群控制面在私有网络内通信的子网 ID。​
SecurityGroupIds​
Array of String​
["sg-3re8ff****"]​
集群控制面及节点使用的安全组 ID 列表。​
ApiServerPublicAccessEnabled​
Boolean​
false​
集群 API Server 公网访问配置,参数值说明:​
  • false:未开启​
  • true:已开启​
ApiServerPublicAccessConfig​
-​
集群 API Server 公网访问配置信息。​
ApiServerPublicAccessEnable=true时才返回的参数。​
ResourcePublicAccessDefaultEnabled​
Boolean​
false​
节点公网访问配置,参数值说明:​
  • false:未开启​
  • true:已开启​
ApiServerEndpoints​
-​
集群 API Server 访问的 Endpoint 信息。​
IpFamily​
String​
Ipv4​
集群网络协议栈,参数值说明:​
  • Ipv4:Ipv4 单栈。​
ClusterLevel​
String​
Professional​
集群控制面规格,参数值说明:​
  • Professional:(默认值)专业版​
  • XL:预置控制面(XL)​
  • 2XL:预置控制面(2XL)​
  • 4XL:预置控制面(4XL)​
说明​
不同控制面规格的详细介绍,请参见 预置控制面。​
AutoUpgradeClusterLevel​
Boolean​
true​
是否开启自动升级集群预置控制面规格,参数值说明:​
  • false:不开启自动升级。​
  • true:开启自动升级。​
​
PublicAccessConfigResponse​
​
参数​
类型​
示例值​
描述​
AccessSourceIpsv4​
Array of String​
["0.0.0.0/0"]​
IPv4 的公网访问白名单。​
空值代表放通所有网络段(0.0.0.0/0)。​
PublicAccessNetworkConfig​
Object of EipConfigResponse​
-​
公网访问网络配置。​
ApiServerPublicAccessEnable=true时才返回的参数。​
​
EipConfigResponse​
​
参数​
类型​
示例值​
描述​
Isp​
String​
BGP​
公网 IP 的线路类型,参数值说明:​
BGP:BGP(多线)​
Bandwidth​
Integer​
100​
公网 IP 的带宽峰值,单位:Mbps。​
BillingType​
Integer​
3​
公网 IP 的计费类型:​
  • 2:按量计费-按带宽上限​
  • 3:按量计费-按实际流量​
BandwidthPackageId​
String​
bwp-2ze********​
共享带宽包的 ID,表示公网 IP 已加入到该共享带宽包。​
​
ClusterApiServerEndpointsResponse​
​
参数​
类型​
示例值​
描述​
PublicIp​
Object of Endpoint​
-​
集群 API Server 公网的 Endpoint 地址。​
PrivateIp​
Object of Endpoint​
-​
集群 API Server 私网的 Endpoint 地址。​
​
Endpoint​
​
参数​
类型​
示例值​
描述​
Ipv4​
String​
10.249.xx.xx​
Endpoint 的 IPv4 地址。​
​
PodsConfigResponse​
​
参数​
类型​
示例值​
描述​
PodNetworkMode​
String​
Flannel​
容器(Pod)网络模型(CNI),参数值说明:​
  • Flannel:Flannel 网络模型,独立的 Underlay 容器网络模型。​
  • VpcCniShared:VPC-CNI 网络模型,基于私有网络的弹性网卡 ENI 实现的 Underlay 容器网络模型。​
VpcCniConfig​
-​
VPC-CNI 网络配置。​
FlannelConfig​
-​
Flannel 网络配置。​
​
VpcCniConfigResponse​
​
参数​
类型​
示例值​
描述​
SubnetIds​
Array of String​
["subnet-5g39d****","subnet-5g39d****"]​
VPC-CNI 容器网络模型对应的 Pod 子网 ID 列表。​
VciSubnetIds​
Array of String​
["subnet-5g39****","subnet-5g39d****"]​
VPC-CNI 容器网络模型对应的 VCI Pod 子网 ID 列表。​
TrunkEniEnabled​
Boolean​
false​
【邀测·申请试用】Pod 主网卡是否支持 Trunk ENI,参数值说明:​
  • true:支持​
  • false:不支持​
  • 仅在PodNetworkMode=VpcCniShared时返回。​
​
FlannelConfigResponse​
​
参数​
类型​
示例值​
描述​
PodCidrs​
Array of String​
["172.168.xx/19"]​
Flannel 容器网络的 Pod CIDR。​
SubnetIds​
Array of String​
["subnet-5g39d****","subnet-5g39d****"]​
Flannel 容器网络模型对应的 Pod 子网 ID 列表。​
MaxPodsPerNode​
Integer​
64​
Flannel 容器网络的单节点 Pod 实例数量上限。​
​
ServicesConfigResponse​
​
参数​
类型​
示例值​
描述​
ServiceCidrsv4​
Array of String​
["172.25.xx/17"]​
Kubernetes 服务(Service)暴露的 IPv4 私有网络地址。​
​
NodeStatistics​
​
参数​
类型​
示例值​
描述​
TotalCount​
Integer​
8​
节点总数量。​
FailedCount​
Integer​
1​
Phase=Failed的节点总数量。​
RunningCount​
Integer​
1​
Phase=Running的节点总数量。​
CreatingCount​
Integer​
1​
Phase=Creating的节点总数量。​
DeletingCount​
Integer​
1​
Phase=Deleting的节点总数量。​
UpdatingCount​
Integer​
1​
Phase=Updating的节点总数量。​
​
TagResponse​
​
参数​
类型​
示例值​
描述​
Key​
String​
key​
标签键。​
Type​
String​
Custom​
标签类型,参数值说明:​
  • System: 系统标签​
  • Custom:用户自定义标签​
Value​
String​
value​
标签值。​
​
ClusterLoggingConfigResponse​
​
参数​
类型​
示例值​
描述​
LogSetups​
Array of LogSetupResponse​
-​
集群的日志选项信息。​
LogProjectId​
String​
d94b4eb4-********​
集群的日志项目(Log Project)ID。 如果为空,表示集群的日志项目未被创建。​
​
LogSetupResponse​
​
参数​
类型​
示例值​
描述​
LogTtl​
Integer​
30​
日志在日志服务中的保存时间,单位为天。 3650 天表示永久存储。​
Enabled​
Boolean​
false​
是否开启该日志选项,参数值说明:​
  • true:已开启​
  • false:未开启​
LogType​
String​
Audit​
当前开启的日志类型,参数值说明:​
  • Audit:集群审计日志​
  • KubeApiServer:kube-apiserver 组件日志​
  • KubeScheduler:kube-scheduler 组件日志​
  • KubeControllerManager:kube-controller-manager 组件日志​
LogTopicId​
String​
a72b4eba-********​
采集目标的 TLS 日志主题 ID。 如果为空,表示对应日志的主题未被创建。​
​
IrsaConfigResponse​
​
参数​
类型​
示例值​
描述​
Issuer​
String​
https://oidc-vke-region.tos-cn-region.volces.com/****​
OIDC(OpenID Connect)提供商 URL 地址,OIDC 提供商的唯一标识。​
Enabled​
Boolean​
false​
是否开启 IRSA 功能,参数值说明:​
  • true:开启​
  • false:不开启​
JwksUrl​
String​
https://oidc-vke-region.tos-cn-region.volces.com/****​
JWKS(JSON Web Key Set)的 URL。文件内的公钥被用来验证从 OIDC 提供者返回的任何 JWT(JSON Web Tokens)。​
OidcTrn​
String​
trn:iam::210****:oidc-provider/****​
OIDC 提供商 TRN。​
Audience​
String​
sts.volcengine.com​
接受令牌的标识符。​
OpenIdConfigUrl​
String​
https://oidc-vke-region.tos-cn-region.volces.com/cluster-id/****​
OIDC 提供商的 JSON 格式配置文档,包含了有关 OIDC 提供商的信息。​
​
ClusterConnectorConfigResponse​
​
参数​
类型​
示例值​
描述​
Type​
String​
Direct​
注册集群的链接类型,参数值说明:​
  • Direct:直连模式,基于目标集群 KubeConfig 的直连模式进行注册并管理。​
  • Proxy:代理模式,基于 Agent 的方式进行注册并管理。​
Provider​
String​
Vke​
注册集群的提供商,参数值说明:​
  • Ack:阿里云 ACK​
  • Tke:腾讯云 TKE​
  • Cce:华为云 CCE​
  • Gke:谷歌云 GKE​
  • Eks:亚马逊云 EKS​
  • BaiduCce:百度云 CCE​
  • None:自定义集群​
ProxyConfig​
Object of ProxyConfigResponse​
-​
注册集群的链接配置。​
​
ProxyConfigResponse​
​
参数​
类型​
示例值​
描述​
VpcId​
String​
vpc-2d7*******​
注册集群使用的私有网络 ID。​
SubnetIds​
Array of String​
["subnet-2d73mha****"]​
注册集群使用的子网 ID。​
AclEnabled​
Boolean​
true​
是否启用 ACL 白名单控制,参数值说明:​
  • false:未启用​
  • true:已启用​
AclIpWhitelist​
Array of String​
["192.168.1.0/24", "10.0.0.0/16"]​
监听器访问控制(ACL)白名单 IP 列表。​
仅在AclEnabled=true时返回。​
ApiServerEndpoints​
-​
注册集群 API Server 访问的 Endpoint 信息。​
ApiServerPublicAccessConfig​
-​
注册集群 API Server 公网访问配置信息。​
仅在ApiServerPublicAccessEnable=true时返回。​
ApiServerPublicAccessEnabled​
Boolean​
false​
是否开启注册集群 API Server 公网访问配置,参数值说明:​
  • false:未开启​
  • true:已开启​
​
ClusterKubernetesConfigResponse​
​
参数​
类型​
示例值​
描述​
CustomSans​
Array of String​
["abc.com","192.168.0.10"]​
自定义签发域名或 IP。​
ClusterDomain​
String​
cluster.local​
集群本地域名。​
AdvancedConfig​
Object of AdvancedConfig​
-​
kube-apiserver 增强配置。​
ControlPlaneConfig​
-​
Kubernetes 核心组件的自定义参数配置。​
​
AdvancedConfig​
​
参数​
类型​
示例值​
描述​
InternalDnsEnabled​
Boolean​
true​
是否为集群开启 API Server 私网域名访问,参数值说明:​
  • true:开启,节点侧组件通过私网域名访问 API Server。​
  • false:关闭。​
​
KubernetesComponentConfigs​
​
参数​
类型​
示例值​
描述​
KubeApiServerConfig​
Object of KubeApiServerConfig​
-​
kube-apiserver 组件的自定义参数配置。​
KubeSchedulerConfig​
Object of KubeSchedulerConfig​
-​
kube-scheduler 组件的自定义参数配置。​
KubeControllerManagerConfig​
-​
kube-controller-manager 组件的自定义参数配置。​
​
KubeApiServerConfig​
​
参数​
类型​
示例值​
描述​
FeatureGates​
-​
kube-apiserver 支持的特性开关。​
GoawayChance​
Double​
0.01​
配置 kube-apiserver 随机结束 HTTP/2 长连接的概率。​
RequestTimeout​
String​
60s​
请求超时时间,即处理程序保持请求打开的最长时间。单位为秒。​
AdmissionPlugins​
Object of AdmissionPlugins​
-​
kube-apiserver 中除默认启用的准入控制插件之外,额外启用的准入控制插件列表。​
DefaultNotReadyTolerationSeconds​
Integer​
300​
Pod 对节点NotReady:NoExecute污点的默认容忍时长。单位为秒。​
DefaultUnreachableTolerationSeconds​
Integer​
300​
Pod 对节点Unreachable:NoExecute污点的默认容忍时长。单位为秒。​
​
KubeApiServerFeatureGates​
​
参数​
类型​
示例值​
描述​
SidecarContainers​
Boolean​
true​
是否开启 SidecarContainers 特性开关,支持原生 Sidecar 容器。参数值说明:​
  • true:开启​
  • false:关闭​
  • 空值,表示该特性门控由 kube-apiserver 自身的默认策略决定。​
StatefulSetAutoDeletePVC​
Boolean​
true​
是否开启 StatefulSetAutoDeletePVC 特性开关,支持 StatefulSet 自动删除 PVC。参数值说明:​
  • true:开启​
  • false:关闭​
  • 空值,表示该特性门控由 kube-apiserver 自身的默认策略决定。​
InPlacePodVerticalScaling​
Boolean​
true​
是否开启 InPlacePodVerticalScaling 特性开关,支持 Pod 原地垂直伸缩。参数值说明:​
  • true:开启​
  • false:关闭​
  • 空值,表示该特性门控由 kube-apiserver 自身的默认策略决定。​
MaxUnavailableStatefulSet​
Boolean​
true​
是否开启 MaxUnavailableStatefulSet 特性开关,支持为 StatefulSet 的滚动更新增加maxUnavailable配置,允许更新时同时让多个 Pod 处于不可用状态并行更新。参数值说明:​
  • true:开启​
  • false:关闭​
  • 空值,表示该特性门控由 kube-apiserver 自身的默认策略决定。​
​
AdmissionPlugins​
​
参数​
类型​
示例值​
描述​
PodNodeSelector​
Boolean​
true​
是否启用 PodNodeSelector 准入控制插件。参数值说明:​
  • true:启用,表示强制/默认给 Namespace 内所有 Pod 附加节点选择器,限制只能调度到特定标签的节点。​
  • false:不启用。​
AlwaysPullImages​
Boolean​
true​
是否启用 AlwaysPullImages 准入控制插件。参数值说明:​
  • true:启用,表示修改每个 Pod 的时候都强制重新拉取镜像。​
  • false:不启用。​
PodTolerationRestriction​
Boolean​
true​
是否启用 PodTolerationRestriction 准入控制插件。参数值说明:​
  • true:启用,表示统一管理 Namespace 内 Pod 的 Tolerations,防止滥用高权限污点容忍​
  • false:不启用。​
​
KubeSchedulerConfig​
​
参数​
类型​
示例值​
描述​
KubeApiQps​
Integer​
50​
kube-scheduler 与 APIServer 通信的 QPS 限制。​
Parallelism​
Integer​
16​
kube-scheduler 在执行调度算法时同时并行执行的 Goroutine 数量。​
FeatureGates​
-​
kube-scheduler 的特性门控配置。​
KubeApiBurst​
Integer​
100​
kube-scheduler 与 APIServer 通信时的突发请求上限。​
PodMaxBackoffSeconds​
Integer​
10​
Pod 调度失败后最大回退秒数,两次调度间隔不会低于当前回退秒数。​
PercentageOfNodesToScore​
Integer​
50​
调度 Pod 时评估的可运行节点比例,找到指定比例的节点后停止筛选。单位为 %。​
PodInitialBackoffSeconds​
Integer​
1​
为无法调度的 Pod 设置初始退避时间。单位为秒。​
​
KubeSchedulerFeatureGates​
​
参数​
类型​
示例值​
描述​
SidecarContainers​
Boolean​
true​
是否开启 SidecarContainers 特性开关,支持原生 Sidecar 容器。参数值说明:​
  • true:开启​
  • false:关闭​
  • 空值,表示该特性门控由 kube-scheduler 自身的默认策略决定。​
InPlacePodVerticalScaling​
Boolean​
true​
是否开启 InPlacePodVerticalScaling 特性开关,支持 Pod 原地垂直伸缩。参数值说明:​
  • true:开启​
  • false:关闭​
  • 空值,表示该特性门控由 kube-scheduler 自身的默认策略决定。​
​
KubeControllerManagerConfig​
​
参数​
类型​
示例值​
描述​
KubeApiQps​
Integer​
50​
kube-controller-manager 与 APIServer 通信的 QPS 限制。​
FeatureGates​
-​
kube-controller-manager 的特性门控配置。​
KubeApiBurst​
Integer​
100​
kube-controller-manager 与 APIServer 通信时的突发请求上限。​
NodeEvictionRate​
Double​
0.1​
节点故障场景下的 Pod 驱逐速率,用于控制在 Region 处于健康状态时,节点发生故障后,每秒驱逐 Pod 的节点数。​
ConcurrentJobSyncs​
Integer​
5​
Job 控制器可同时处理的 Job 数量。​
ConcurrentCronJobSyncs​
Integer​
5​
CronJob 控制器可同时处理的 CronJob 数量。​
NodeMonitorGracePeriod​
Integer​
50s​
节点失联后,被标记为NotReady或Unknown的时间。单位为秒。​
NodeStartupGracePeriod​
String​
1m​
节点控制器等待新节点上报健康状态的宽限时长。​
UnhealthyZoneThreshold​
Double​
0.55​
可用区的不健康阈值。​
ResourceQuotaSyncPeriod​
String​
5m​
ResourceQuota 控制器重新计算资源配额使用量的周期。​
TerminatedPodGCThreshold​
Integer​
12500​
Terminated Pod 垃圾回收阈值,即可保留的 Terminated Pod 最大数量。​
LargeClusterSizeThreshold​
Integer​
50​
集群的大规模阈值,节点控制器根据此阈值判断集群是否为大规模集群,以决定 Pod 驱逐策略。​
SecondaryNodeEvictionRate​
Double​
0.01​
第二档的排空节点速率。当 Region 不健康且节点失效时,每秒从此参数指定数量的节点上驱逐 Pod。​
EndpointUpdatesBatchPeriod​
String​
0s​
Endpoints 控制器批量合并端点变更的等待时长。​
ConcurrentResourceQuotaSyncs​
Integer​
5​
ResourceQuota 控制器可同时重新计算的资源配额数量。​
ConcurrentEphemeralVolumeSyncs​
Integer​
5​
临时卷控制器可同时处理的通用临时卷数量。​
ConcurrentTTLAfterFinishedSyncs​
Integer​
10​
负责清理过期 Job 的 TTLAfterFinished 控制器的并发同步协程数。​
EndpointSliceUpdatesBatchPeriod​
String​
0s​
EndpointSlice 控制器批量合并端点变更的等待时长。​
HorizontalPodAutoscalerTolerance​
Double​
0.1​
Pod 水平自动扩缩容(HPA)时,若实际指标与期望指标的偏差小于此容差率,则不会触发扩缩容。​
HorizontalPodAutoscalerSyncPeriod​
String​
15s​
HPA 同步 Pod 数量的周期。​
ConcurrentServiceAccountTokenSyncs​
Integer​
5​
ServiceAccount Token 控制器可同时处理的服务账号令牌数量。​
ConcurrentHorizontalPodAutoscalerSyncs​
Integer​
5​
允许并发同步的 HPA 对象数量。数值越大,HPA 对象处理响应越快,但会占用更多 CPU 及网络资源。​
HorizontalPodAutoscalerInitialReadinessDelay​
String​
30s​
HPA 将尚未稳定就绪的 Pod 视为初始化状态的时长。​
HorizontalPodAutoscalerDownscaleStabilization​
String​
5m​
HPA 缩容时回看历史期望副本数的时长。​
HorizontalPodAutoscalerCpuInitializationPeriod​
String​
5m​
HPA 忽略 Pod 启动初期 CPU 指标的时长。​
​
KubeControllerManagerFeatureGates​
​
参数​
类型​
示例值​
描述​
StatefulSetAutoDeletePVC​
Boolean​
true​
是否开启 StatefulSetAutoDeletePVC 特性开关,支持 StatefulSet 自动删除 PVC。参数值说明:​
  • true:开启​
  • false:关闭​
  • 空值,表示该特性门控由 kube-controller-manager 自身的默认策略决定。​
InPlacePodVerticalScaling​
Boolean​
true​
是否开启 InPlacePodVerticalScaling 特性开关,支持 Pod 原地垂直伸缩。参数值说明:​
  • true:开启​
  • false:关闭​
  • 空值,表示该特性门控由 kube-controller-manager 自身的默认策略决定。​
MaxUnavailableStatefulSet​
Boolean​
true​
是否开启 MaxUnavailableStatefulSet 特性开关,支持为 StatefulSet 的滚动更新增加maxUnavailable配置,允许更新时同时让多个 Pod 处于不可用状态并行更新。参数值说明:​
  • true:开启​
  • false:关闭​
  • 空值,表示该特性门控由 kube-controller-manager 自身的默认策略决定。​
​
ClusterMonitoringConfigResponse​
​
参数​
类型​
示例值​
描述​
WorkspaceId​
String​
6fxxx-5cxx-4********​
集群监控使用的托管 Prometheus 工作区 ID。​
ComponentConfigs​
-​
托管集群控制面监控配置。​
EnableMetricsExternalCollection​
Boolean​
false​
是否开启控制面指标采集,参数值说明:​
  • true:开启​
  • false:关闭。​
​
ClusterMonitoringComponentConfigResponse​
​
参数​
类型​
示例值​
描述​
Name​
String​
KubeApiServer​
需要监控的集群控制面组件,包括:KubeApiServer、KubeScheduler、Etcd 和 ClusterAutoscaler。​
Enabled​
Boolean​
true​
是否开启控制面组件监控,参数值说明:​
  • true:开启。​
  • false:关闭。​
​
ClusterMaintenanceWindowConfigResponse​
​
参数​
类型​
示例值​
描述​
Duration​
Integer​
4​
自动运维的持续时长,单位为小时。​
StartTime​
String​
20:00:00Z​
自动运维的开始时间。​
TaskConfigs​
Array of WindowTaskConfig​
-​
自动运维任务配置。​
WeeklyCycle​
Array of String​
["Monday","Tuesday"]​
运维窗口周期,参数值说明:​
  • Monday:周一​
  • Tuesday:周二​
  • Wednesday:周三​
  • Thursday:周四​
  • Friday:周五​
  • Saturday:周六​
  • Sunday:周日​
ExemptEndDate​
String​
20260704​
自动运维豁免窗口的结束时间,格式为YYYYMMDD,按北京时间(UTC +8)自然日执行。​
ExemptStartDate​
String​
20260702​
自动运维豁免窗口的开始时间,格式为YYYYMMDD,按北京时间(UTC +8)自然日执行。​
​
WindowTaskConfig​
​
参数​
类型​
示例值​
描述​
Group​
String​
Cluster​
自动运维任务的分组,参数值说明:​
  • Cluster:控制面运维。​
  • Addon:数据面运维。​
Action​
String​
AutoUpgradeAddonVersion​
自动运维任务,参数值说明:​
  • AutoUpgradeClusterMinorVersion:集群补丁版本自动升级任务。​
  • AutoUpgradeAddonVersion:组件版本自动升级任务。​
Targets​
Array of String​
["metrics-server","cluster-autoscaler"]​
进行版本自动升级的组件。​
​
RegisterClusterMonitoringConfigResponse​
​
参数​
类型​
示例值​
描述​
QueryUrl​
String​
http://query.prometheus-xx.xx.com/workspaces/caxx-8xxx-****​
注册集群使用托管 Prometheus(VMP)进行监控时,VMP 工作区的 Query 地址。​
WorkspaceId​
String​
a72bxxxx-83xx-4axx********​
注册集群使用 VMP 进行监控时,VMP 工作区的 ID。​
RemoteWriteUrl​
String​
http://write.prometheus-xxx.xx.com/workspaces/xxxx-8xxx-4exx-8xxx-1xxx/api/v1/write​
注册集群使用 VMP 进行监控时,VMP 工作区的 RemoteWrite 地址。​
​
返回示例​
​
HTTP/1.1 200 OK​
​
Content-Type:application/json​
{​
"ResponseMetadata": {​
"RequestId": "2022051511********",​
"Action": "ListClusters",​
"Version": "2022-05-12",​
"Service": "vke",​
"Region": "cn-beijing"​
},​
"Result": {​
"TotalCount": 1,​
"PageNumber": 1,​
"PageSize": 10,​
"Items": [​
{​
"Id": "cc9q8****",​
"ClientToken": "",​
"CreateTime": "2022-05-06T02:49:19Z",​
"UpdateTime": "2022-05-15T03:13:20Z",​
"KubernetesVersion": "v1.36.1-vke.2",​
"Name": "test",​
"Description": "",​
"Status": {​
"Phase": "Running",​
"Conditions": [​
{​
"Type": "Ok"​
}​
]​
},​
"DeleteProtectionEnabled": true,​
"ClusterConfig": {​
"VpcId": "vpc-2d73ui********",​
"SubnetIds": [​
"subnet-2d73ao****"​
],​
"SecurityGroupIds": [​
"sg-3re8ffwj****"​
],​
"ApiServerPublicAccessEnabled": true,​
"ApiServerPublicAccessConfig": {​
"PublicAccessNetworkConfig": {​
"BillingType": 2,​
"Bandwidth": 1,​
"Isp": "BGP"​
}​
},​
"ResourcePublicAccessDefaultEnabled": false,​
"ApiServerEndpoints": {​
"PrivateIp": {​
"Ipv4": "192.168.**.**"​
},​
"PublicIp": {​
"Ipv4": "10.249.**.**"​
}​
}​
},​
"PodsConfig": {​
"PodNetworkMode": "Flannel",​
"FlannelConfig": {​
"PodCidrs": [​
"172.18.**.**/20"​
],​
"MaxPodsPerNode": 64​
}​
},​
"ServicesConfig": {​
"ServiceCidrsv4": [​
"172.23.**.**/21"​
]​
},​
"NodeStatistics": {​
"TotalCount": 3,​
"CreatingCount": 0,​
"RunningCount": 3,​
"UpdatingCount": 0,​
"DeletingCount": 0,​
"FailedCount": 0​
},​
"ChargeType": "PostPaid",​
"Tags": [​
{​
"Key": "key",​
"Value": "value",​
"Type": "Custom"​
}​
],​
"LoggingConfig": {​
"LogProjectId": "b68324a0-2680-48c7********",​
"LogSetups": [​
{​
"LogType": "Audit",​
"LogTopicId": "d94b4eb4-1108-4931********",​
"LogTtl": 30,​
"Enabled": true​
}​
]​
}​
}​
]​
}​
}​
​
​
HTTP/1.1 200 OK​
​
Content-Type:application/json​
{​
"ResponseMetadata": {​
"RequestId": "2022051511********",​
"Action": "ListClusters",​
"Version": "2022-05-12",​
"Service": "vke",​
"Region": "cn-beijing"​
},​
"Result": {​
"TotalCount": 1,​
"PageNumber": 1,​
"PageSize": 10,​
"Items": [​
{​
"Id": "ccegi********",​
"KubernetesVersion": "v1.36.1-vke.2",​
"Name": "vpc-cni-test",​
"Description": "",​
"Status": {​
"Phase": "Running",​
"Conditions": [​
{​
"Type": "Ok"​
}​
]​
},​
"DeleteProtectionEnabled": false,​
"ClusterConfig": {​
"VpcId": "vpc-2bztfy****",​
"SubnetIds": [​
"subnet-2d74k****"​
],​
"SecurityGroupIds": [​
"sg-3re9w****"​
],​
"ApiServerPublicAccessEnabled": true,​
"ApiServerPublicAccessConfig": {​
"PublicAccessNetworkConfig": {​
"BillingType": 3,​
"Bandwidth": 10,​
"Isp": "BGP"​
}​
},​
"ResourcePublicAccessDefaultEnabled": false,​
"ApiServerEndpoints": {​
"PrivateIp": {​
"Ipv4": "192.168.**.**"​
},​
"PublicIp": {​
"Ipv4": "10.249.**.**"​
}​
}​
},​
"PodsConfig": {​
"PodNetworkMode": "VpcCniShared",​
"VpcCniConfig": {​
"SubnetIds": [​
"subnet-2d74kxgqc******"​
],​
"VciSubnetIds": [​
"subnet-df4dgxgqc******"​
]​
}​
},​
"ServicesConfig": {​
"ServiceCidrsv4": [​
"172.26.**.**/21"​
]​
},​
"NodeStatistics": {​
"TotalCount": 2,​
"CreatingCount": 0,​
"RunningCount": 0,​
"UpdatingCount": 0,​
"DeletingCount": 0,​
"FailedCount": 2​
},​
"ChargeType": "PostPaid",​
"CreateTime": "2022-12-20T03:29:24Z",​
"UpdateTime": "2022-12-20T03:37:43Z",​
"CreateClientToken": "1852d931f34-460249325618****",​
"UpdateClientToken": "",​
"Tags": [],​
"LoggingConfig": {​
"LogProjectId": "b68324a0-2680-48c7********",​
"LogSetups": [​
{​
"LogType": "Audit",​
"LogTopicId": "d94b4eb4-1108-4931********",​
"LogTtl": 30,​
"Enabled": true​
}​
]​
}​
}​
]​
}​
}​
​
错误码​
本接口无专有错误码,公共错误码请参见 公共错误码。​
​
最近更新时间:2026.11.02 21:16:24
这个页面对您有帮助吗?
有用
有用
无用
无用