普通型BLB监听器相关接口

更新时间：2024-11-15

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,
    "tcpSessionTimeout":tcpSessionTimeout,
    "healthCheckType":healthCheckType,
    "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"，"RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"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，失败返回见错误码

返回头域

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

返回参数

无

请求示例

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",
    "tcpSessionTimeout":900,
    "healthCheckType":"TCP",
    "healthCheckTimeoutInSecond":4,
    "healthCheckInterval":5,
    "unhealthyThreshold":2,
    "healthyThreshold":3
}

响应示例

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、ICMP协议的健康检查，检查端口和后端服务器监听端口一致。

请求结构

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,
    "healthCheckType":healthCheckType,
    "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
    "healthCheckInterval":healthCheckInterval,
    "unhealthyThreshold":unhealthyThreshold,
    "healthyThreshold":healthyThreshold,
    "healthCheckString":healthCheck,
    "udpSessionTimeout":udpSessionTimeout
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
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参数	健康检查协议类型，支持"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，失败返回见错误码

返回头域

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

返回参数

无

请求示例

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",
    "healthCheckType":"UDP",
    "healthCheckString":"healthCheck",
    "healthCheckTimeoutInSecond":4,
    "healthCheckInterval":5,
    "unhealthyThreshold":2,
    "healthyThreshold":3,
    "udpSessionTimeout":90
}

响应示例

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,
    "xForwardedProto":xForwardedProto
    "healthCheckType":healthCheckType,
    "healthCheckPort":healthCheckPort,
    "healthCheckURI":healthCheckURI,
    "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
    "healthCheckInterval":healthCheckInterval,
    "unhealthyThreshold":unhealthyThreshold,
    "healthyThreshold":healthyThreshold,
    "healthCheckNormalStatus":healthCheckNormalStatus,
    "healthCheckHost":healthCheckHost,
    "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"，"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，失败返回见错误码

返回头域

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

返回参数

无

请求示例

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,
    "xForwardedProto":true,
    "healthCheckType":"HTTP",
    "serverTimeout":1800,
    "healthCheckNormalStatus":"http_1xx|http_2xx",
    "healthCheckHost":"localhost",
	"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,
    "xForwardedProto":xForwardedProto
    "healthCheckType":healthCheckType,
    "healthCheckPort":healthCheckPort,
    "healthCheckURI":healthCheckURI,
    "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
    "healthCheckInterval":healthCheckInterval,
    "unhealthyThreshold":unhealthyThreshold,
    "healthyThreshold":healthyThreshold,
    "healthCheckNormalStatus":healthCheckNormalStatus,
    "healthCheckHost":healthCheckHost,
    "serverTimeout":serverTimeout,
    "certIds":[id1, id2],
    "encryptionType":encryptionType,
    "encryptionProtocols":[protocol1, protacol2],
    "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"，"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参数	监听器要加载的证书链
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时，加载的客户端证书链

返回状态码

成功返回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,
    "healthyThreshold":3,
    "xForwardFor":true,
    "xForwardedProto": true,
    "healthCheckType":"HTTP",
    "serverTimeout":1800,
    "healthCheckNormalStatus":"http_1xx|http_2xx",
    "healthCheckHost":"localhost",
    "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下，创建一个基于SSL协议的监听器，监听一个前端端口，将发往该端口的所有SSL流量，通过SSL卸载转换为TCP请求后转发到后端服务器监听的后端端口上。SSL监听器只支持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,
    "healthCheckType":healthCheckType,
    "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
    "healthCheckInterval":healthCheckInterval,
    "unhealthyThreshold":unhealthyThreshold,
    "healthyThreshold":healthyThreshold,
    "certIds":[id1, id2],
    "encryptionType":encryptionType,
    "encryptionProtocols":[protocol1, protacol2],
    "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"，"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参数	监听器要加载的证书链
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时，加载的客户端证书链

返回状态码

