获取负载均衡七层监听器

最近更新时间:2017-10-20 17:26:52

功能描述

DescribeBmForwardListeners 提供了获取黑石负载均衡七层监听器功能。

接口请求域名:bmlb.api.qcloud.com

请求

请求示例

GET https://bmlb.api.qcloud.com/v2/index.php?Action=DescribeBmForwardListeners
    &<公共请求参数>
    &loadBalancerId=<负载均衡实例ID>
    &listenerIds.0=<七层监听器实例ID>

请求参数

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

参数名称 必选 类型 描述
loadBalancerId String 负载均衡实例ID,可通过接口DescribeBmLoadBalancers查询。
listenerIds.n Array 七层监听器实例ID列表,可通过接口DescribeBmForwardListeners查询。

响应

响应示例

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "listenerSet": [
        {
            "listenerId": "lbl-abcdefgh",
            "listenerName": "xxx",
            "protocol": "http",
            "loadBalancerPort": 1234,
            "bandwidth": 0,
            "listenerType": "L7Listener",
            "SSLMode": 0,
            "certId": "",
            "certCaId": "",
            "status": 1,
            "addTimestamp": "2017-03-09 19:34:45"
        }
    ],
    "totalCount": 1
}

响应参数

参数名称 类型 描述
code Int 错误码。0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 错误信息描述,与接口相关。
codeDesc String 返回码信息描述。
listenerSet Array 返回的七层监听器列表。

listenerSet每一个子项目包含字段如下

参数名称 类型 描述
listenerId String 七层监听器实例ID。
listenerName String 七层监听器名称。
protocol String 七层监听器协议类型,可选值:http,https。
loadBalancerPort Int 七层监听器的监听端口。
bandwidth Int 计费模式为按固定带宽方式时监听器的限速值,单位:Mbps。
listenerType String 监听器的类别:L4Listener(四层监听器),L7Listener(七层监听器)。
SSLMode Int 七层监听器的认证方式:0(不认证,用于http),1(单向认证,用于https),2(双向认证,用于https)。
certId String 七层监听器关联的服务端证书ID。
certCaId String 七层监听器关联的客户端证书ID。
status Int 监听器当前状态(0代表创建中,1代表正常运行,2代表创建失败,3代表删除中,4代表删除失败)。
addTimestamp String 创建时间戳。

错误码

错误代码 英文提示 错误描述
9003 InvalidParameter 参数错误
9006 InternalError.CCDBAbnormal CCDB 服务异常

实际案例

输入

GET https://bmlb.api.qcloud.com/v2/index.php?Action=DescribeBmForwardListeners
    &SecretId=AKIDlfdHxN0ntSVt4KPH0xXWnGl21UUFNoO5
    &Nonce=24763
    &Timestamp=1507714922
    &Region=bj
    &loadBalancerId=lb-abcdefgh
    &listenerIds.0=lbl-abcdefgh
    &Signature=AySJsE6Zq3knXwPSzxlYUl%2FrM90%3D

输出

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "listenerSet": [
        {
            "listenerId": "lbl-abcdefgh",
            "listenerName": "xxx",
            "protocol": "http",
            "loadBalancerPort": 1234,
            "bandwidth": 0,
            "listenerType": "L7Listener",
            "SSLMode": 0,
            "certId": "",
            "certCaId": "",
            "status": 1,
            "addTimestamp": "2017-03-09 19:34:45"
        }
    ],
    "totalCount": 1
}