获取集群列表

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

1. 接口描述

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

获取集群列表

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

接口更新时间：2025-08-06 23:23:55。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeClusters
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ClusterType	否	否	String	集群类型，C表示容器集群，V表示虚拟机集群示例值：
ClusterIdList	否	否	Array of String	idList 示例值：
SearchWord	否	否	String	搜索词，可以搜索ID/名称/备注/标签示例值：
OrderBy	否	否	String	排序字段，例如创建时间示例值：
OrderType	否	否	Int64	排序方式，0表示升序，1表示倒序示例值：
Offset	否	否	Int64	偏移量，默认0 示例值：
Limit	否	否	Int64	分页个数，0-50 之间，默认20 示例值：

3. 输出参数

参数名称	类型	描述
Result	TsfPageClusterV2	Cluster分页信息示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameter.ParamError	参数错误。
ResourceNotFound.ClusterNotExist	无法获取命名空间所属集群。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。
FailedOperation.ClusterQueryFailed	查询集群失败。
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
InternalError.UnhandledException	[%s]模块未处理异常。。
ResourceNotFound.LicenseServerNotFound	无法找到License服务器。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。
UnauthorizedOperation.NoLicense	缺少License。。
InvalidParameterValue.ClusterPageLimitInvalid	集群无效的分页参数。
FailedOperation.DispatchCommonError	TSF暂时不能响应请求。
FailedOperation.UnhandledException	模块未处理异常。

5. 示例

示例1 获取集群列表示例

输入示例

POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribeClusters
<Common Parameters>

{
    "Limit": 20,
    "Offset": 0
}

输出示例

{
  "Response": {
    "RequestId": "6d7e580e-4b1c-49a7-8ffd-21551f865643",
    "Result": {
      "TotalCount": 0,
      "Content": []
    }
  }
}