负载均衡查询负载均衡闲置实例-API 文档-文档中心-腾讯云

1. 接口描述

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

闲置实例是指创建超过7天后付费实例，且没有创建规则或创建规则没有绑定子机的负载均衡实例。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeIdleLoadBalancers。
Version	是	String	公共参数，本接口取值：2018-03-17。
Region	是	String	公共参数，详见产品支持的地域列表。
Offset	否	Integer	数据偏移量，默认为0。示例值：0
Limit	否	Integer	返回负载均衡实例的数量，默认为20，最大值为100。示例值：20
LoadBalancerRegion	否	String	负载均衡所在地域。示例值：ap-guangzhou

3. 输出参数

参数名称	类型	描述
IdleLoadBalancers	Array of IdleLoadBalancer	闲置实例列表注意：此字段可能返回 null，表示取不到有效值。
TotalCount	Integer	所有闲置实例数目示例值：5
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取负载均衡闲置实例

输入示例

https://clb.tencentcloudapi.com/?Action=DescribeIdleLoadBalancers
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 46,
        "IdleLoadBalancers": [
            {
                "LoadBalancerId": "lb-1l1i6a3k",
                "LoadBalancerName": "lb-613054ce",
                "Region": "ap-guangzhou",
                "Vip": "172.16.32.29",
                "IdleReason": "NO_RULES",
                "Status": 1,
                "Forward": 1
            }
        ],
        "RequestId": "afa28690-f148-483f-9727-58c2f1da3794"
    }
}

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. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
DryRunOperation	DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation	操作失败。
FailedOperation.InvalidLBStatus	LB状态异常。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.FormatError	参数格式错误。
InvalidParameter.InvalidFilter	查询参数错误。
InvalidParameter.LBIdNotFound	负载均衡实例ID错误。
InvalidParameter.ListenerIdNotFound	监听器ID错误。
InvalidParameter.LocationNotFound	查找不到符合条件的转发规则。
InvalidParameter.PortCheckFailed	监听器端口检查失败，比如端口冲突。
InvalidParameterValue.Range	参数取值范围错误。

查询负载均衡闲置实例

本页目录：