文档平台 API 中心 负载均衡 应用型负载均衡相关接口 云服务器相关接口 解绑应用型负载均衡七层监听器转发规则上的云服务器

解绑应用型负载均衡七层监听器转发规则上的云服务器

最近更新时间:2018-06-01 11:49:57

接口描述

DeregisterInstancesFromForwardLB 接口用来将一台或多台云服务器从应用型负载均衡的七层监听器的转发规则上解绑。

接口访问域名:lb.api.qcloud.com

请求参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。其中,此接口的 Action 字段为 DeregisterInstancesFromForwardLB。

参数名称 必选 类型 描述
loadBalancerId String 负载均衡实例 ID,可通过 DescribeLoadBalancers 接口同时入参 forward 字段为 1 或者 -1 来查询。
listenerId String 应用型负载均衡监听器 ID,可通过 DescribeForwardLBListeners 接口查询。
locationIds.n String 指定的转发规则的 ID。如果不指定,则从整个监听器上解绑机器。
domain String 要绑定的监听器转发规则的域名。
url String 要绑定的监听器转发规则的路径。
backends.n.instanceId String 云服务器的唯一 ID,可通过 DescribeInstances 接口返回字段中的 unInstanceId 字段获取;
此接口支持同时输入多台主机的实例 ID(如:要输入两台主机,则设置 backends.1.instanceId&backends.2.instanceId)。
backends.n.port Int 负载均衡实例监听器后端云服务器监听端口,可选值:1~65535。如果不指定,那么就将该云服务器的全部端口解绑。

返回参数

参数名称 类型 描述
code Int 公共错误码,0 表示成功,其他值表示失败。详见错误码页面的 公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误码,成功返回 Success,失败有相应的英文说明。
requestId Int 请求任务 ID,可根据 DescribeLoadBalancersTaskResult 接口查询操作状态。

示例

请求

https://lb.api.qcloud.com/v2/index.php?Action=DeregisterInstancesFromForwardLB
&<公共请求参数>
&loadBalancerId=lb-abcdefgh
&listenerId=lbl-abcdefgh
&locationIds.0=loc-aaaadfa
&backends.0.instanceId=ins-1234test
&backends.0.port=80
&backends.1.instanceId=ins-5678test
&backends.1.port=6

返回

{
  "code" : 0,
  "message" : "",
  "codeDesc": "Success",
  "requestId" : 1234
}