1. 接口描述
接口请求域名: clb.tencentcloudapi.com 。
查询独占集群中的资源列表,支持按集群ID、VIP、负载均衡ID、是否闲置为过滤条件检索。
默认接口请求频率限制:20次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:clb.ap-shanghai-fsi.tencentcloudapi.com。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeClusterResources。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Limit | 否 | Integer | 返回集群中资源列表数目,默认为20,最大值为100。 |
Offset | 否 | Integer | 返回集群中资源列表起始偏移量,默认为0。 |
Filters.N | 否 | Array of Filter | 查询集群中资源列表条件,详细的过滤条件如下: |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ClusterResourceSet | Array of ClusterResource | 集群中资源列表。 |
TotalCount | Integer | 集群中资源总数。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询集群资源列表
输入示例
https://clb.tencentcloudapi.com/?Action=DescribeClusterResources
&Offset=0
&Limit=20
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 2,
"ClusterResourceSet": [
{
"ClusterName": "cluster-1",
"ClusterId": "tgw-12345678",
"Vip": "1.1.1.1",
"LoadBalancerId": null,
"Idle": true
},
{
"ClusterName": "cluster-1",
"ClusterId": "tgw-12345678",
"Vip": "1.1.1.2",
"LoadBalancerId": "lb-12345678",
"Idle": false
}
],
"RequestId": "49e44bf9-1357-420b-87ba-3c827209af67"
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
- Tencent Cloud CLI 3.0
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.FormatError | 参数格式错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Duplicate | 参数值有重复。 |
InvalidParameterValue.InvalidFilter | Filter参数输入错误。 |
InvalidParameterValue.Length | 参数长度错误。 |
InvalidParameterValue.Range | 参数取值范围错误。 |