成功返回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",
    "healthCheckType":"TCP",
    "healthCheckTimeoutInSecond":4,
    "healthCheckInterval":5,
    "unhealthyThreshold":2,
    "healthyThreshold":3,
    "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",
            "healthCheckType": "UDP",
            "healthCheckTimeoutInSecond": 3,
            "healthCheckInterval": 3,
            "unhealthyThreshold": 3,
            "healthyThreshold": 3,
			"healthCheckString":"healthCheck",
            "udpSessionTimeout":90
        },
        {
            "listenerPort": 88,
            "backendPort": 88,
            "scheduler": "RoundRobin",
            "healthCheckType": "UDP",
            "healthCheckTimeoutInSecond": 2,
            "healthCheckInterval": 4,
            "unhealthyThreshold": 3,
            "healthyThreshold": 3,
			"healthCheckString":"healthCheck",
            "udpSessionTimeout": 90
        }
    ],
    "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"]
        },
        {
            "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"]
        }
    ],
    "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
}

DescribeAllListeners查询所有监听

请求结构

GET /v{version}/blb/{blbId}/listener?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

返回头域

除公共头域，无其它特殊头域。

返回参数

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

请求示例

GET /v1/blb/lb-a7942975/listener HTTP/1.1   
Host: blb.bj.baidubce.com     
ContentType: application/json     
Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2017 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

 HTTP/1.1 200 OK     
 x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
 Date: Thu, 16 Mar 2017 06:29:48 GMT    
 Content Type: application/json;charset=UTF 8     
 Server: BWS  
  
{
    "nextMarker": "",
    "marker": "",
    "maxKeys": 1,
    "isTruncated": true,
    "listenerList": [
        {
        "listenerPort": 53,
        "backendPort": 53,
        "scheduler": "RoundRobin",
        "healthCheckTimeoutInSecond": 3,
        "healthCheckInterval": 3,
        "unhealthyThreshold": 3,
        "healthyThreshold": 3,
        "getBlbIp": false,
        "listenerType": "UDP",
        "udpSessionTimeout": 90,
        "healthCheckString": "\\00\\01\\01\\00\\00\\01\\00\\00\\00\\00\\00\\00\\05baidu\\03com\\00\\00\\01\\00\\01",
        "healthCheckType": "UDP"
    },
    {
        "listenerPort": 82,
        "backendPort": 80,
        "scheduler": "RoundRobin",
        "healthCheckTimeoutInSecond": 3,
        "healthCheckInterval": 3,
        "unhealthyThreshold": 3,
        "healthyThreshold": 3,
        "getBlbIp": false,
        "listenerType": "TCP",
        "tcpSessionTimeout": 900
    },
    {
        "listenerPort": 87,
        "backendPort": 80,
        "scheduler": "RoundRobin",
        "healthCheckTimeoutInSecond": 3,
        "healthCheckInterval": 3,
        "unhealthyThreshold": 3,
        "healthyThreshold": 3,
        "getBlbIp": false,
        "listenerType": "HTTP",
        "keepSession": false,
        "xForwardFor": true,
        "healthCheckType": "HTTP",
        "healthCheckPort": 80,
        "healthCheckURI": "/",
        "healthCheckNormalStatus": "http_2xx|http_3xx",
        "healthCheckHost": "",
        "serverTimeout": 30,
        "redirectPort": 0
    },
    {
        "listenerPort": 443,
        "backendPort": 80,
        "scheduler": "RoundRobin",
        "healthCheckTimeoutInSecond": 3,
        "healthCheckInterval": 3,
        "unhealthyThreshold": 3,
        "healthyThreshold": 3,
        "getBlbIp": false,
        "listenerType": "HTTPS",
        "keepSession": false,
        "xForwardFor": true,
        "healthCheckType": "HTTP",
        "healthCheckPort": 80,
        "healthCheckURI": "/",
        "healthCheckNormalStatus": "http_2xx|http_3xx",
        "healthCheckHost": "",
        "serverTimeout": 30,
        "certIds": [
            "cert-gs8bktrm7drp"
        ],
        "dualAuth": false,
        "encryptionType": "tls_cipher_policy_1_2_secure",
        "encryptionProtocols": [
            "tlsv12"
        ],
        "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"
    },
    {
        "listenerPort": 446,
        "backendPort": 80,
        "scheduler": "RoundRobin",
        "healthCheckTimeoutInSecond": 3,
        "healthCheckInterval": 3,
        "unhealthyThreshold": 3,
        "healthyThreshold": 3,
        "getBlbIp": false,
        "listenerType": "SSL",
        "certIds": [
            "cert-gs8bktrm7drp"
        ],
        "dualAuth": true,
        "clientCertIds": [
            "cert-0x037gwe4fmg"
        ],
        "encryptionType": "tls_cipher_policy_default",
        "encryptionProtocols": [
            "tlsv10",
            "tlsv11",
            "tlsv12"
        ],
        "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"
    }
    ]
}

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,
    "healthCheckType":healthCheckType,
    "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"，"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，失败返回见错误码

