普通型BLB监听器相关接口
更新时间：2025-08-21
CreateTCPListener创建TCP监听器
描述
- 在指定LoadBalancer下，创建一个基于TCP协议的监听器，监听一个前端端口，将发往该端口的所有TCP流量，转发到后端服务器监听的后端端口上。TCP监听器只支持TCP协议的健康检查，检查端口和后端服务器监听端口一致。
请求结构
Plain Text
1POST /v{version}/blb/{blbId}/TCPlistener?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "listenerPort":listenerPort,
7 "backendPort":backendPort,
8 "scheduler":scheduler,
9 "tcpSessionTimeout":tcpSessionTimeout,
10 "healthCheckType":healthCheckType,
11 "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
12 "healthCheckInterval":healthCheckInterval,
13 "unhealthyThreshold":unhealthyThreshold,
14 "healthyThreshold":healthyThreshold
15}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1 |
| blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
| listenerPort | int | 是 | RequestBody参数 | 监听器的监听端口，需为1-65535间的整数 |
| backendPort | int | 是 | RequestBody参数 | 后端服务器的监听端口，需为1-65535间的整数 |
| scheduler | String | 是 | RequestBody参数 | 负载均衡算法，支持3种方式："RoundRobin"/"WeightLeastConn"/"Hash"，"RoundRobin"代表加权轮询、"WeightLeastConn"代表加权最小连接、"Hash"代表根据源ip哈希 |
| tcpSessionTimeout | int | 否 | RequestBody参数 | tcp设置连接超时时间（单位：秒），默认900，需为10-4000间的整数 |
| healthCheckType | String | 否 | RequestBody参数 | 健康检查协议类型，默认"TCP" |
| 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，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
无
请求示例
Plain Text
1POST /v1/blb/lb-j8UqijYf/TCPlistener?clientToken=asdfg HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "listenerPort":95,
7 "backendPort":95,
8 "scheduler":"LeastConnection",
9 "tcpSessionTimeout":900,
10 "healthCheckType":"TCP",
11 "healthCheckTimeoutInSecond":4,
12 "healthCheckInterval":5,
13 "unhealthyThreshold":2,
14 "healthyThreshold":3
15}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWSCreateUDPListener创建UDP监听器
描述
- 在指定LoadBalancer下，创建一个基于UDP协议的监听器，监听一个前端端口，将发往该端口的所有UDP流量，转发到后端服务器监听的后端端口上。UDP监听器支持UDP、ICMP协议的健康检查，检查端口和后端服务器监听端口一致。
请求结构
Plain Text
1POST /v{version}/blb/{blbId}/UDPlistener?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "listenerPort":listenerPort,
7 "backendPort":backendPort,
8 "scheduler":scheduler,
9 "healthCheckType":healthCheckType,
10 "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
11 "healthCheckInterval":healthCheckInterval,
12 "unhealthyThreshold":unhealthyThreshold,
13 "healthyThreshold":healthyThreshold,
14 "healthCheckString":healthCheck,
15 "udpSessionTimeout":udpSessionTimeout
16}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| 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"/"WeightLeastConn"/"Hash"，"RoundRobin"代表加权轮询、"WeightLeastConn"代表加权最小连接、"Hash"代表根据源ip哈希 |
| healthCheckType | String | 否 | RequestBody参数 | 健康检查协议类型，支持"UDP"/"ICMP"，默认"UDP" |
| healthCheckString | String | 否 | RequestBody参数 | 健康发送的请求字符串，后端服务器收到后需要进行应答，支持16进制\00-\FF和标准ASCII字符串，最大长度1299，健康检查协议为"UDP"时必传 |
| healthCheckTimeoutInSecond | int | 否 | RequestBody参数 | 健康检查超时（单位：秒），默认为3，需为1-60间的整数 |
| healthCheckInterval | int | 否 | RequestBody参数 | 健康检查间隔（单位：秒），默认为3，需为1-10间的整数 |
| unhealthyThreshold | int | 否 | RequestBody参数 | 不健康阈值，即连续多少次健康检查失败后，屏蔽该后端服务器。默认为3，需为2-5间的整数 |
| healthyThreshold | int | 否 | RequestBody参数 | 健康阈值，即连续多少次健康检查成功后，重新将该后端服务器置为可用。默认为3，需为2-5间的整数 |
| udpSessionTimeout | int | 否 | RequestBody参数 | udp会话超时时间。默认为90，需为5-4000间的整数，单位秒 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
无
请求示例
Plain Text
1POST /v1/blb/lb-j8UqijYf/UDPlistener?clientToken=asdfg HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "listenerPort":95,
7 "backendPort":95,
8 "scheduler":"LeastConnection",
9 "healthCheckType":"UDP",
10 "healthCheckString":"healthCheck",
11 "healthCheckTimeoutInSecond":4,
12 "healthCheckInterval":5,
13 "unhealthyThreshold":2,
14 "healthyThreshold":3,
15 "udpSessionTimeout":90
16}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWSCreateHTTPListener创建HTTP监听器
描述
- 在指定LoadBalancer下，创建一个基于HTTP协议的监听器，监听一个前端端口，将发往该端口的所有HTTP请求，转发到后端服务器监听的后端端口上
请求结构
Plain Text
1POST /v{version}/blb/{blbId}/HTTPlistener?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "listenerPort":listenerPort,
7 "backendPort":backendPort,
8 "scheduler":scheduler,
9 "keepSession":keepSession,
10 "keepSessionType":keepSessionType,
11 "keepSessionDuration":keepSessionDuration,
12 "keepSessionCookieName":keepSessionCookieName,
13 "xForwardFor":xForwardFor,
14 "xForwardedProto":xForwardedProto
15 "healthCheckType":healthCheckType,
16 "healthCheckPort":healthCheckPort,
17 "healthCheckURI":healthCheckURI,
18 "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
19 "healthCheckInterval":healthCheckInterval,
20 "unhealthyThreshold":unhealthyThreshold,
21 "healthyThreshold":healthyThreshold,
22 "healthCheckNormalStatus":healthCheckNormalStatus,
23 "healthCheckHost":healthCheckHost,
24 "serverTimeout":serverTimeout,
25 "redirectPort":redirectPort
26}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| 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"，"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端的真实地址，默认关闭 |
| xForwardedProto | bool | 否 | RequestBody参数 | 将监听使用的协议通过 x-forwarded-proto HTTP Header 转发给后端服务器 |
| 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"时生效 |
| healthCheckHost | String | 否 | RequestBody参数 | 7层健康检查请求的头部域会带指定的host字段，例如"localhost"，默认""。当健康检查协议为"HTTP"时生效 |
| serverTimeout | int | 否 | RequestBody参数 | 后端服务器最大超时（单位：秒），默认30s，需为1-3600间的整数 |
| redirectPort | int | 否 | RequestBody参数 | 将此监听器收到的请求转发到HTTPS监听器，HTTPS监听器通过这个端口指定 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
无
请求示例
Plain Text
1POST /v1/blb/lb-j8UqijYf/HTTPlistener?clientToken=asdfg HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "listenerPort":95,
7 "backendPort":95,
8 "scheduler":"LeastConnection",
9 "healthCheckTimeoutInSecond":4,
10 "healthCheckInterval":5,
11 "unhealthyThreshold":2,
12 "xForwardFor":true,
13 "xForwardedProto":true,
14 "healthCheckType":"HTTP",
15 "serverTimeout":1800,
16 "healthCheckNormalStatus":"http_1xx|http_2xx",
17 "healthCheckHost":"localhost",
18 "redirectPort":80
19}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWSCreateHTTPSListener创建HTTPS监听器
描述
在指定LoadBalancer下，创建一个基于HTTPS协议的监听器，监听一个前端端口，将发往该端口的所有HTTPS请求，先通过SSL卸载转换为HTTP请求后，再转发到后端服务器监听的后端端口上。
请求结构
Plain Text
1POST /v{version}/blb/{blbId}/HTTPSlistener?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "listenerPort":listenerPort,
7 "backendPort":backendPort,
8 "scheduler":scheduler,
9 "keepSession":keepSession,
10 "keepSessionType":keepSessionType,
11 "keepSessionDuration":keepSessionDuration,
12 "keepSessionCookieName":keepSessionCookieName,
13 "xForwardFor":xForwardFor,
14 "xForwardedProto":xForwardedProto
15 "healthCheckType":healthCheckType,
16 "healthCheckPort":healthCheckPort,
17 "healthCheckURI":healthCheckURI,
18 "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
19 "healthCheckInterval":healthCheckInterval,
20 "unhealthyThreshold":unhealthyThreshold,
21 "healthyThreshold":healthyThreshold,
22 "healthCheckNormalStatus":healthCheckNormalStatus,
23 "healthCheckHost":healthCheckHost,
24 "serverTimeout":serverTimeout,
25 "certIds":[certId],
26 "encryptionType":encryptionType,
27 "encryptionProtocols":[protocol1, protacol2],
28 "dualAuth":false,
29 "clientCertIds":[clientCertId],
30 "additionalCertDomains":[{"certId":certId,"host":host}]
31}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| 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"，"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端的真实地址，默认关闭 |
| xForwardedProto | boolean | 否. | RequestBody参数 | 将监听使用的协议通过x-forwarded-proto HTTP Header 转发给后端服务器 |
| 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"时生效 |
| healthCheckHost | String | 否 | RequestBody参数 | 7层健康检查请求的头部域会带指定的host字段，例如"localhost"，默认""。当健康检查协议为"HTTP"时生效 |
| serverTimeout | int | 否 | RequestBody参数 | 后端服务器最大超时（单位：秒），默认30s，需为1-3600间的整数 |
| certIds | List<String> | 是 | RequestBody参数 | 监听器要加载的证书,当前仅允许传入1个证书ID，如果传入多个，则只有最后一个生效 |
| encryptionType | String | 否 | RequestBody参数 | 加密选项，默认tls_cipher_policy_default。支持：tls_cipher_policy_default/tls_cipher_policy_1_1/tls_cipher_policy_1_2/tls_cipher_policy_1_2_secure/userDefind，对应的加密协议和加密套件参见：encryption |
| encryptionProtocols | List<String> | 否 | RequestBody参数 | 当encryptionType值为userDefind时协议类型列表，是以"tlsv10"、"tlsv11"、"tlsv12"三种协议组合形成的字符串列表 |
| appliedCiphers | String | 否 | RequestBody参数 | 加密套件参见：encryption，不同加密套件用冒号":"隔开 |
| dualAuth | boolean | 否 | RequestBody参数 | 是否开启双向认证，默认为关闭 |
| clientCertIds | List<String> | 否 | RequestBody参数 | 当dualAuth为true时，加载的客户端证书链，当前仅允许传入1个证书ID，如果传入多个，则只有最后一个生效 |
| additionalCertDomains | List<AdditionalCertDomain> | 否 | RequestBody参数 | 扩展域名 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
无
Plain Text
1POST /v1/blb/lb-j8UqijYf/HTTPSlistener?clientToken=asdfg HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "listenerPort":95,
7 "backendPort":95,
8 "scheduler":"LeastConnection",
9 "healthCheckTimeoutInSecond":4,
10 "healthCheckInterval":5,
11 "unhealthyThreshold":2,
12 "healthyThreshold":3,
13 "xForwardFor":true,
14 "xForwardedProto": true,
15 "healthCheckType":"HTTP",
16 "serverTimeout":1800,
17 "healthCheckNormalStatus":"http_1xx|http_2xx",
18 "healthCheckHost":"localhost",
19 "certIds":["cert-zfj2ey2z4kmm"]
20}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWSCreateSSLListener创建SSL监听器
描述
- 在指定LoadBalancer下，创建一个基于SSL协议的监听器，监听一个前端端口，将发往该端口的所有SSL流量，通过SSL卸载转换为TCP请求后转发到后端服务器监听的后端端口上。SSL监听器只支持TCP协议的健康检查，检查端口和后端服务器监听端口一致。
请求结构
Plain Text
1POST /v{version}/blb/{blbId}/SSLlistener?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "listenerPort":listenerPort,
7 "backendPort":backendPort,
8 "scheduler":scheduler,
9 "healthCheckType":healthCheckType,
10 "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
11 "healthCheckInterval":healthCheckInterval,
12 "unhealthyThreshold":unhealthyThreshold,
13 "healthyThreshold":healthyThreshold,
14 "certIds":[certId],
15 "encryptionType":encryptionType,
16 "encryptionProtocols":[protocol1, protacol2],
17 "dualAuth":false,
18 "clientCertIds":[clientCertId]
19}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| 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"，"RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"Hash"代表根据源ip哈希 |
| healthCheckType | String | 否 | RequestBody参数 | 健康检查协议类型，默认"TCP" |
| 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参数 | 监听器要加载的证书链,当前仅允许传入1个证书ID，如果传入多个，则只有最后一个生效 |
| encryptionType | String | 否 | RequestBody参数 | 加密选项，默认tls_cipher_policy_default。支持：tls_cipher_policy_default/tls_cipher_policy_1_1/tls_cipher_policy_1_2/tls_cipher_policy_1_2_secure/userDefind，对应的加密协议和加密套件参见：encryption |
| encryptionProtocols | List<String> | 否 | RequestBody参数 | 当encryptionType值为userDefind时协议类型列表，是以"tlsv10"、"tlsv11"、"tlsv12"三种协议组合形成的字符串列表 |
| appliedCiphers | String | 否 | RequestBody参数 | 加密套件参见：encryption，不同加密套件用冒号":"隔开 |
| dualAuth | boolean | 否 | RequestBody参数 | 是否开启双向认证，默认为关闭 |
| clientCertIds | List<String> | 否 | RequestBody参数 | 当dualAuth为true时，加载的客户端证书链,当前仅允许传入1个证书ID，如果传入多个，则只有最后一个生效 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
无
请求示例
Plain Text
1POST /v1/blb/lb-j8UqijYf/SSLlistener?clientToken=asdfg HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "listenerPort":95,
7 "backendPort":95,
8 "scheduler":"LeastConnection",
9 "healthCheckType":"TCP",
10 "healthCheckTimeoutInSecond":4,
11 "healthCheckInterval":5,
12 "unhealthyThreshold":2,
13 "healthyThreshold":3,
14 "certIds":["cert-zfj2ey2z4kmm"]
15}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWSDescribeTCPListeners查询TCP监听器
描述
- 查询指定LoadBalancer下所有TCP监听器的信息
- 支持按监听器端口进行匹配查询
- 结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定
请求结构
Plain Text
1GET /v{version}/blb/{blbId}/TCPlistener?listenerPort={listenerPort}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: 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 | 每页包含的最大数量 |
请求示例
Plain Text
1GET /v1/blb/lb-j8UqijYf/TCPlistener?maxKeys=2 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "listenerList": [
10 {
11 "listenerPort": 80,
12 "backendPort": 80,
13 "scheduler": "RoundRobin",
14 "healthCheckTimeoutInSecond": 3,
15 "healthCheckInterval": 3,
16 "unhealthyThreshold": 3,
17 "healthyThreshold": 3
18 },
19 {
20 "listenerPort": 88,
21 "backendPort": 88,
22 "scheduler": "RoundRobin",
23 "healthCheckTimeoutInSecond": 2,
24 "healthCheckInterval": 4,
25 "unhealthyThreshold": 3,
26 "healthyThreshold": 3
27 }
28 ],
29 "marker": "listener-0050",
30 "nextMarker": null,
31 "isTruncated": false,
32 "maxKeys": 2
33}DescribeUDPListeners查询UDP监听器
描述
- 查询指定LoadBalancer下所有UDP监听器的信息
- 支持按监听器端口进行匹配查询
- 结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定
请求结构
Plain Text
1GET /v{version}/blb/{blbId}/UDPlistener?listenerPort={listenerPort}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: 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 | 每页包含的最大数量 |
请求示例
Plain Text
1GET /v1/blb/lb-j8UqijYf/UDPlistener?maxKeys=2 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "listenerList": [
10 {
11 "listenerPort": 80,
12 "backendPort": 80,
13 "scheduler": "RoundRobin",
14 "healthCheckType": "UDP",
15 "healthCheckTimeoutInSecond": 3,
16 "healthCheckInterval": 3,
17 "unhealthyThreshold": 3,
18 "healthyThreshold": 3,
19 "healthCheckString":"healthCheck",
20 "udpSessionTimeout":90
21 },
22 {
23 "listenerPort": 88,
24 "backendPort": 88,
25 "scheduler": "RoundRobin",
26 "healthCheckType": "UDP",
27 "healthCheckTimeoutInSecond": 2,
28 "healthCheckInterval": 4,
29 "unhealthyThreshold": 3,
30 "healthyThreshold": 3,
31 "healthCheckString":"healthCheck",
32 "udpSessionTimeout": 90
33 }
34 ],
35 "marker": "listener-0050",
36 "nextMarker": null,
37 "isTruncated": false,
38 "maxKeys": 2
39}DescribeHTTPListeners查询HTTP监听器
描述
- 查询指定LoadBalancer下所有HTTP监听器的信息
- 支持按监听器端口进行匹配查询
- 结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定
请求结构
Plain Text
1GET /v{version}/blb/{blbId}/HTTPlistener?listenerPort={listenerPort}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: 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 | 每页包含的最大数量 |
请求示例
Plain Text
1GET /v1/blb/lb-j8UqijYf/HTTPlistener?maxKeys=2 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Fri, 03 Jun 2016 06:42:44 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "listenerList": [
10 {
11 "listenerPort": 90,
12 "backendPort": 90,
13 "scheduler": "LeastConnection",
14 "healthCheckTimeoutInSecond": 4,
15 "healthCheckInterval": 5,
16 "unhealthyThreshold": 2,
17 "healthyThreshold": 3,
18 "keepSession": false,
19 "keepSessionType": null,
20 "keepSessionDuration": null,
21 "keepSessionCookieName": null,
22 "xForwardFor": false,
23 "healthCheckType": "HTTP",
24 "healthCheckPort": 90,
25 "healthCheckURI": "/",
26 "healthCheckNormalStatus": "http_2xx|http_3xx",
27 "serverTimeout": 30,
28 "redirectPort": 80
29 },
30 {
31 "listenerPort": 95,
32 "backendPort": 95,
33 "scheduler": "LeastConnection",
34 "healthCheckTimeoutInSecond": 4,
35 "healthCheckInterval": 5,
36 "unhealthyThreshold": 2,
37 "healthyThreshold": 3,
38 "keepSession": false,
39 "keepSessionType": null,
40 "keepSessionDuration": null,
41 "keepSessionCookieName": null,
42 "xForwardFor": false,
43 "healthCheckType": "HTTP",
44 "healthCheckPort": 95,
45 "healthCheckURI": "/",
46 "healthCheckNormalStatus": "http_1xx|http_2xx",
47 "serverTimeout": 1800,
48 "redirectPort": 80
49 }
50 ],
51 "marker": "listener-005A",
52 "nextMarker": "listener-0322",
53 "isTruncated": true,
54 "maxKeys": 2
55}DescribeHTTPSListeners查询HTTPS监听器
描述
- 查询指定LoadBalancer下所有HTTPS监听器的信息
- 支持按监听器端口进行匹配查询
- 结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定
请求结构
Plain Text
1GET /v{version}/blb/{blbId}/HTTPSlistener?listenerPort={listenerPort}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: 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 | 每页包含的最大数量 |
请求示例
Plain Text
1GET /v1/blb/lb-j8UqijYf/HTTPSlistener?maxKeys=2 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: 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
Plain Text
1{
2 "listenerList": [
3 {
4 "listenerPort": 90,
5 "backendPort": 90,
6 "scheduler": "LeastConnection",
7 "healthCheckTimeoutInSecond": 4,
8 "healthCheckInterval": 5,
9 "unhealthyThreshold": 2,
10 "healthyThreshold": 3,
11 "keepSession": false,
12 "keepSessionType": null,
13 "keepSessionDuration": null,
14 "keepSessionCookieName": null,
15 "xForwardFor": false,
16 "healthCheckType": "HTTP",
17 "healthCheckPort": 90,
18 "healthCheckURI": "/",
19 "healthCheckNormalStatus": "http_2xx|http_3xx",
20 "serverTimeout": 30,
21 "certIds": ["cert-zfj2ey2z4kmm"]
22 },
23 {
24 "listenerPort": 95,
25 "backendPort": 95,
26 "scheduler": "LeastConnection",
27 "healthCheckTimeoutInSecond": 4,
28 "healthCheckInterval": 5,
29 "unhealthyThreshold": 2,
30 "healthyThreshold": 3,
31 "keepSession": false,
32 "keepSessionType": null,
33 "keepSessionDuration": null,
34 "keepSessionCookieName": null,
35 "xForwardFor": false,
36 "healthCheckType": "HTTP",
37 "healthCheckPort": 95,
38 "healthCheckURI": "/",
39 "healthCheckNormalStatus": "http_1xx|http_2xx",
40 "serverTimeout": 1800,
41 "certIds": ["cert-zfj2ey2z4kmm"]
42 }
43 ],
44 "marker": "listener-005A",
45 "nextMarker": "listener-0322",
46 "isTruncated": true,
47 "maxKeys": 2
48}DescribeSSLListeners查询SSL监听器
描述
- 查询指定LoadBalancer下所有SSL监听器的信息
- 支持按监听器端口进行匹配查询
- 结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定
请求结构
Plain Text
1GET /v{version}/blb/{blbId}/SSLlistener?listenerPort={listenerPort}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: 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 | 每页包含的最大数量 |
请求示例
Plain Text
1GET /v1/blb/lb-j8UqijYf/SSLlistener?maxKeys=2 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "listenerList": [
10 {
11 "listenerPort": 80,
12 "backendPort": 80,
13 "scheduler": "RoundRobin",
14 "healthCheckTimeoutInSecond": 3,
15 "healthCheckInterval": 3,
16 "unhealthyThreshold": 3,
17 "healthyThreshold": 3
18 },
19 {
20 "listenerPort": 88,
21 "backendPort": 88,
22 "scheduler": "RoundRobin",
23 "healthCheckTimeoutInSecond": 2,
24 "healthCheckInterval": 4,
25 "unhealthyThreshold": 3,
26 "healthyThreshold": 3
27 }
28 ],
29 "marker": "listener-0050",
30 "nextMarker": null,
31 "isTruncated": false,
32 "maxKeys": 2
33}DescribeAllListeners查询所有监听
请求结构
Plain Text
1GET /v{version}/blb/{blbId}/listener?listenerPort={listenerPort}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1 |
| blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
| listenerPort | int | 否 | Query参数 | 要查询的监听器端口 |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量通常不超过1000，缺省值为1000 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 标记查询的起始位置 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 |
| maxKeys | int | 每页包含的最大数量 |
| listenerList | List<AllListenerModel> | 包含查询的监听列表 |
请求示例
Plain Text
1GET /v1/blb/lb-a7942975/listener HTTP/1.1
2Host: blb.bj.baidubce.com
3ContentType: application/json
4Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2017 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5 返回示例
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50
3 Date: Thu, 16 Mar 2017 06:29:48 GMT
4 Content Type: application/json;charset=UTF 8
5 Server: BWS
6
7{
8 "nextMarker": "",
9 "marker": "",
10 "maxKeys": 1,
11 "isTruncated": true,
12 "listenerList": [
13 {
14 "listenerPort": 53,
15 "backendPort": 53,
16 "scheduler": "RoundRobin",
17 "healthCheckTimeoutInSecond": 3,
18 "healthCheckInterval": 3,
19 "unhealthyThreshold": 3,
20 "healthyThreshold": 3,
21 "getBlbIp": false,
22 "listenerType": "UDP",
23 "udpSessionTimeout": 90,
24 "healthCheckString": "\\00\\01\\01\\00\\00\\01\\00\\00\\00\\00\\00\\00\\05baidu\\03com\\00\\00\\01\\00\\01",
25 "healthCheckType": "UDP"
26 },
27 {
28 "listenerPort": 82,
29 "backendPort": 80,
30 "scheduler": "RoundRobin",
31 "healthCheckTimeoutInSecond": 3,
32 "healthCheckInterval": 3,
33 "unhealthyThreshold": 3,
34 "healthyThreshold": 3,
35 "getBlbIp": false,
36 "listenerType": "TCP",
37 "tcpSessionTimeout": 900
38 },
39 {
40 "listenerPort": 87,
41 "backendPort": 80,
42 "scheduler": "RoundRobin",
43 "healthCheckTimeoutInSecond": 3,
44 "healthCheckInterval": 3,
45 "unhealthyThreshold": 3,
46 "healthyThreshold": 3,
47 "getBlbIp": false,
48 "listenerType": "HTTP",
49 "keepSession": false,
50 "xForwardFor": true,
51 "healthCheckType": "HTTP",
52 "healthCheckPort": 80,
53 "healthCheckURI": "/",
54 "healthCheckNormalStatus": "http_2xx|http_3xx",
55 "healthCheckHost": "",
56 "serverTimeout": 30,
57 "redirectPort": 0
58 },
59 {
60 "listenerPort": 443,
61 "backendPort": 80,
62 "scheduler": "RoundRobin",
63 "healthCheckTimeoutInSecond": 3,
64 "healthCheckInterval": 3,
65 "unhealthyThreshold": 3,
66 "healthyThreshold": 3,
67 "getBlbIp": false,
68 "listenerType": "HTTPS",
69 "keepSession": false,
70 "xForwardFor": true,
71 "healthCheckType": "HTTP",
72 "healthCheckPort": 80,
73 "healthCheckURI": "/",
74 "healthCheckNormalStatus": "http_2xx|http_3xx",
75 "healthCheckHost": "",
76 "serverTimeout": 30,
77 "certIds": [
78 "cert-gs8bktrm7drp"
79 ],
80 "dualAuth": false,
81 "encryptionType": "tls_cipher_policy_1_2_secure",
82 "encryptionProtocols": [
83 "tlsv12"
84 ],
85 "appliedCiphers": "ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES128-SHA"
86 },
87 {
88 "listenerPort": 446,
89 "backendPort": 80,
90 "scheduler": "RoundRobin",
91 "healthCheckTimeoutInSecond": 3,
92 "healthCheckInterval": 3,
93 "unhealthyThreshold": 3,
94 "healthyThreshold": 3,
95 "getBlbIp": false,
96 "listenerType": "SSL",
97 "certIds": [
98 "cert-gs8bktrm7drp"
99 ],
100 "dualAuth": true,
101 "clientCertIds": [
102 "cert-0x037gwe4fmg"
103 ],
104 "encryptionType": "tls_cipher_policy_default",
105 "encryptionProtocols": [
106 "tlsv10",
107 "tlsv11",
108 "tlsv12"
109 ],
110 "appliedCiphers": "ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:AES128-GCM-SHA256:AES256-SHA:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES128-SHA256:DES-CBC3-SHA"
111 }
112 ]
113} UpdateTCPListener更新TCP监听器
描述
更新指定LoadBalancer下的TCP监听器参数，请求参数中所有指定的字段都会被更新，未指定的字段保持不变，监听器通过端口指定。
请求结构
Plain Text
1PUT /v{version}/blb/{blbId}/TCPlistener?listenerPort={listenerPort}&clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "backendPort":backendPort,
7 "scheduler":scheduler,
8 "healthCheckType":healthCheckType,
9 "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
10 "healthCheckInterval":healthCheckInterval,
11 "unhealthyThreshold":unhealthyThreshold,
12 "healthyThreshold":healthyThreshold
13}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| 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"，"RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"Hash"代表根据源ip哈希 |
| healthCheckType | String | 否 | RequestBody参数 | 健康检查协议类型，支持"TCP" |
| 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，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
无
请求示例
Plain Text
1PUT /v1/blb/lb-j8UqijYf/TCPlistener?listenerPort=80&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "backendPort":95,
7 "scheduler":"LeastConnection",
8 "healthCheckTimeoutInSecond":4,
9 "healthCheckInterval":5,
10 "unhealthyThreshold":2
11}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWSUpdateUDPListener更新UDP监听器
描述
- 更新指定LoadBalancer下的UDP监听器参数，所有请求参数中指定的域都会被更新，未指定的域保持不变，监听器通过端口指定。
请求结构
Plain Text
1PUT /v{version}/blb/{blbId}/UDPlistener?listenerPort={listenerPort} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "backendPort":backendPort,
7 "scheduler":scheduler,
8 "healthCheckType":healthCheckType,
9 "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
10 "healthCheckInterval":healthCheckInterval,
11 "unhealthyThreshold":unhealthyThreshold,
12 "healthyThreshold":healthyThreshold,
13 "healthCheckString":"healthCheck"
14}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| 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"，"RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"Hash"代表根据源ip哈希 |
| healthCheckType | String | 否 | RequestBody参数 | 健康检查协议类型，支持"UDP"/"ICMP" |
| 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，方便配置二进制格式请求，健康检查协议为"UDP"时必传 |
| udpSessionTimeout | int | 否 | RequestBody参数 | udp会话超时时间。默认为90，需为5-4000间的整数，单位秒 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
无
请求示例
Plain Text
1POST /v1/blb/lb-j8UqijYf/UDPlistener?clientToken=asdfg HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "listenerPort":95,
7 "backendPort":95,
8 "scheduler":"LeastConnection",
9 "healthCheckTimeoutInSecond":4,
10 "healthCheckInterval":5,
11 "unhealthyThreshold":2,
12 "healthCheckString":"healthCheck",
13 "udpSessionTimeout": 90
14}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWSUpdateHTTPListener更新HTTP监听器
描述
更新指定LoadBalancer下的HTTP监听器参数，所有请求参数中指定的域都会被更新，未指定的域保持不变，监听器通过端口指定。
请求结构
Plain Text
1PUT /v{version}/blb/{blbId}/HTTPlistener?listenerPort={listenerPort}&clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "backendPort":backendPort,
7 "scheduler":scheduler,
8 "keepSession":keepSession,
9 "keepSessionType":keepSessionType,
10 "keepSessionDuration":keepSessionDuration,
11 "keepSessionCookieName":keepSessionCookieName,
12 "xForwardFor":xForwardFor,
13 "xForwardedProto":xForwardedProto,
14 "healthCheckType":healthCheckType,
15 "healthCheckPort":healthCheckPort,
16 "healthCheckURI":healthCheckURI,
17 "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
18 "healthCheckInterval":healthCheckInterval,
19 "unhealthyThreshold":unhealthyThreshold,
20 "healthyThreshold":healthyThreshold,
21 "healthCheckNormalStatus":healthCheckNormalStatus,
22 "healthCheckHost":healthCheckHost,
23 "serverTimeout":serverTimeout,
24 "redirectPort":redirectPort
25}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| 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"，"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端的真实地址，默认关闭 |
| xForwardedProto | bool | 否 | RequestBody参数 | 将监听使用的协议通过x-forwarded-proto HTTP Header 转发给后端服务器 |
| healthCheckType | String | 否 | RequestBody参数 | 健康检查协议，支持"HTTP"/"TCP" |
| 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"时生效 |
| healthCheckHost | String | 否 | RequestBody参数 | 7层健康检查请求的头部域会带指定的host字段，例如"localhost"，默认""。当健康检查协议为"HTTP"时生效 |
| serverTimeout | int | 否 | RequestBody参数 | 后端服务器最大超时（单位：秒），默认30s，需为1-3600间的整数 |
| redirectPort | int | 否 | RequestBody参数 | 将此监听器收到的请求转发到HTTPS监听器，HTTPS监听器通过这个端口指定 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
无
请求示例
Plain Text
1PUT /v1/blb/lb-j8UqijYf/HTTPlistener?listenerPort=8080&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "backendPort":95,
7 "scheduler":"LeastConnection",
8 "healthCheckTimeoutInSecond":4,
9 "healthCheckInterval":5,
10 "unhealthyThreshold":2,
11 "xForwardFor":true,
12 "xForwardedProto":true,
13 "healthCheckType":"HTTP",
14 "serverTimeout":1800,
15 "healthCheckNormalStatus":"http_1xx|http_2xx",
16 "healthCheckHost":"localhost"
17}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWSUpdateHTTPSListener更新HTTPS监听器
描述
更新指定LoadBalancer下的HTTPS监听器参数，所有请求参数中指定的域都会被更新，未指定的域保持不变，监听器通过端口指定。
请求结构
Plain Text
1PUT /v{version}/blb/{blbId}/HTTPSlistener?listenerPort={listenerPort}&clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "backendPort":backendPort,
7 "scheduler":scheduler,
8 "keepSession":keepSession,
9 "keepSessionType":keepSessionType,
10 "keepSessionDuration":keepSessionDuration,
11 "keepSessionCookieName":keepSessionCookieName,
12 "xForwardFor":xForwardFor,
13 "xForwardedProto":xForwardedProto,
14 "healthCheckType":healthCheckType,
15 "healthCheckPort":healthCheckPort,
16 "healthCheckURI":healthCheckURI,
17 "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
18 "healthCheckInterval":healthCheckInterval,
19 "unhealthyThreshold":unhealthyThreshold,
20 "healthyThreshold":healthyThreshold,
21 "healthCheckNormalStatus":healthCheckNormalStatus,
22 "healthCheckHost":healthCheckHost,
23 "serverTimeout":serverTimeout,
24 "certIds":[certId],
25 "additionalCertDomains":[{"certId":certId,"host":host}]
26}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| 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"，"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端的真实地址，默认关闭 |
| xForwardedProto | bool | 否 | RequestBody参数 | 将监听使用的协议通过x-forwarded-proto HTTP Header 转发给后端服务器 |
| healthCheckType | String | 否 | RequestBody参数 | 健康检查协议，支持"HTTP"/"TCP" |
| 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"时生效 |
| healthCheckHost | String | 否 | RequestBody参数 | 7层健康检查请求的头部域会带指定的host字段，例如"localhost"，默认""。当健康检查协议为"HTTP"时生效 |
| serverTimeout | int | 否 | RequestBody参数 | 后端服务器最大超时（单位：秒），默认30s，需为1-3600间的整数 |
| certIds | List<int> | 否 | RequestBody参数 | 监听器要加载的证书链,当前仅允许传入1个证书ID，如果传入多个，则只有最后一个生效 |
| additionalCertDomains | List<AdditionalCertDomain> | 否 | RequestBody参数 | 扩展域名 |
| encryptionType | String | 否 | RequestBody参数 | 加密选项。支持：tls_cipher_policy_default/tls_cipher_policy_1_1/tls_cipher_policy_1_2/tls_cipher_policy_1_2_secure/userDefind，对应的加密协议和加密套件参见：encryption |
| encryptionProtocols | List<String> | 否 | RequestBody参数 | 当encryptionType值为userDefind时协议类型列表，是以"tlsv10"、"tlsv11"、"tlsv12"三种协议组合形成的字符串列表 |
| appliedCiphers | String | 否 | RequestBody参数 | 加密套件参见：encryption，不同加密套件用冒号":"隔开 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
无
请求示例
Plain Text
1PUT /v1/blb/lb-j8UqijYf/HTTPSlistener?listenerPort=88&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "backendPort":95,
7 "scheduler":"LeastConnection",
8 "healthCheckTimeoutInSecond":4,
9 "healthCheckInterval":5,
10 "unhealthyThreshold":2,
11 "xForwardFor":true,
12 "healthCheckType":"HTTP",
13 "serverTimeout":1800,
14 "healthCheckNormalStatus":"http_1xx|http_2xx",
15 "healthCheckHost":"localhost"
16}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWSUpdateSSLListener更新SSL监听器
描述
- 更新指定LoadBalancer下的SSL监听器参数，所有请求参数中指定的域都会被更新，未指定的域保持不变，监听器通过端口指定。
请求结构
Plain Text
1PUT /v{version}/blb/{blbId}/SSLlistener?listenerPort={listenerPort} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "backendPort":backendPort,
7 "scheduler":scheduler,
8 "healthCheckType":healthCheckType,
9 "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
10 "healthCheckInterval":healthCheckInterval,
11 "unhealthyThreshold":unhealthyThreshold,
12 "healthyThreshold":healthyThreshold,
13 "certIds":[certId],
14 "encryptionType":encryptionType,
15 "encryptionProtocols":[protocol1, protacol2],
16 "dualAuth":false,
17 "clientCertIds":[clientCertId]
18}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| 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"，"RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"Hash"代表根据源ip哈希 |
| healthCheckType | String | 否 | RequestBody参数 | 健康检查协议类型，支持"TCP" |
| 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参数 | 监听器要加载的证书链,当前仅允许传入1个证书ID，如果传入多个，则只有最后一个生效 |
| encryptionType | String | 否 | RequestBody参数 | 加密选项，支持：tls_cipher_policy_default/tls_cipher_policy_1_1/tls_cipher_policy_1_2/tls_cipher_policy_1_2_secure/userDefind，对应的加密协议和加密套件参见：encryption |
| encryptionProtocols | List<String> | 否 | RequestBody参数 | 当encryptionType值为userDefind时协议类型列表，是以"tlsv10"、"tlsv11"、"tlsv12"三种协议组合形成的字符串列表 |
| appliedCiphers | String | 否 | RequestBody参数 | 加密套件参见：encryption，不同加密套件用冒号":"隔开 |
| dualAuth | boolean | 否 | RequestBody参数 | 是否开启双向认证，默认为关闭 |
| clientCertIds | List\<String> | 否 | RequestBody参数 | 当dualAuth为true时，加载的客户端证书链,当前仅允许传入1个证书ID，如果传入多个，则只有最后一个生效 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
无
请求示例
Plain Text
1POST /v1/blb/lb-j8UqijYf/SSLlistener?clientToken=asdfg HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "listenerPort":95,
7 "backendPort":95,
8 "scheduler":"LeastConnection",
9 "healthCheckTimeoutInSecond":4,
10 "healthCheckInterval":5,
11 "unhealthyThreshold":2,
12 "certIds":["cert-zfj2ey2z4kmm"]
13}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWSDeleteListeners释放监听器
描述
- 释放指定LoadBalancer下的监听器，监听器通过监听端口来指定
- 支持批量释放
请求结构
Plain Text
1PUT /v{version}/blb/{blbId}/listener?{action}&clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "portList":[port1,port2,...]
7}
8或者
9{
10 "portTypeList":[
11 {
12 "port":port,
13 "type":"type"
14 },
15 {
16 "port":port,
17 "type":"type"
18 },
19 ]
20}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1 |
| blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
| action | String | 是 | URL参数 | batchdelete |
| clientToken | String | 是 | Query参数 | 幂等性Token，长度不超过64位 |
| portList | List<int> | 否 | RequestBody参数 | 所有待释放的监听器的端口，一起组成一个数组 |
| portTypeList | List<PortTypeModel> | 否 | RequestBody参数 | 所有待释放的监听器的端口和协议，一起组成一个数组，如果开通了同端口多协议，并且只想删除其中一个协议，使用这个参数。portList和portTypeList至少传一个。 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
无
请求示例
Plain Text
1PUT /v1/blb/lb-j8UqijYf/listener?batchdelete&clientToken=clienttokentest
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "portList":[80,87]
7}
8或者
9{
10 "portTypeList":[
11 {
12 "port":80,
13 "type":"TCP"
14 },
15 {
16 "port":80,
17 "type":"UDP"
18 },
19 ]
20}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Fri, 03 Jun 2016 03:54:29 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS