查询符合条件的集群详情列表。 ## 请求说明 VKE 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 [服务地址](https://www.volcengine.com/docs/6460/1899855) 文档，根据业务所在地域，选择最合适的接入点。 * 请求方式：POST * 请求地址：https://vke.cn\-beijing.volcengineapi.com?Action=ListClusters&Version=2022\-05\-12 ## 调试 ## 请求参数调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见 [公共参数](https://www.volcengine.com/docs/6460/70904)。 |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |ListClusters |接口名称。当前 API 的名称为 `ListClusters`。 | |Version |String |是 |2022\-05\-12 |接口版本。当前 API 的版本为 `2022-05-12`。 | |Filter |Object of [ListClustersFilter](#listclustersfilter) |否 |\- |待查询集群的筛选条件。 | |Tags |Array of [ListTagFilter](#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 |否 |["cc9q8pbfqtofn8j\*\*\*\*\*\*"] |集群 ID 列表。|\ | | | | |单次最多填写 100 个 ID。|\ | | | | |:::tip|\ | | | | |此参数为空数组时，筛选您本账号下公共参数中指定地域的所有集群。|\ | | | | ||\ | | | | |:::| |Name |String |否 |TestCluster |集群名称。支持模糊查询。 | |DeleteProtectionEnabled |Boolean |否 |false |集群删除保护，取值：|\ | | | | ||\ | | | | |* **true**：开启|\ | | | | |* **false**：关闭 | |PodsConfig.PodNetworkMode |String |否 |Flannel |容器网络模型（Pod CNI），取值：|\ | | | | ||\ | | | | |* **Flannel**：Flannel 网络模型，独立的 Underlay 容器网络方案，配合 VPC 的全局路由能力，实现集群高性能的网络体验。|\ | | | | |* **VpcCniShared**：VPC\-CNI 网络模型，基于私有网络的弹性网卡 ENI 实现的 Underlay 容器网络方案。 | |Statuses |Array of [ClusterStatusFilter](#clusterstatusfilter) |否 |\- |需要筛选的集群状态数组。|\ | | | | |数组各个元素间是逻辑「或」关系。单次最多填写 15 个状态数组元素。 | |CreateClientToken |String |否 |BB928624\-11C0\-4856\-A233\-84F9F9\*\*\*\*\*\* |创建集群成功时的 ClientToken。|\ | | | | |ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。 | |UpdateClientToken |String |否 |BB928624\-11C0\-4856\-A233\-84F9F9\*\*\*\*\*\* |最后一次更新集群成功时的 ClientToken。|\ | | | | |ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。 | |Types |Array of String |否 |Managed |集群类型，精确匹配，取值：|\ | | | | ||\ | | | | |* **Managed**：托管集群|\ | | | | |* **Registered**：【[邀测·申请试用](https://www.volcengine.com/docs/6460/145623)】注册集群 | ### ClusterStatusFilter |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Phase |String |否 |Creating |集群状态，枚举值如下：|\ | | | | ||\ | | | | |* **Creating**：创建中|\ | | | | |* **Running**：运行中|\ | | | | |* **Updating**：更新中|\ | | | | |* **Stopped**：已停止|\ | | | | |* **Deleting**：删除中|\ | | | | |* **Failed**：异常|\ | | | | ||\ | | | | |:::tip|\ | | | | |Phase 和 Conditions.Type 两者至少有一个参数必填，否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合，请参见 [资源状态说明](https://www.volcengine.com/docs/6460/118979)。|\ | | | | ||\ | | | | |:::| |Conditions.Type |String |否 |Ok |集群当前状态下的状态条件，枚举值如下：|\ | | | | ||\ | | | | |* **Ok**: 正常|\ | | | | |* **CreateError**: 创建失败|\ | | | | |* **Progressing**: 处理中|\ | | | | |* **Balance**: 欠费|\ | | | | |* **ResourceCleanupFailed**: 删除失败|\ | | | | |* **Unknown**: 未知错误|\ | | | | |* **UpdatingCluster**：集群配置更新中|\ | | | | |* **SyncingAddon**：组件变更中|\ | | | | |* **SyncingNode**：节点变更中|\ | | | | |* **SyncingNodePool**：节点池变更中|\ | | | | ||\ | | | | |:::tip|\ | | | | |Phase 和 Conditions.Type 两者至少有一个参数必填，否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合，请参见 [资源状态说明](https://www.volcengine.com/docs/6460/118979)。|\ | | | | ||\ | | | | |:::| ### ListTagFilter |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Key |String |是 |key |标签键。|\ | | | | ||\ | | | | |* 不能以任何大小写形式的volc:开头。|\ | | | | |* 只能包含语言字符、数字、空格和特殊符号`_ . : / = + - @`。|\ | | | | |* 长度限制为 1～128 个字符。 | |Value |String |否 |value |标签值，可以为空。|\ | | | | ||\ | | | | |* 只能包含语言字符、数字、空格和特殊符号`_ . : / = + - @`。|\ | | | | |* 长度不超过 256 个字符。 | ## 请求示例 ```JSON POST /?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" } ] } ``` ## 返回参数本接口返回参数如下表所示，公共返回参数请参见 [返回结果](https://www.volcengine.com/docs/6460/79674)。 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Items |Array of [ClusterResponse](#clusterresponse) |\- |集群的详细信息列表。 | |PageNumber |Integer |1 |当前页码。 | |PageSize |Integer |10 |每页显示的集群数。 | |TotalCount |Integer |100 |符合条件的集群总数。 | ### ClusterResponse |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Id |String |cc9q8pbfqtofn\*\*\*\*\*\* |集群 ID。 | |CreateClientToken |String |BC028527\-33B9\-4990\-A633\-84E9F9\*\*\*\*\*\* |创建成功时的 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。 | |UpdateClientToken |String |BC028527\-33B9\-4990\-A633\-84E9F9\*\*\*\*\*\* |最后一次更新成功时 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。 | |CreateTime |String |2022\-05\-06T02:49:19Z |集群创建时间。|\ | | | |标准 [RFC3339](https://tools.ietf.org/html/rfc3339)格式的 UTC+0 时间。 | |UpdateTime |String |2022\-05\-15T03:13:20Z |集群最近一次更新的时间。|\ | | | |标准 [RFC3339](https://tools.ietf.org/html/rfc3339)格式的 UTC+0 时间。 | |KubernetesVersion |String |v1.20.10\-vke.2 |集群对应的 Kubernetes 版本信息。 | |Name |String |TestCluster |集群名称。 | |Description |String |A Kubernetes Cluster Managed by VKE |集群描述信息。 | |Status |Object of [ClusterStatus](#clusterstatus) |\- |集群状态。 | |DeleteProtectionEnabled |Boolean |false |集群删除保护，参数值说明：|\ | | | ||\ | | | |* **true**：已开启删除保护。|\ | | | |* **false**：已关闭删除保护。 | |ClusterConfig |Object of [ClusterConfigResponse](#clusterconfigresponse) |\- |集群控制面及部分节点的网络配置。 | |PodsConfig |Object of [PodsConfigResponse](#podsconfigresponse) |\- |Pod 的网络配置。 | |ServicesConfig |Object of [ServicesConfigResponse](#servicesconfigresponse) |\- |服务的网络配置。 | |NodeStatistics |Object of [NodeStatistics](#nodestatistics) |\- |集群中各主状态下对应的节点数量统计。 | |Tags |Array of [TagResponse](#tagresponse) |\- |集群绑定的标签信息。 | |LoggingConfig |Object of [ClusterLoggingConfigResponse](#clusterloggingconfigresponse) |\- |集群的日志配置信息。 | |Type |String |\- |集群类型，参数值说明：|\ | | | ||\ | | | |* **Managed**：托管集群|\ | | | |* **Registered**：【[邀测·申请试用](https://www.volcengine.com/docs/6460/145623)】注册集群 | |IrsaConfig |Object of [IrsaConfigResponse](#irsaconfigresponse) |\- |IRSA（IAM Role for Service Account）能力相关参数配置。 | |ProjectName |String |default |集群所属的项目。 | |ConnectorConfig |Object of [ClusterConnectorConfigResponse](#clusterconnectorconfigresponse) |\- |【[邀测·申请试用](https://www.volcengine.com/docs/6460/145623)】注册集群的链接配置。|\ | | | |:::tip|\ | | | |注册集群目前处于 **邀测** 阶段。本文中 **ConnectorConfig**及其相关子参数，在申请邀测权限并使用功能后才返回。|\ | | | ||\ | | | |:::| |MonitoringConfig |Object of [ClusterMonitoringConfigResponse](#clustermonitoringconfigresponse) |\- |托管集群的监控配置信息。 | |Message |String |CLB clb\-rrgk\*\*\*\* deletion failed |集群异常信息。 | |RegisterMonitoringConfig |Object of [RegisterClusterMonitoringConfigResponse](#registerclustermonitoringconfigresponse) | |【[邀测·申请试用](https://www.volcengine.com/docs/6460/145623)】注册集群的监控配置信息。|\ | | | |:::tip|\ | | | |注册集群目前处于 **邀测** 阶段。本文中 **RegisterMonitoringConfig**及其相关子参数，在申请邀测权限并使用功能后才返回。|\ | | | ||\ | | | |:::| ### ClusterStatus |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Phase |String |Creating |集群的状态。参数值有：|\ | | | ||\ | | | |* **Creating**：创建中|\ | | | |* **Running**：运行中|\ | | | |* **Updating**：更新中|\ | | | |* **Stopped**：已停止|\ | | | |* **Deleting**：删除中|\ | | | |* **Failed**：异常|\ | | | ||\ | | | |:::tip|\ | | | |合法的 **Phase** 和 **Conditions.Type** 组合请参见 [资源状态说明](https://www.volcengine.com/docs/6460/118979)。|\ | | | ||\ | | | |:::| |Conditions |Array of [ClusterStatusCondition](#clusterstatuscondition) | |集群当前主状态下的状态条件，即进入该主状态的原因。 | ### ClusterStatusCondition |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Type |String |Ok |集群当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，参数值有：|\ | | | ||\ | | | |* **Ok**: 正常|\ | | | |* **CreateError**: 创建失败|\ | | | |* **Progressing**: 处理中|\ | | | |* **Balance**: 欠费|\ | | | |* **ResourceCleanupFailed**: 删除失败|\ | | | |* **Unknown**: 未知错误|\ | | | |* **UpdatingCluster**：集群配置更新中|\ | | | |* **SyncingAddon**：组件变更中|\ | | | |* **SyncingNode**：节点变更中|\ | | | |* **SyncingNodePool**：节点池变更中|\ | | | ||\ | | | |:::tip|\ | | | |合法的 **Phase** 和 **Conditions.Type** 组合请参见 [资源状态说明](https://www.volcengine.com/docs/6460/118979)。|\ | | | ||\ | | | |:::| ### ClusterConfigResponse |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |VpcId |String |vpc\-2d7ds\*\*\*\* |集群控制面及部分节点的网络所在的私有网络（VPC）ID。 | |SubnetIds |Array of String |["subnet\-2d73\*\*\*\*"] |集群控制面在私有网络内通信的子网 ID。 | |SecurityGroupIds |Array of String |["sg\-3re8ff\*\*\*\*"] |集群控制面及节点使用的的安全组。 | |ApiServerPublicAccessEnabled |Boolean |false |集群 API Server 公网访问配置，参数值说明：|\ | | | ||\ | | | |* **false**：未开启|\ | | | |* **true**：已开启 | |ApiServerPublicAccessConfig |Object of [PublicAccessConfigResponse](#publicaccessconfigresponse) |\- |集群 API Server 公网访问配置信息。|\ | | | |`ApiServerPublicAccessEnable=true`时才返回的参数。 | |ResourcePublicAccessDefaultEnabled |Boolean |false |节点公网访问配置，参数值说明：|\ | | | ||\ | | | |* **false**：未开启|\ | | | |* **true**：已开启 | |ApiServerEndpoints |Object of [ClusterApiServerEndpointsResponse](#clusterapiserverendpointsresponse) |\- |集群 API Server 访问的 Endpoint 信息。 | |IpFamily |String |Ipv4 |集群网络协议栈，参数值说明：|\ | | | ||\ | | | |* **Ipv4**：Ipv4 单栈。|\ | | | |* **Ipv6**：Ipv6 单栈。|\ | | | |* **DualStack**：Ipv4 和 Ipv6 双栈。 | ### PublicAccessConfigResponse |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |AccessSourceIpsv4 |Array of String |["0.0.0.0/0"] |IPv4 的公网访问白名单。|\ | | | |空值代表放通所有网络段（`0.0.0.0/0`）。 | |PublicAccessNetworkConfig |Object of [EipConfigResponse](#eipconfigresponse) |\- |公网访问网络配置。|\ | | | |`ApiServerPublicAccessEnable=true`时才返回的参数。 | ### EipConfigResponse |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Isp |String |BGP |公网 IP 的线路类型，参数值说明：|\ | | | |**BGP**：BGP（多线）。 | |Bandwidth |Integer |100 |公网 IP 的带宽峰值，单位：Mbps。 | |BillingType |Integer |3 |公网 IP 的计费类型：|\ | | | ||\ | | | |* **2**：按量计费\-按带宽上限|\ | | | |* **3**：按量计费\-按实际流量 | ### ClusterApiServerEndpointsResponse |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |PublicIp |Object of [Endpoint](#endpoint) |\- |集群 API Server 公网的 Endpoint 地址。 | |PrivateIp |Object of [Endpoint](#endpoint) |\- |集群 API Server 私网的 Endpoint 地址。 | ### Endpoint |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Ipv4 |String |10.249.xx.xx |Endpoint 的 IPv4 地址。 | ### PodsConfigResponse |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |VpcCniConfig |Object of [VpcCniConfigResponse](#vpccniconfigresponse) |\- |VPC\-CNI 网络配置。 | |FlannelConfig |Object of [FlannelConfigResponse](#flannelconfigresponse) |\- |Flannel 网络配置。 | |PodNetworkMode |String |Flannel |容器（Pod）网络模型（CNI），参数值说明：|\ | | | ||\ | | | |* **Flannel**：Flannel 网络模型，独立的 Underlay 容器网络模型。|\ | | | |* **VpcCniShared**：VPC\-CNI 网络模型，基于私有网络的弹性网卡 ENI 实现的 Underlay 容器网络模型。 | ### VpcCniConfigResponse |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |SubnetIds |Array of String |["subnet\-5g39d\*\*\*\*","subnet\-5g39d\*\*\*\*"] |VPC\-CNI 容器网络模型对应的 Pod 子网 ID 列表。 | |TrunkEniEnabled |Boolean |false |【[邀测·申请试用](https://www.volcengine.com/docs/6460/145623)】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](#logsetupresponse) |\- |集群的日志选项信息。 | |LogProjectId |String |d94b4eb4\-4931\-8\*\*\*\* |集群的日志项目（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\-8700\-0069\*\*\*\* |采集目标的 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) |\- |注册集群的链接配置。 | ### ProxyConfigResponse |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |VpcId |String |vpc\-2d73mg\*\*\*\* |注册集群使用的私有网络 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 |Object of [ClusterApiServerEndpointsResponse](#clusterapiserverendpointsresponse) |\- |注册集群 API Server 访问的 Endpoint 信息。 | |ApiServerPublicAccessConfig |Object of [PublicAccessConfigResponse](#publicaccessconfigresponse) |\- |注册集群 API Server 公网访问配置信息。|\ | | | |仅在`ApiServerPublicAccessEnable=true`时返回。 | |ApiServerPublicAccessEnabled |Boolean |false |是否开启注册集群 API Server 公网访问配置，参数值说明：|\ | | | ||\ | | | |* **false**：未开启。|\ | | | |* **true**：已开启。 | ### ClusterMonitoringConfigResponse |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |WorkspaceId |String |6fxxx\-5cxx\-47xx\-bfxx\-\*\*\*\* |托管集群监控对应的 VMP 工作区 ID。 | |ComponentConfigs |Array of [ClusterMonitoringComponentConfigResponse](#clustermonitoringcomponentconfigresponse) |\- |托管集群控制面监控配置。 | |EnableMetricsExternalCollection |Boolean |false |是否开启外部 Promtheus 采集集群控制面组件指标，参数值说明：|\ | | | ||\ | | | |* **true**：开启|\ | | | |* **false**：不开启|\ | | | ||\ | | | |更多信息，请参见 [使用自建 Prometheus 采集控制面组件指标](https://www.volcengine.com/docs/6460/1928314)。 | ### ClusterMonitoringComponentConfigResponse |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Name |String |KubeApiServer |需要监控的集群控制面组件名称，参数值说明： |\ | | | ||\ | | | |* **KubeApiServer**：kube\-apiserver 组件 |\ | | | |* **KubeScheduler**：kube\-scheduler 组件 |\ | | | |* **Etcd**：etcd 组件 |\ | | | |* **ClusterAutoscaler**：cluster\-autoscalar 组件 | |Enabled |Boolean |true |是否开启控制面组件监控，取值：|\ | | | ||\ | | | |* **true**：开启控制面组件监控。|\ | | | |* **flase**：未开启控制面组件监控。 | ### RegisterClusterMonitoringConfigResponse |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |QueryUrl |String |http://query.prometheus\-xx.xx.com/workspaces/caxx\-8xxx\-\*\*\*\* |注册集群使用托管 Prometheus（VMP）进行监控时，VMP 工作区的 Query 地址。 | |WorkspaceId |String |a72bxxxx\-83xx\-4axx\-87xx\-006899e6xxxx |注册集群使用 VMP 进行监控时，VMP 工作区的 ID。 | |RemoteWriteUrl |String |http://write.prometheus\-xxx.xx.com/workspaces/xxxx\-8xxx\-4exx\-8xxx\-1xxx/api/v1/write |注册集群使用 VMP 进行监控时，VMP 工作区的 RemoteWrite 地址。 | ## 返回示例 * Flannel 集群返回示例 ```JSON 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": "cc9q8pbfqt********", "ClientToken": "", "CreateTime": "2022-05-06T02:49:19Z", "UpdateTime": "2022-05-15T03:13:20Z", "KubernetesVersion": "v1.20.15-vke.2", "Name": "test", "Description": "", "Status": { "Phase": "Running", "Conditions": [ { "Type": "Ok" } ] }, "DeleteProtectionEnabled": true, "ClusterConfig": { "VpcId": "vpc-2d73mgmzui********", "SubnetIds": [ "subnet-2d73mhao****" ], "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 } ] } } ] } } ``` * VPC\-CNI 集群返回示例 ```JSON 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": "ccegio57qt********", "KubernetesVersion": "v1.20.15-vke.2", "Name": "vpc-cni-test", "Description": "", "Status": { "Phase": "Running", "Conditions": [ { "Type": "Ok" } ] }, "DeleteProtectionEnabled": false, "ClusterConfig": { "VpcId": "vpc-2bztfypmh1********", "SubnetIds": [ "subnet-2d74kxplgq******" ], "SecurityGroupIds": [ "sg-3re9w9akla******" ], "ApiServerPublicAccessEnabled": true, "ApiServerPublicAccessConfig": { "PublicAccessNetworkConfig": { "BillingType": 3, "Bandwidth": 10, "Isp": "ChinaMobile" } }, "ResourcePublicAccessDefaultEnabled": false, "ApiServerEndpoints": { "PrivateIp": { "Ipv4": "192.168.**.**" }, "PublicIp": { "Ipv4": "10.249.**.**" } } }, "PodsConfig": { "PodNetworkMode": "VpcCniShared", "VpcCniConfig": { "SubnetIds": [ "subnet-2d74kxplgqcxs58ozfe******" ] } }, "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 } ] } } ] } } ``` ## 错误码本接口无专有错误码，公共错误码请参见 [公共错误码](https://www.volcengine.com/docs/6460/118978)。

容器服务