返回头域

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

返回参数

无

请求示例

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,
    "healthCheckType":healthCheckType,
    "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
    "healthCheckInterval":healthCheckInterval,
    "unhealthyThreshold":unhealthyThreshold,
    "healthyThreshold":healthyThreshold,
    "healthCheckString":"healthCheck"
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
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，失败返回见错误码

返回头域

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

返回参数

无

请求示例

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":"healthCheck",
    "udpSessionTimeout": 90
}

响应示例

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,
    "xForwardedProto":xForwardedProto,
    "healthCheckType":healthCheckType,
    "healthCheckPort":healthCheckPort,
    "healthCheckURI":healthCheckURI,
    "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
    "healthCheckInterval":healthCheckInterval,
    "unhealthyThreshold":unhealthyThreshold,
    "healthyThreshold":healthyThreshold,
    "healthCheckNormalStatus":healthCheckNormalStatus,
    "healthCheckHost":healthCheckHost,
    "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"，"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，失败返回见错误码

返回头域

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

返回参数

无

请求示例

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,
    "xForwardedProto":true,
    "healthCheckType":"HTTP",
    "serverTimeout":1800,
    "healthCheckNormalStatus":"http_1xx|http_2xx",
    "healthCheckHost":"localhost"
}

响应示例

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,
    "xForwardedProto":xForwardedProto,
    "healthCheckType":healthCheckType,
    "healthCheckPort":healthCheckPort,
    "healthCheckURI":healthCheckURI,
    "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
    "healthCheckInterval":healthCheckInterval,
    "unhealthyThreshold":unhealthyThreshold,
    "healthyThreshold":healthyThreshold,
    "healthCheckNormalStatus":healthCheckNormalStatus,
    "healthCheckHost":healthCheckHost,
    "serverTimeout":serverTimeout,
    "certIds":[id1, id2]
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
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参数	监听器要加载的证书链
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，失败返回见错误码

返回头域

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

返回参数

无

请求示例

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",
    "healthCheckHost":"localhost"
}

响应示例

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,
    "healthCheckType":healthCheckType,
    "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
    "healthCheckInterval":healthCheckInterval,
    "unhealthyThreshold":unhealthyThreshold,
    "healthyThreshold":healthyThreshold,
    "certIds":[id1, id2],
    "encryptionType":encryptionType,
    "encryptionProtocols":[protocol1, protacol2],
    "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"，"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参数	监听器要加载的证书链
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时，加载的客户端证书链

返回状态码

成功返回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,...]
}
或者
{
    "portTypeList":[
        {
            "port":port,
            "type":"type"
        },
        {
            "port":port,
            "type":"type"
        },
    ]
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
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，失败返回见错误码

返回头域

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

返回参数

无

请求示例

PUT /v1/blb/lb-j8UqijYf/listener?batchdelete&clientToken=clienttokentest
Host: blb.bj.baidubce.com
Authorization: authorization string

{
    "portList":[80,87]
}
或者
{
    "portTypeList":[
        {
            "port":80,
            "type":"TCP"
        },
        {
            "port":80,
            "type":"UDP"
        },
    ]
}

响应示例

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后端服务器相关接口

百度智能云

负载均衡 BLB

负载均衡 BLB

普通型BLB监听器相关接口

CreateTCPListener创建TCP监听器

CreateUDPListener创建UDP监听器

CreateHTTPListener创建HTTP监听器

CreateHTTPSListener创建HTTPS监听器

CreateSSLListener创建SSL监听器

DescribeTCPListeners查询TCP监听器

DescribeUDPListeners查询UDP监听器

DescribeHTTPListeners查询HTTP监听器

DescribeHTTPSListeners查询HTTPS监听器

DescribeSSLListeners查询SSL监听器

DescribeAllListeners查询所有监听

UpdateTCPListener更新TCP监听器

UpdateUDPListener更新UDP监听器

UpdateHTTPListener更新HTTP监听器

UpdateHTTPSListener更新HTTPS监听器

UpdateSSLListener更新SSL监听器

DeleteListeners释放监听器