1. 接口描述
接口请求域名： thpc.tencentcloudapi.com 。
本接口（DescribeClusters）用于查询集群列表。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeClusters。 |
| Version | 是 | String | 公共参数，本接口取值：2021-11-09。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ClusterIds.N | 否 | Array of String | 集群ID列表。通过该参数可以指定需要查询信息的集群列表。 如果您不指定该参数，则返回Limit数量以内的集群信息。 |
| Offset | 否 | Integer | 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。示例值：0 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。示例值：20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ClusterSet | Array of ClusterOverview | 集群概览信息列表。 |
| TotalCount | Integer | 集群数量。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询集群列表
输入示例
https://thpc.tencentcloudapi.com/?Action=DescribeClusters
&Offset=0
&Limit=1
&<公共请求参数>输出示例
{
"Response": {
"ClusterSet": [
{
"ClusterId": "hpc-qrb7ybn0",
"ClusterName": "unnamed",
"ClusterStatus": "RUNNING",
"Placement": {
"Zone": "ap-guangzhou-2"
},
"CreateTime": "2021-12-07T03:29:09Z",
"SchedulerType": "SGE",
"ComputeNodeCount": 1,
"ComputeNodeSet": [
{
"NodeId": "ins-jfhc307q"
}
],
"ManagerNodeCount": 1,
"ManagerNodeSet": [
{
"NodeId": "ins-cv6ygpkq"
}
]
}
],
"TotalCount": 1,
"RequestId": "8a39c8e3-129b-4628-b763-ef96caaa2f4d"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.Malformed | 参数格式有误。 |