文档

DetachLoadBalancers - 移除一个或多个负载均衡CLB实例

如果当前弹性伸缩组关联的负载均衡实例不能满足您的需求或者您需要取消关联,调用DetachLoadBalancers,通过指定伸缩组的ID、负载均衡实例的ID、ForceDetach等配置参数,移除一个或多个负载均衡 CLB(原 SLB)实例,同时可以选择异步调用以及是否移除负载均衡实例后端服务器中属于当前伸缩组的ECS实例。该接口仅支持移除负载均衡 CLB(原 SLB)实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ess:DetachLoadBalancersWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ScalingGroupIdstring

伸缩组的 ID。

asg-bp1ffogfdauy0jw0****
ForceDetachboolean

是否移除负载均衡实例后端服务器中属于当前伸缩组的 ECS 实例。取值范围:

  • true:移除 ECS 实例。

  • false:不移除 ECS 实例。

默认值:false。

false
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持 ASCII 字符,且不能超过 64 个字符。更多详情,请参见如何保证幂等性

123e4567-e89b-12d3-a456-42665544****
Asyncboolean

移除负载均衡实例时,是否采用异步调用的方式。异步调用能保证操作的事务性,即所有操作都执行成功或者某个操作失败时所有操作的执行结果都不生效,建议您采用异步调用。

取值范围:

  • true:异步调用。请求将返回伸缩活动的 ID。

  • false:同步调用。

默认值:false。

false
LoadBalancersarray

负载均衡实例的 ID,单次最多支持移除 5 台负载均衡实例。

string

负载均衡实例的 ID,单次最多支持移除 5 台负载均衡实例。

lb-2zeur05gfs****
RegionIdstring

伸缩组所属的地域 ID。

cn-qingdao

返回参数

名称类型描述示例值
object

移除负载均衡的返回信息集合。

ScalingActivityIdstring

伸缩活动的 ID。仅当 async=true 时返回该值。您可使用 API describescalingactivities 遍历查询返回的伸缩活动 id,查看伸缩活动的执行状态。

asa-bp140qd7mak8k63f****
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

示例

正常返回示例

JSON格式

{
  "ScalingActivityId": "asa-bp140qd7mak8k63f****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史