修改集群信息

最近更新时间: 2026-10-11 00:12:03

1. 接口描述

接口请求域名: tsf.api3.fincloud.tencent.com。

修改集群信息

默认接口请求频率限制:10000次/秒。

接口更新时间:2026-02-04 22:22:48。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:ModifyCluster
Version 是 否 String 公共参数,本接口取值:2018-03-26
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
ClusterName 否 否 String 集群名称
示例值:  
ClusterDesc 否 否 String 集群描述信息
示例值:  
ClusterRemarkName 否 否 String 备注名
示例值:  
EnableLogCollection 否 是 Bool 是否开启cls日志功能,true表示开启,false表示关闭
示例值:  
RepairLog 否 是 Bool 是否修复cls日志功能,true表示修复,false表示不修复
示例值:  
ClusterId 是 否 String 集群ID,按照【集群ID】进行过滤,可通过调用DescribeClusters查询已创建的项目列表或登录控制台进行查看;也可以调用CreateCluster创建新的项目。集群ID例如:cls-6a79x94v。
示例值:  

3. 输出参数

参数名称 类型 描述
Result Bool 更新集群详情操作是否成功。
true: 操作成功。
false:操作失败。
示例值:  
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。

错误码 描述
ResourceNotFound.ClusterNotExist 无法获取命名空间所属集群。
InternalError.CpClusterUnavailable 容器平台集群不可用,当前状态 %s。
InternalError.TkeApiFailedOperation 调用 TKE 接口失败,%s。
MissingParameter.ApplicationIdNull 应用ID不能为空。
MissingParameter.ClusterIdRequired 集群ID未填写。

5. 示例

示例1 更新集群示例

输入示例

https://tsf.api3.fincloud.tencent.com/?Action=ModifyCluster
&ClusterId=cluster-byxzrdga
&<Common Parameters>

输出示例

{
  "Response": {
    "RequestId": "de5461f4-f354-4c83-ae64-ca3ca863fe35",
    "Result": true
  }
}