删除负载均衡实例

最近更新时间:2025-12-05 01:25:08

我的收藏

1. 接口描述

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

DeleteLoadBalancer 接口用以删除指定的一个或多个负载均衡实例。成功删除后,会把负载均衡实例下的监听器、转发规则一起删除,并把后端服务解绑。
本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeleteLoadBalancer。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表
LoadBalancerIds.N Array of String 要删除的负载均衡实例 ID 数组,可以通过 DescribeLoadBalancers 接口获取,数组大小最大支持20。
示例值:["lb-hsb93u5o"]
ForceDelete Boolean 是否强制删除clb。true表示强制删除,false表示不是强制删除,需要做拦截校验。
默认为false。
以下几种情况会默认拦截删除操作,如果触发情况1、2但确认强制删除则需要传强制校验参数ForceDelete为true。
1、删除后端绑定大于等于 20 个 RS 的实例时。
2、删除后端有 RS 且 5 分钟 内“出/入带宽”峰值取大 > 10Mbps 的实例时。
3、单地域内 5 分钟 内删除大于等于 30 个实例时。
示例值:true

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 删除负载均衡实例

输入示例

https://clb.tencentcloudapi.com/?Action=DeleteLoadBalancer
&LoadBalancerIds.0=lb-hsb93u5o
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "db141822-c025-4765-88d4-02bdec0e67ed"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.EipTrafficCheckRisk 该实例绑定的EIP资源业务带宽超过防误操作检测阈值,执行操作可能存在风险,如仍想继续,请在EIP控制台关闭对应EIP的防误操作检测开关后重试。
FailedOperation.FrequencyCheckRisk 删除实例频次校验被判定为高风险,请检查业务或稍后重试。
FailedOperation.TargetNumCheckRisk 删除实例规则数校验被判定为高风险,如需强行删除请传强制校验参数ForceDelete为true。
FailedOperation.TrafficCheckRisk 删除实例流量校验被判定为高风险,如需强行删除请传强制校验参数ForceDelete为true。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameter.LBIdNotFound 负载均衡实例ID错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Length 参数长度错误。
LimitExceeded 超过配额限制。
ResourceInsufficient 资源不足。
UnauthorizedOperation 未授权操作。