普通型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"
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"
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

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 int 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\ RequestBody参数 监听器要加载的证书链
ie6Compatible boolean RequestBody参数 是否兼容IE6的HTTPS请求(协议格式为较早的SSL3.0,安全性较差),默认开启
encryptionType String RequestBody参数 加密选项,支持三种类型:compatibleIE/incompatibleIE/userDefind,分别对应:兼容IE的加密方式/禁用不安全的加密方式/自定义加密方式,当encryptionType有值且合法时ie6Compatible字段传值不生效
encryptionProtocols List\ RequestBody参数 当encryptionType值为userDefind时协议类型列表,是以"sslv3"、"tlsv10"、"tlsv11"、"tlsv12"四种协议组合形成的字符串列表
dualAuth boolean RequestBody参数 是否开启双向认证,默认为关闭
clientCertIds List\ 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"
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\ RequestBody参数 监听器要加载的证书链
ie6Compatible boolean RequestBody参数 是否兼容IE6的HTTPS请求(协议格式为较早的SSL3.0,安全性较差),默认开启
encryptionType String RequestBody参数 加密选项,支持三种类型:compatibleIE/incompatibleIE/userDefind,分别对应:兼容IE的加密方式/禁用不安全的加密方式/自定义加密方式,当encryptionType有值且合法时ie6Compatible字段传值不生效
encryptionProtocols List\ RequestBody参数 当encryptionType值为userDefind时协议类型列表,是以"sslv3"、"tlsv10"、"tlsv11"、"tlsv12"四种协议组合形成的字符串列表
dualAuth boolean RequestBody参数 是否开启双向认证,默认为关闭
clientCertIds List\ 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