负载均衡BLB

    普通型BLB监听器相关接口

    CreateTCPListener创建TCP监听器

    描述

    • 在指定LoadBalancer下,创建一个基于TCP协议的监听器,监听一个前端端口,将发往该端口的所有TCP流量,转发到后端服务器监听的后端端口上。TCP监听器只支持TCP协议的健康检查,检查端口和后端服务器监听端口一致。

    请求结构

    POST /v{version}/blb/{blbId}/TCPlistener?clientToken={clientToken} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string
    
    {
        "listenerPort":listenerPort,
        "backendPort":backendPort,
        "scheduler":scheduler,
        "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
        "healthCheckInterval":healthCheckInterval,
        "unhealthyThreshold":unhealthyThreshold,
        "healthyThreshold":healthyThreshold
    }

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    listenerPort int RequestBody参数 监听器的监听端口,需为1-65535间的整数
    backendPort int RequestBody参数 后端服务器的监听端口,需为1-65535间的整数
    scheduler String RequestBody参数 负载均衡算法,支持3种方式:"RoundRobin"/"LeastConnection"/"Hash"
    tcpSessionTimeout int RequestBody参数 tcp设置连接超时时间(单位:秒),默认900,需为10-4000间的整数
    healthCheckTimeoutInSecond int RequestBody参数 健康检查超时(单位:秒),默认为3,需为1-60间的整数
    healthCheckInterval int RequestBody参数 健康检查间隔(单位:秒),默认为3,需为1-10间的整数
    unhealthyThreshold int RequestBody参数 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器。默认为3,需为2-5间的整数
    healthyThreshold int RequestBody参数 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用。默认为3,需为2-5间的整数

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    请求示例

    POST /v1/blb/lb-j8UqijYf/TCPlistener?clientToken=asdfg HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
    
    {
        "listenerPort":95,
        "backendPort":95,
        "scheduler":"LeastConnection",
        "healthCheckTimeoutInSecond":4,
        "healthCheckInterval":5,
        "unhealthyThreshold":2
    }

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Wed, 10 Apr 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS

    CreateUDPListener创建UDP监听器

    描述

    • 在指定LoadBalancer下,创建一个基于UDP协议的监听器,监听一个前端端口,将发往该端口的所有UDP流量,转发到后端服务器监听的后端端口上。UDP监听器只支持UDP协议的健康检查,检查端口和后端服务器监听端口一致。

    请求结构

    POST /v{version}/blb/{blbId}/UDPlistener?clientToken={clientToken} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string
    
    {
        "listenerPort":listenerPort,
        "backendPort":backendPort,
        "scheduler":scheduler,
        "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
        "healthCheckInterval":healthCheckInterval,
        "unhealthyThreshold":unhealthyThreshold,
        "healthyThreshold":healthyThreshold,
        "healthCheckString":"health check"
    }

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    clientToken String Query参数 幂等性Token,长度不超过64位
    listenerPort int RequestBody参数 监听器的监听端口,需为1-65535间的整数
    backendPort int RequestBody参数 后端服务器的监听端口,需为1-65535间的整数
    scheduler String RequestBody参数 负载均衡算法,支持3种方式:"RoundRobin"/"LeastConnection"/"Hash"
    healthCheckString String RequestBody参数 健康发送的请求字符串,后端服务器收到后需要进行应答,支持16进制\00-\FF和标准ASCII字符串,最大长度1299
    healthCheckTimeoutInSecond int RequestBody参数 健康检查超时(单位:秒),默认为3,需为1-60间的整数
    healthCheckInterval int RequestBody参数 健康检查间隔(单位:秒),默认为3,需为1-10间的整数
    unhealthyThreshold int RequestBody参数 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器。默认为3,需为2-5间的整数
    healthyThreshold int RequestBody参数 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用。默认为3,需为2-5间的整数

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    请求示例

    POST /v1/blb/lb-j8UqijYf/UDPlistener?clientToken=asdfg HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
    
    {
        "listenerPort":95,
        "backendPort":95,
        "scheduler":"LeastConnection",
        "healthCheckTimeoutInSecond":4,
        "healthCheckInterval":5,
        "unhealthyThreshold":2,
    	"healthCheckString":"health check"
    }

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Wed, 10 Apr 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS

    CreateHTTPListener创建HTTP监听器

    描述

    • 在指定LoadBalancer下,创建一个基于HTTP协议的监听器,监听一个前端端口,将发往该端口的所有HTTP请求,转发到后端服务器监听的后端端口上

    请求结构

    POST /v{version}/blb/{blbId}/HTTPlistener?clientToken={clientToken} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string
    
    {
        "listenerPort":listenerPort,
        "backendPort":backendPort,
        "scheduler":scheduler,
        "keepSession":keepSession,
        "keepSessionType":keepSessionType,
        "keepSessionDuration":keepSessionDuration,
        "keepSessionCookieName":keepSessionCookieName,
        "xForwardFor":xForwardFor,        
        "healthCheckType":healthCheckType,
        "healthCheckPort":healthCheckPort,
        "healthCheckURI":healthCheckURI,
        "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
        "healthCheckInterval":healthCheckInterval,
        "unhealthyThreshold":unhealthyThreshold,
        "healthyThreshold":healthyThreshold,
        "healthCheckNormalStatus":healthCheckNormalStatus,
        "serverTimeout":serverTimeout,
    	"redirectPort":redirectPort
    }

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    listenerPort int RequestBody参数 监听器的监听端口,需为1-65535间的整数
    backendPort int RequestBody参数 后端服务器的监听端口,需为1-65535间的整数
    scheduler String RequestBody参数 负载均衡算法,支持2种方式:"RoundRobin"/"LeastConnection"
    keepSession bool RequestBody参数 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器,默认关闭
    keepSessionType String RequestBody参数 会话保持的cookie处理方式,当且仅当开启会话保持时有效,支持"insert"/"rewrite",默认"insert"
    keepSessionDuration int RequestBody参数 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效,默认3600s,需为1-15552000间的整数
    keepSessionCookieName String RequestBody参数 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效
    xForwardFor bool RequestBody参数 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址,默认关闭
    healthCheckType String RequestBody参数 健康检查协议,支持"HTTP"/"TCP",默认HTTP
    healthCheckPort int RequestBody参数 健康检查端口,默认为backendPort
    healthCheckURI String RequestBody参数 健康检查URI,默认/。当健康检查协议为"HTTP"时生效
    healthCheckTimeoutInSecond int RequestBody参数 健康检查超时(单位:秒),默认为3,需为1-60间的整数
    healthCheckInterval int RequestBody参数 健康检查间隔(单位:秒),默认为3,需为1-10间的整数
    unhealthyThreshold int RequestBody参数 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器。默认为3,需为2-5间的整数
    healthyThreshold int RequestBody参数 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用。默认为3,需为2-5间的整数
    healthCheckNormalStatus String RequestBody参数 健康检查正常时的HTTP状态码,支持5类状态码的组合,例如"http_1xx|http_2xx",默认"http_2xx|http_3xx"。当健康检查协议为"HTTP"时生效
    serverTimeout int RequestBody参数 后端服务器最大超时(单位:秒),默认30s,需为1-3600间的整数
    redirectPort int RequestBody参数 将此监听器收到的请求转发到HTTPS监听器,HTTPS监听器通过这个端口指定

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    请求示例

    POST /v1/blb/lb-j8UqijYf/HTTPlistener?clientToken=asdfg HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string
    
    {
        "listenerPort":95,
        "backendPort":95,
        "scheduler":"LeastConnection",
        "healthCheckTimeoutInSecond":4,
        "healthCheckInterval":5,
        "unhealthyThreshold":2,
        "xForwardFor":true,
        "healthCheckType":"HTTP",
        "serverTimeout":1800,
        "healthCheckNormalStatus":"http_1xx|http_2xx",
    	"redirectPort":80
    }

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Wed, 10 Apr 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS

    CreateHTTPSListener创建HTTPS监听器

    描述

    在指定LoadBalancer下,创建一个基于HTTPS协议的监听器,监听一个前端端口,将发往该端口的所有HTTPS请求,先通过SSL卸载转换为HTTP请求后,再转发到后端服务器监听的后端端口上。

    请求结构

    POST /v{version}/blb/{blbId}/HTTPSlistener?clientToken={clientToken} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string
    
    {
        "listenerPort":listenerPort,
        "backendPort":backendPort,
        "scheduler":scheduler,
        "keepSession":keepSession,
        "keepSessionType":keepSessionType,
        "keepSessionDuration":keepSessionDuration,
        "keepSessionCookieName":keepSessionCookieName,
        "xForwardFor":xForwardFor,        
        "healthCheckType":healthCheckType,
        "healthCheckPort":healthCheckPort,
        "healthCheckURI":healthCheckURI,
        "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
        "healthCheckInterval":healthCheckInterval,
        "unhealthyThreshold":unhealthyThreshold,
        "healthyThreshold":healthyThreshold,
        "healthCheckNormalStatus":healthCheckNormalStatus,
        "serverTimeout":serverTimeout,
        "certIds":[id1, id2],
        "ie6Compatible":true,
        "encryptionType":encryptionType,
        "encryptionProtocols":[protocal1, protacal2],
        "dualAuth":false,
        "clientCertIds":[id1, id2]
    }

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    clientToken String Query参数 幂等性Token,长度不超过64位
    listenerPort int RequestBody参数 监听器的监听端口,需为1-65535间的整数
    backendPort int RequestBody参数 后端服务器的监听端口,需为1-65535间的整数
    scheduler String RequestBody参数 负载均衡算法,支持2种方式:"RoundRobin"/"LeastConnection"
    keepSession boolean RequestBody参数 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器,默认关闭
    keepSessionType String RequestBody参数 会话保持的cookie处理方式,当且仅当开启会话保持时有效,支持"insert"/"rewrite",默认"insert"
    keepSessionDuration int RequestBody参数 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效,默认3600s,需为1-15552000间的整数
    keepSessionCookieName int RequestBody参数 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效
    xForwardFor boolean RequestBody参数 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址,默认关闭
    healthCheckType String RequestBody参数 健康检查协议,支持"HTTP"/"TCP",默认HTTP
    healthCheckPort int RequestBody参数 健康检查端口,默认为backendPort
    healthCheckURI String RequestBody参数 健康检查URI,默认/。当健康检查协议为"HTTP"时生效
    healthCheckTimeoutInSecond int RequestBody参数 健康检查超时(单位:秒),默认为3,需为1-60间的整数
    healthCheckInterval int RequestBody参数 健康检查间隔(单位:秒),默认为3,需为1-10间的整数
    unhealthyThreshold int RequestBody参数 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器。默认为3,需为2-5间的整数
    healthyThreshold int RequestBody参数 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用。默认为3,需为2-5间的整数
    healthCheckNormalStatus String RequestBody参数 健康检查正常时的HTTP状态码,支持5类状态码的组合,例如"http_1xx|http_2xx",默认"http_2xx|http_3xx"。当健康检查协议为"HTTP"时生效
    serverTimeout int RequestBody参数 后端服务器最大超时(单位:秒),默认30s,需为1-3600间的整数
    certIds List\<String> RequestBody参数 监听器要加载的证书链
    ie6Compatible boolean RequestBody参数 是否兼容IE6的HTTPS请求(协议格式为较早的SSL3.0,安全性较差),默认开启
    encryptionType String RequestBody参数 加密选项,支持三种类型:compatibleIE/incompatibleIE/userDefind,分别对应:兼容IE的加密方式/禁用不安全的加密方式/自定义加密方式,当encryptionType有值且合法时ie6Compatible字段传值不生效
    encryptionProtocols List\<String> RequestBody参数 当encryptionType值为userDefind时协议类型列表,是以"sslv3"、"tlsv10"、"tlsv11"、"tlsv12"四种协议组合形成的字符串列表
    dualAuth boolean RequestBody参数 是否开启双向认证,默认为关闭
    clientCertIds List\<String> RequestBody参数 当dualAuth为true时,加载的客户端证书链

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    POST /v1/blb/lb-j8UqijYf/HTTPSlistener?clientToken=asdfg HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
    
    {
        "listenerPort":95,
        "backendPort":95,
        "scheduler":"LeastConnection",
        "healthCheckTimeoutInSecond":4,
        "healthCheckInterval":5,
        "unhealthyThreshold":2,
        "xForwardFor":true,
        "healthCheckType":"HTTP",
        "serverTimeout":1800,
        "healthCheckNormalStatus":"http_1xx|http_2xx",
        "certIds":["cert-zfj2ey2z4kmm"]
    }

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Wed, 10 Apr 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS

    CreateSSLListener创建SSL监听器

    描述

    • 在指定LoadBalancer下,创建一个基于TCP协议的监听器,监听一个前端端口,将发往该端口的所有TCP流量,转发到后端服务器监听的后端端口上。TCP监听器只支持TCP协议的健康检查,检查端口和后端服务器监听端口一致。

    请求结构

    POST /v{version}/blb/{blbId}/SSLlistener?clientToken={clientToken} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string
    
    {
        "listenerPort":listenerPort,
        "backendPort":backendPort,
        "scheduler":scheduler,
        "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
        "healthCheckInterval":healthCheckInterval,
        "unhealthyThreshold":unhealthyThreshold,
        "healthyThreshold":healthyThreshold,
        "certIds":[id1, id2],
        "ie6Compatible":true,
        "encryptionType":encryptionType,
        "encryptionProtocols":[protocal1, protacal2],
        "dualAuth":false,
        "clientCertIds":[id1, id2]              
    }

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    clientToken String Query参数 幂等性Token,长度不超过64位
    listenerPort int RequestBody参数 监听器的监听端口,需为1-65535间的整数
    backendPort int RequestBody参数 后端服务器的监听端口,需为1-65535间的整数
    scheduler String RequestBody参数 负载均衡算法,支持3种方式:"RoundRobin"/"LeastConnection"/"Hash"
    tcpSessionTimeout int RequestBody参数 tcp设置连接超时时间(单位:秒),默认900,需为10-4000间的整数
    healthCheckTimeoutInSecond int RequestBody参数 健康检查超时(单位:秒),默认为3,需为1-60间的整数
    healthCheckInterval int RequestBody参数 健康检查间隔(单位:秒),默认为3,需为1-10间的整数
    unhealthyThreshold int RequestBody参数 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器。默认为3,需为2-5间的整数
    healthyThreshold int RequestBody参数 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用。默认为3,需为2-5间的整数
    certIds List\<String> RequestBody参数 监听器要加载的证书链
    ie6Compatible boolean RequestBody参数 是否兼容IE6的HTTPS请求(协议格式为较早的SSL3.0,安全性较差),默认开启
    encryptionType String RequestBody参数 加密选项,支持三种类型:compatibleIE/incompatibleIE/userDefind,分别对应:兼容IE的加密方式/禁用不安全的加密方式/自定义加密方式,当encryptionType有值且合法时ie6Compatible字段传值不生效
    encryptionProtocols List\<String> RequestBody参数 当encryptionType值为userDefind时协议类型列表,是以"sslv3"、"tlsv10"、"tlsv11"、"tlsv12"四种协议组合形成的字符串列表
    dualAuth boolean RequestBody参数 是否开启双向认证,默认为关闭
    clientCertIds List\<String> RequestBody参数 当dualAuth为true时,加载的客户端证书链

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    请求示例

    POST /v1/blb/lb-j8UqijYf/SSLlistener?clientToken=asdfg HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
    
    {
        "listenerPort":95,
        "backendPort":95,
        "scheduler":"LeastConnection",
        "healthCheckTimeoutInSecond":4,
        "healthCheckInterval":5,
        "unhealthyThreshold":2,
        "certIds":["cert-zfj2ey2z4kmm"]
    }

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Wed, 10 Apr 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS

    DescribeTCPListeners查询TCP监听器

    描述

    • 查询指定LoadBalancer下所有TCP监听器的信息
    • 支持按监听器端口进行匹配查询
    • 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定

    请求结构

    GET /v{version}/blb/{blbId}/TCPlistener?listenerPort={listenerPort}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    listenerPort int Query参数 要查询的监听器端口
    marker String Query参数 批量获取列表的查询的起始位置,是一个由系统生成的字符串
    maxKeys int Query参数 每页包含的最大数量,最大数量不超过1000。缺省值为1000

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    参数名称 类型 描述
    listenerList List<TCPListenerModel> 包含查询结果的列表
    marker string 标记查询的起始位置,若结果列表为空,此项不存在
    isTruncated boolean true表示后面还有数据,false表示已经是最后一页
    nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
    maxKeys int 每页包含的最大数量

    请求示例

    GET /v1/blb/lb-j8UqijYf/TCPlistener?maxKeys=2 HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Wed, 10 Apr 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS
    
    {
        "listenerList": [
            {
                "listenerPort": 80,
                "backendPort": 80,
                "scheduler": "RoundRobin",
                "healthCheckTimeoutInSecond": 3,
                "healthCheckInterval": 3,
                "unhealthyThreshold": 3,
                "healthyThreshold": 3
            },
            {
                "listenerPort": 88,
                "backendPort": 88,
                "scheduler": "RoundRobin",
                "healthCheckTimeoutInSecond": 2,
                "healthCheckInterval": 4,
                "unhealthyThreshold": 3,
                "healthyThreshold": 3
            }
        ],
        "marker": "listener-0050",
        "nextMarker": null,
        "isTruncated": false,
        "maxKeys": 2
    }

    DescribeUDPListeners查询UDP监听器

    描述

    • 查询指定LoadBalancer下所有UDP监听器的信息
    • 支持按监听器端口进行匹配查询
    • 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定

    请求结构

    GET /v{version}/blb/{blbId}/UDPlistener?listenerPort={listenerPort}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    listenerPort int Query参数 要查询的监听器端口
    marker String Query参数 批量获取列表的查询的起始位置,是一个由系统生成的字符串
    maxKeys int Query参数 每页包含的最大数量,最大数量不超过1000。缺省值为1000

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    参数名称 类型 描述
    listenerList List<UDPListenerModel> 包含查询结果的列表
    marker string 标记查询的起始位置,若结果列表为空,此项不存在
    isTruncated boolean true表示后面还有数据,false表示已经是最后一页
    nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
    maxKeys int 每页包含的最大数量

    请求示例

    GET /v1/blb/lb-j8UqijYf/UDPlistener?maxKeys=2 HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Wed, 10 Apr 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS
    
    {
        "listenerList": [
            {
                "listenerPort": 80,
                "backendPort": 80,
                "scheduler": "RoundRobin",
                "healthCheckTimeoutInSecond": 3,
                "healthCheckInterval": 3,
                "unhealthyThreshold": 3,
                "healthyThreshold": 3,
    			"healthCheckString":"health check"
            },
            {
                "listenerPort": 88,
                "backendPort": 88,
                "scheduler": "RoundRobin",
                "healthCheckTimeoutInSecond": 2,
                "healthCheckInterval": 4,
                "unhealthyThreshold": 3,
                "healthyThreshold": 3,
    			"healthCheckString":"health check"
            }
        ],
        "marker": "listener-0050",
        "nextMarker": null,
        "isTruncated": false,
        "maxKeys": 2
    }

    DescribeHTTPListeners查询HTTP监听器

    描述

    • 查询指定LoadBalancer下所有HTTP监听器的信息
    • 支持按监听器端口进行匹配查询
    • 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定

    请求结构

    GET /v{version}/blb/{blbId}/HTTPlistener?listenerPort={listenerPort}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    listenerPort int Query参数 要查询的监听器端口
    marker String Query参数 批量获取列表的查询的起始位置,是一个由系统生成的字符串
    maxKeys int Query参数 每页包含的最大数量,最大数量不超过1000。缺省值为1000

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    参数名称 类型 描述
    listenerList List<HTTPListenerModel> 包含查询结果的列表
    marker string 标记查询的起始位置,若结果列表为空,此项不存在
    isTruncated boolean true表示后面还有数据,false表示已经是最后一页
    nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
    maxKeys int 每页包含的最大数量

    请求示例

    GET /v1/blb/lb-j8UqijYf/HTTPlistener?maxKeys=2 HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Fri, 03 Jun 2016 06:42:44 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS
    
    {
        "listenerList": [
            {
                "listenerPort": 90,
                "backendPort": 90,
                "scheduler": "LeastConnection",
                "healthCheckTimeoutInSecond": 4,
                "healthCheckInterval": 5,
                "unhealthyThreshold": 2,
                "healthyThreshold": 3,
                "keepSession": false,
                "keepSessionType": null,
                "keepSessionDuration": null,
                "keepSessionCookieName": null,
                "xForwardFor": false,
                "healthCheckType": "HTTP",
                "healthCheckPort": 90,
                "healthCheckURI": "/",
                "healthCheckNormalStatus": "http_2xx|http_3xx",
                "serverTimeout": 30,
    			"redirectPort": 80
            },
            {
                "listenerPort": 95,
                "backendPort": 95,
                "scheduler": "LeastConnection",
                "healthCheckTimeoutInSecond": 4,
                "healthCheckInterval": 5,
                "unhealthyThreshold": 2,
                "healthyThreshold": 3,
                "keepSession": false,
                "keepSessionType": null,
                "keepSessionDuration": null,
                "keepSessionCookieName": null,
                "xForwardFor": false,
                "healthCheckType": "HTTP",
                "healthCheckPort": 95,
                "healthCheckURI": "/",
                "healthCheckNormalStatus": "http_1xx|http_2xx",
                "serverTimeout": 1800,
    			"redirectPort": 80
            }
        ],
        "marker": "listener-005A",
        "nextMarker": "listener-0322",
        "isTruncated": true,
        "maxKeys": 2
    }

    DescribeHTTPSListeners查询HTTPS监听器

    描述

    • 查询指定LoadBalancer下所有HTTPS监听器的信息
    • 支持按监听器端口进行匹配查询
    • 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定

    请求结构

    GET /v{version}/blb/{blbId}/HTTPSlistener?listenerPort={listenerPort}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    listenerPort int Query参数 要查询的监听器端口
    marker String Query参数 批量获取列表的查询的起始位置,是一个由系统生成的字符串
    maxKeys int Query参数 每页包含的最大数量,最大数量不超过1000。缺省值为1000

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    参数名称 类型 描述
    listenerList List<HTTPSListenerModel> 包含查询结果的列表
    marker string 标记查询的起始位置,若结果列表为空,此项不存在
    isTruncated boolean true表示后面还有数据,false表示已经是最后一页
    nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
    maxKeys int 每页包含的最大数量

    请求示例

    GET /v1/blb/lb-j8UqijYf/HTTPSlistener?maxKeys=2 HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string

    响应示例

    HTTP/1.1 200 OK x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09 Date: Fri, 03 Jun 2016 06:42:44 GMT Transfer-Encoding: chunked Content-Type: application/json;charset=UTF-8 Server: BWS

    {
        "listenerList": [
            {
                "listenerPort": 90,
                "backendPort": 90,
                "scheduler": "LeastConnection",
                "healthCheckTimeoutInSecond": 4,
                "healthCheckInterval": 5,
                "unhealthyThreshold": 2,
                "healthyThreshold": 3,
                "keepSession": false,
                "keepSessionType": null,
                "keepSessionDuration": null,
                "keepSessionCookieName": null,
                "xForwardFor": false,
                "healthCheckType": "HTTP",
                "healthCheckPort": 90,
                "healthCheckURI": "/",
                "healthCheckNormalStatus": "http_2xx|http_3xx",
                "serverTimeout": 30,
    			"certIds": ["cert-zfj2ey2z4kmm"],
    			"ie6Compatible": true
            },
            {
                "listenerPort": 95,
                "backendPort": 95,
                "scheduler": "LeastConnection",
                "healthCheckTimeoutInSecond": 4,
                "healthCheckInterval": 5,
                "unhealthyThreshold": 2,
                "healthyThreshold": 3,
                "keepSession": false,
                "keepSessionType": null,
                "keepSessionDuration": null,
                "keepSessionCookieName": null,
                "xForwardFor": false,
                "healthCheckType": "HTTP",
                "healthCheckPort": 95,
                "healthCheckURI": "/",
                "healthCheckNormalStatus": "http_1xx|http_2xx",
                "serverTimeout": 1800,
    			"certIds": ["cert-zfj2ey2z4kmm"],
    			"ie6Compatible": true
            }
        ],
        "marker": "listener-005A",
        "nextMarker": "listener-0322",
        "isTruncated": true,
        "maxKeys": 2
    }

    DescribeSSLListeners查询SSL监听器

    描述

    • 查询指定LoadBalancer下所有SSL监听器的信息
    • 支持按监听器端口进行匹配查询
    • 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定

    请求结构

    GET /v{version}/blb/{blbId}/SSLlistener?listenerPort={listenerPort}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    listenerPort int Query参数 要查询的监听器端口
    marker String Query参数 批量获取列表的查询的起始位置,是一个由系统生成的字符串
    maxKeys int Query参数 每页包含的最大数量,最大数量不超过1000。缺省值为1000

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    参数名称 类型 描述
    listenerList List<SSLListenerModel> 包含查询结果的列表
    marker String 标记查询的起始位置,若结果列表为空,此项不存在
    isTruncated boolean true表示后面还有数据,false表示已经是最后一页
    nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
    maxKeys int 每页包含的最大数量

    请求示例

    GET /v1/blb/lb-j8UqijYf/SSLlistener?maxKeys=2 HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Wed, 10 Apr 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS
    
    {
        "listenerList": [
            {
                "listenerPort": 80,
                "backendPort": 80,
                "scheduler": "RoundRobin",
                "healthCheckTimeoutInSecond": 3,
                "healthCheckInterval": 3,
                "unhealthyThreshold": 3,
                "healthyThreshold": 3
            },
            {
                "listenerPort": 88,
                "backendPort": 88,
                "scheduler": "RoundRobin",
                "healthCheckTimeoutInSecond": 2,
                "healthCheckInterval": 4,
                "unhealthyThreshold": 3,
                "healthyThreshold": 3
            }
        ],
        "marker": "listener-0050",
        "nextMarker": null,
        "isTruncated": false,
        "maxKeys": 2
    }

    UpdateTCPListener更新TCP监听器

    描述

    更新指定LoadBalancer下的TCP监听器参数,请求参数中所有指定的字段都会被更新,未指定的字段保持不变,监听器通过端口指定。

    请求结构

    PUT /v{version}/blb/{blbId}/TCPlistener?listenerPort={listenerPort}&clientToken={clientToken} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string
    
    {
        "backendPort":backendPort,
        "scheduler":scheduler,
        "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
        "healthCheckInterval":healthCheckInterval,
        "unhealthyThreshold":unhealthyThreshold,
        "healthyThreshold":healthyThreshold
    }

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    listenerPort int Query参数 要更新的监听器端口,需为1-65535间的整数
    backendPort int RequestBody参数 后端服务器的监听端口,需为1-65535间的整数
    scheduler String RequestBody参数 负载均衡算法,支持3种方式:"RoundRobin"/"LeastConnection"/"Hash"
    healthCheckTimeoutInSecond int RequestBody参数 健康检查超时(单位:秒),默认为3,需为1-60间的整数
    healthCheckInterval int RequestBody参数 健康检查间隔(单位:秒),默认为3,需为1-10间的整数
    unhealthyThreshold int RequestBody参数 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器。默认为3,需为2-5间的整数
    healthyThreshold int RequestBody参数 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用。默认为3,需为2-5间的整数

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    请求示例

    PUT /v1/blb/lb-j8UqijYf/TCPlistener?listenerPort=80&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
    
    {
        "backendPort":95,
        "scheduler":"LeastConnection",
        "healthCheckTimeoutInSecond":4,
        "healthCheckInterval":5,
        "unhealthyThreshold":2
    }

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Wed, 10 Apr 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS

    UpdateUDPListener更新UDP监听器

    描述

    • 更新指定LoadBalancer下的UDP监听器参数,所有请求参数中指定的域都会被更新,未指定的域保持不变,监听器通过端口指定。

    请求结构

    PUT /v{version}/blb/{blbId}/UDPlistener?listenerPort={listenerPort} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string
    
    {
        "backendPort":backendPort,
        "scheduler":scheduler,
        "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
        "healthCheckInterval":healthCheckInterval,
        "unhealthyThreshold":unhealthyThreshold,
        "healthyThreshold":healthyThreshold,
        "healthCheckString":"health check"
    }

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    listenerPort int Query参数 监听器的监听端口,需为1-65535间的整数
    backendPort int RequestBody参数 后端服务器的监听端口,需为1-65535间的整数
    scheduler String RequestBody参数 负载均衡算法,支持3种方式:"RoundRobin"/"LeastConnection"/"Hash"
    healthCheckTimeoutInSecond int RequestBody参数 健康检查超时(单位:秒),默认为3,需为1-60间的整数
    healthCheckInterval int RequestBody参数 健康检查间隔(单位:秒),默认为3,需为1-10间的整数
    unhealthyThreshold int RequestBody参数 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器。默认为3,需为2-5间的整数
    healthyThreshold int RequestBody参数 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用。默认为3,需为2-5间的整数
    healthCheckString String RequestBody参数 健康发送的请求字符串,后端服务器收到后需要进行应答,支持标准转义如\00、\xf2,方便配置二进制格式请求

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    请求示例

    POST /v1/blb/lb-j8UqijYf/UDPlistener?clientToken=asdfg HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
    
    {
        "listenerPort":95,
        "backendPort":95,
        "scheduler":"LeastConnection",
        "healthCheckTimeoutInSecond":4,
        "healthCheckInterval":5,
        "unhealthyThreshold":2,
    	"healthCheckString":"health check"
    }

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Wed, 10 Apr 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS

    UpdateHTTPListener更新HTTP监听器

    描述

    更新指定LoadBalancer下的HTTP监听器参数,所有请求参数中指定的域都会被更新,未指定的域保持不变,监听器通过端口指定。

    请求结构

    PUT /v{version}/blb/{blbId}/HTTPlistener?listenerPort={listenerPort}&clientToken={clientToken} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string
    
    {
        "backendPort":backendPort,
        "scheduler":scheduler,
        "keepSession":keepSession,
        "keepSessionType":keepSessionType,
        "keepSessionDuration":keepSessionDuration,
        "keepSessionCookieName":keepSessionCookieName,
        "xForwardFor":xForwardFor,        
        "healthCheckType":healthCheckType,
        "healthCheckPort":healthCheckPort,
        "healthCheckURI":healthCheckURI,
        "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
        "healthCheckInterval":healthCheckInterval,
        "unhealthyThreshold":unhealthyThreshold,
        "healthyThreshold":healthyThreshold,
        "healthCheckNormalStatus":healthCheckNormalStatus,
        "serverTimeout":serverTimeout,
        "redirectPort":redirectPort
    }

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    listenerPort int Query参数 要更新的监听器端口,需为1-65535间的整数
    backendPort int RequestBody参数 后端服务器的监听端口,需为1-65535间的整数
    scheduler String RequestBody参数 负载均衡算法,支持2种方式:"RoundRobin"/"LeastConnection"
    keepSession bool RequestBody参数 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器,默认关闭
    keepSessionType String RequestBody参数 会话保持的cookie处理方式,当且仅当开启会话保持时有效,支持"insert"/"rewrite",默认"insert"
    keepSessionDuration int RequestBody参数 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效,默认3600s,需为1-15552000间的整数
    keepSessionCookieName String RequestBody参数 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效
    xForwardFor bool RequestBody参数 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址,默认关闭
    healthCheckType String RequestBody参数 健康检查协议,支持"HTTP"/"TCP",默认HTTP
    healthCheckPort int RequestBody参数 健康检查端口,默认为backendPort
    healthCheckURI String RequestBody参数 健康检查URI,默认/。当健康检查协议为"HTTP"时生效
    healthCheckTimeoutInSecond int RequestBody参数 健康检查超时(单位:秒),默认为3,需为1-60间的整数
    healthCheckInterval int RequestBody参数 健康检查间隔(单位:秒),默认为3,需为1-10间的整数
    unhealthyThreshold int RequestBody参数 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器。默认为3,需为2-5间的整数
    healthyThreshold int RequestBody参数 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用。默认为3,需为2-5间的整数
    healthCheckNormalStatus String RequestBody参数 健康检查正常时的HTTP状态码,支持5类状态码的组合,例如"http_1xx|http_2xx",默认"http_2xx|http_3xx"。当健康检查协议为"HTTP"时生效
    serverTimeout int RequestBody参数 后端服务器最大超时(单位:秒),默认30s,需为1-3600间的整数
    redirectPort int RequestBody参数 将此监听器收到的请求转发到HTTPS监听器,HTTPS监听器通过这个端口指定

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    请求示例

    PUT /v1/blb/lb-j8UqijYf/HTTPlistener?listenerPort=8080&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
    
    {
        "backendPort":95,
        "scheduler":"LeastConnection",
        "healthCheckTimeoutInSecond":4,
        "healthCheckInterval":5,
        "unhealthyThreshold":2,
        "xForwardFor":true,
        "healthCheckType":"HTTP",
        "serverTimeout":1800,
        "healthCheckNormalStatus":"http_1xx|http_2xx"
    }

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Wed, 10 Apr 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS

    UpdateHTTPSListener更新HTTPS监听器

    描述

    更新指定LoadBalancer下的HTTPS监听器参数,所有请求参数中指定的域都会被更新,未指定的域保持不变,监听器通过端口指定。

    请求结构

    PUT /v{version}/blb/{blbId}/HTTPSlistener?listenerPort={listenerPort}&clientToken={clientToken} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string
    
    {
        "backendPort":backendPort,
        "scheduler":scheduler,
        "keepSession":keepSession,
        "keepSessionType":keepSessionType,
        "keepSessionDuration":keepSessionDuration,
        "keepSessionCookieName":keepSessionCookieName,
        "xForwardFor":xForwardFor,        
        "healthCheckType":healthCheckType,
        "healthCheckPort":healthCheckPort,
        "healthCheckURI":healthCheckURI,
        "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
        "healthCheckInterval":healthCheckInterval,
        "unhealthyThreshold":unhealthyThreshold,
        "healthyThreshold":healthyThreshold,
        "healthCheckNormalStatus":healthCheckNormalStatus,
        "serverTimeout":serverTimeout,
        "certIds":[id1, id2],
        "ie6Compatible":true
    }

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    listenerPort int Query参数 要更新的监听器端口,需为1-65535间的整数
    backendPort int RequestBody参数 后端服务器的监听端口,需为1-65535间的整数
    scheduler String RequestBody参数 负载均衡算法,支持2种方式:"RoundRobin"/"LeastConnection"
    keepSession bool RequestBody参数 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器,默认关闭
    keepSessionType String RequestBody参数 会话保持的cookie处理方式,当且仅当开启会话保持时有效,支持"insert"/"rewrite",默认"insert"
    keepSessionDuration int RequestBody参数 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效,默认3600s,需为1-15552000间的整数
    keepSessionCookieName String RequestBody参数 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效
    xForwardFor bool RequestBody参数 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址,默认关闭
    healthCheckType String RequestBody参数 健康检查协议,支持"HTTP"/"TCP",默认HTTP
    healthCheckPort int RequestBody参数 健康检查端口,默认为backendPort
    healthCheckURI String RequestBody参数 健康检查URI,默认/。当健康检查协议为"HTTP"时生效
    healthCheckTimeoutInSecond int RequestBody参数 健康检查超时(单位:秒),默认为3,需为1-60间的整数
    healthCheckInterval int RequestBody参数 健康检查间隔(单位:秒),默认为3,需为1-10间的整数
    unhealthyThreshold int RequestBody参数 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器。默认为3,需为2-5间的整数
    healthyThreshold int RequestBody参数 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用。默认为3,需为2-5间的整数
    healthCheckNormalStatus String RequestBody参数 健康检查正常时的HTTP状态码,支持5类状态码的组合,例如"http_1xx|http_2xx",默认"http_2xx|http_3xx"。当健康检查协议为"HTTP"时生效
    serverTimeout int RequestBody参数 后端服务器最大超时(单位:秒),默认30s,需为1-3600间的整数
    certIds List<int> RequestBody参数 监听器要加载的证书链
    ie6Compatible bool RequestBody参数 是否兼容IE6的HTTPS请求(协议格式为较早的SSL3.0,安全性较差),默认开启

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    请求示例

    PUT /v1/blb/lb-j8UqijYf/HTTPSlistener?listenerPort=88&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
    
    {
        "backendPort":95,
        "scheduler":"LeastConnection",
        "healthCheckTimeoutInSecond":4,
        "healthCheckInterval":5,
        "unhealthyThreshold":2,
        "xForwardFor":true,
        "healthCheckType":"HTTP",
        "serverTimeout":1800,
        "healthCheckNormalStatus":"http_1xx|http_2xx"
    }

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Wed, 10 Apr 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS

    UpdateSSLListener更新SSL监听器

    描述

    • 更新指定LoadBalancer下的SSL监听器参数,所有请求参数中指定的域都会被更新,未指定的域保持不变,监听器通过端口指定。

    请求结构

    PUT /v{version}/blb/{blbId}/SSLlistener?listenerPort={listenerPort} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string
    
    {
        "backendPort":backendPort,
        "scheduler":scheduler,
        "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
        "healthCheckInterval":healthCheckInterval,
        "unhealthyThreshold":unhealthyThreshold,
        "healthyThreshold":healthyThreshold,
        "certIds":[id1, id2],
        "ie6Compatible":true,
        "encryptionType":encryptionType,
        "encryptionProtocols":[protocal1, protacal2],
        "dualAuth":false,
        "clientCertIds":[id1, id2]
    }

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    listenerPort int Query参数 要更新的监听器端口,需为1-65535间的整数
    backendPort int RequestBody参数 后端服务器的监听端口,需为1-65535间的整数
    scheduler String RequestBody参数 负载均衡算法,支持3种方式:"RoundRobin"/"LeastConnection"/"Hash"
    healthCheckTimeoutInSecond int RequestBody参数 健康检查超时(单位:秒),默认为3,需为1-60间的整数
    healthCheckInterval int RequestBody参数 健康检查间隔(单位:秒),默认为3,需为1-10间的整数
    unhealthyThreshold int RequestBody参数 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器。默认为3,需为2-5间的整数
    healthyThreshold int RequestBody参数 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用。默认为3,需为2-5间的整数
    certIds List\<int> RequestBody参数 监听器要加载的证书链
    ie6Compatible boolean RequestBody参数 是否兼容IE6的HTTPS请求(协议格式为较早的SSL3.0,安全性较差),默认开启
    encryptionType String RequestBody参数 加密选项,支持三种类型:compatibleIE/incompatibleIE/userDefind,分别对应:兼容IE的加密方式/禁用不安全的加密方式/自定义加密方式,当encryptionType有值且合法时ie6Compatible字段传值不生效
    encryptionProtocols List\<String> RequestBody参数 当encryptionType值为userDefind时协议类型列表,是以"sslv3"、"tlsv10"、"tlsv11"、"tlsv12"四种协议组合形成的字符串列表
    dualAuth boolean RequestBody参数 是否开启双向认证,默认为关闭
    clientCertIds List\<String> RequestBody参数 当dualAuth为true时,加载的客户端证书链

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    请求示例

    POST /v1/blb/lb-j8UqijYf/SSLlistener?clientToken=asdfg HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
    
    {
        "listenerPort":95,
        "backendPort":95,
        "scheduler":"LeastConnection",
        "healthCheckTimeoutInSecond":4,
        "healthCheckInterval":5,
        "unhealthyThreshold":2,
        "certIds":["cert-zfj2ey2z4kmm"]
    }

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Wed, 10 Apr 2016 08:26:52 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS

    DeleteListeners释放监听器

    描述

    • 释放指定LoadBalancer下的监听器,监听器通过监听端口来指定
    • 支持批量释放

    请求结构

    PUT /v{version}/blb/{blbId}/listener?{action}&clientToken={clientToken} HTTP/1.1
    Host: blb.bj.baidubce.com
    Authorization: authorization string
    
    {
        "portList":[port1,port2,...]
    }

    请求头域

    除公共头域外,无其他特殊头域

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号,当前取值1
    blbId String URL参数 所属LoadBalancer的标识符
    action String URL参数 batchdelete
    clientToken String Query参数 幂等性Token,长度不超过64位
    portList List<int> RequestBody参数 所有待释放的监听器的端口,一起组成一个数组

    返回状态码

    成功返回200,失败返回见错误码

    返回头域

    除公共头域外,无其他特殊头域

    返回参数

    请求示例

    PUT /v1/blb/lb-j8UqijYf/listener?batchdelete&clientToken=clienttokentest
    Host: blb.bj.baidubce.com
    Authorization: authorization string
    
    {
        "portList":[80,87]
    }

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
    Date: Fri, 03 Jun 2016 03:54:29 GMT
    Transfer-Encoding: chunked
    Content-Type: application/json;charset=UTF-8
    Server: BWS
    上一篇
    普通型BLB实例相关接口
    下一篇
    普通型BLB后端服务器相关接口