微服务平台 TSF 查询简单集群列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： tsf.tencentcloudapi.com 。

查询简单集群列表

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSimpleClusters。
Version	是	String	公共参数，本接口取值：2018-03-26。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterIdList.N	否	Array of String	需要查询的集群ID列表，不填或不传入时查询所有内容
ClusterType	否	String	需要查询的集群类型，不填或不传入时查询所有内容
Offset	否	Integer	查询偏移量，默认为0 示例值：0
Limit	否	Integer	分页个数，默认为20，取值应为1~50 示例值：50
SearchWord	否	String	对id和name进行关键词过滤
DisableProgramAuthCheck	否	Boolean	无

3. 输出参数

参数名称	类型	描述
Result	TsfPageCluster	TSF集群分页对象注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询简单集群列表

输入示例

https://tsf.tencentcloudapi.com/?Action=DescribeSimpleClusters
&Offset=0
&Limit=50
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "73d633f3-1d91-443a-a5bb-b4d419a56721",
        "Result": {
            "TotalCount": 2,
            "Content": [
                {
                    "ClusterId": "cls-xxxxxxx",
                    "ClusterName": "示例",
                    "ClusterDesc": null,
                    "ClusterType": "C",
                    "VpcId": "vpc-xxxxxxx",
                    "CreateTime": null,
                    "UpdateTime": null,
                    "ClusterStatus": null,
                    "ClusterCIDR": null,
                    "ClusterTotalCpu": null,
                    "ClusterTotalMem": null,
                    "ClusterUsedCpu": null,
                    "ClusterUsedMem": null,
                    "ClusterLimitCpu": null,
                    "ClusterLimitMem": null,
                    "InstanceCount": null,
                    "RunInstanceCount": null,
                    "RunServiceInstanceCount": null,
                    "NormalInstanceCount": null,
                    "DeleteFlag": null,
                    "DeleteFlagReason": null,
                    "OperationInfo": null,
                    "TsfRegionId": null,
                    "TsfRegionName": null,
                    "TsfZoneId": null,
                    "TsfZoneName": null
                },
                {
                    "ClusterId": "cls-xxxxxxx",
                    "ClusterName": "示例",
                    "ClusterDesc": null,
                    "ClusterType": "C",
                    "VpcId": "vpc-xxxxxxx",
                    "CreateTime": null,
                    "UpdateTime": null,
                    "ClusterStatus": null,
                    "ClusterCIDR": null,
                    "ClusterTotalCpu": null,
                    "ClusterTotalMem": null,
                    "ClusterUsedCpu": null,
                    "ClusterUsedMem": null,
                    "ClusterLimitCpu": null,
                    "ClusterLimitMem": null,
                    "InstanceCount": null,
                    "RunInstanceCount": null,
                    "RunServiceInstanceCount": null,
                    "NormalInstanceCount": null,
                    "DeleteFlag": null,
                    "DeleteFlagReason": null,
                    "OperationInfo": null,
                    "TsfRegionId": null,
                    "TsfRegionName": null,
                    "TsfZoneId": null,
                    "TsfZoneName": null
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.ClusterQueryFailed	查询集群失败。
InvalidParameter.ParamError	参数错误。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。
UnauthorizedOperation.NoLicense	缺少License。。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。