查询简单集群列表

最近更新时间:2019-08-29 21:04:19

1. 接口描述

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

查询简单集群列表

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:tsf.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSimpleClusters
Version String 公共参数,本接口取值:2018-03-26
Region String 公共参数,详见产品支持的 地域列表
ClusterIdList.N Array of String 需要查询的集群ID列表,不填或不传入时查询所有内容
ClusterType String 需要查询的集群类型,不填或不传入时查询所有内容
Offset Integer 查询偏移量,默认为0
Limit Integer 分页个数,默认为20, 取值应为1~50

3. 输出参数

参数名称 类型 描述
Result TsfPageCluster TSF集群分页对象
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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 Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码