Skip to content

Latest commit

 

History

History
110 lines (87 loc) · 4.24 KB

File metadata and controls

110 lines (87 loc) · 4.24 KB

? 当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。黑石物理服务器1.0 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 黑石物理服务器1.0 API 3.0

功能描述

BindBmL4ListenerRs 提供了绑定黑石物理服务器到四层监听器功能。

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

请求

请求示例

GET https://bmlb.api.qcloud.com/v2/index.php?Action=BindBmL4ListenerRs
	&<公共请求参数>
	&loadBalancerId=<负载均衡实例ID>
	&listenerId=<四层监听器实例ID>
	&backends.0.port=<待绑定的主机端口>
	&backends.0.probePort=<自定义探测的主机端口>
	&backends.0.instanceId=<待绑定的主机实例ID>
	&backends.0.weight=<待绑定的主机权重>

请求参数

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

参数名称 必选 类型 描述
loadBalancerId String 负载均衡实例ID,可通过接口DescribeBmLoadBalancers查询。
listenerId String 四层监听器实例ID,可通过接口DescribeBmListeners查询。
backends Array 待绑定的主机信息。可以绑定多个主机端口。目前一个四层监听器下面最多允许绑定255个主机端口。

backends描述待绑定的主机信息,n为下标,backends包含字段如下

参数名称 必选 类型 描述
backends.n.port Int 待绑定的主机端口,可选值1~65535。
backends.n.probePort Int 自定义探测的主机端口,可选值1~65535。(需要监听器开启自定义健康检查)
backends.n.instanceId String 待绑定的主机实例ID。
backends.n.weight Int 待绑定的主机权重,可选值0~100。

响应

响应示例

{
 "code": 0,
 "message": "",
 "codeDesc": "Success",
 "requestId": "<异步任务ID>"
}

响应参数

参数名称 类型 描述
code Int 错误码, 0: 成功, 其他值: 失败,具体含义可以参考错误码
message String 模块错误信息描述,与接口相关。
requestId Int 任务ID。该接口为异步任务,可根据本参数调用DescribeBmLoadBalancersTaskResult接口来查询任务操作结果

错误码

错误代码 英文提示 错误描述
9003 InvalidParameter 参数错误
9006 InternalError.CCDBAbnormal CCDB 服务异常
11041 InvalidParameter.CCDBLBNotExist CCDB中不存在该负载均衡记录信息
12003 IncorrectStatus.LBWrongStatus 该负载均衡状态不正确,无法执行当前操作
12013 InvalidResource.BindCPMNumberOverLimit 该负载均衡绑定的主机端口数量超过上限
14100 InternalError.BmApiAbnormal bmApi服务异常
30011 InvalidRs.NotExist 主机信息不存在
-21001 InvalidStatus.LBInvalidStatus 当前负载均衡状态不允许此操作
-12023 InvalidL4Listener.NotExist CCDB中不存在该四层监听器
-12021 IncorrectStatus.L4ListenerWrongStatus 该负载均衡四层监听器状态不正确,无法执行当前操作
-21000 InvalidStatus.DeviceInvalidStatus 当前设备状态不允许此操作
-12022 InvalidParameter.InvalidMultiL4VportToRsport 此主机端口已经绑定四层监听器

实际案例

输入

GET https://bmlb.api.qcloud.com/v2/index.php?Action=BindBmL4ListenerRs
	&SecretId=AKIDlfdHxN0ntSVt4KPH0xXWnGl21UUFNoO5
	&Nonce=61431
	&Timestamp=1507728683
	&Region=bj
	&loadBalancerId=lb-abcdefgh
	&listenerId=lbl-abcdefgh
	&backends.0.port=1234
	&backends.0.probePort=1234
	&backends.0.instanceId=cpm-abcdefgh
	&backends.0.weight=10
	&Signature=umZFAAWKzjXEQp4ySgrWAoWOHKI%3D

输出

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