应用型IPv6BLB监听器相关接口
CreateAppTCPListener创建TCP监听器
- 在指定LoadBalancer下,创建一个基于TCP协议的应用型blb监听器,监听一个前端端口,将发往该端口的所有TCP流量,根据策略进行转发。
请求结构
1POST /v{version}/appblb/{blbId}/TCPlistener?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "listenerPort":listenerPort,
7 "scheduler":scheduler,
8 "tcpSessionTimeout":tcpSessionTimeout
9}
请求头域
除公共头域外,无其他特殊头域
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1 |
blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
clientToken | String | 是 | Query参数 | 幂等性Token,长度不超过64位 |
listenerPort | int | 是 | RequestBody参数 | 监听器的监听端口,需为1-65535间的整数 |
scheduler | String | 是 | RequestBody参数 | 负载均衡算法,支持3种方式:"RoundRobin"/"LeastConnection"/"Hash","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"Hash"代表根据源ip哈希 |
tcpSessionTimeout | int | 否 | RequestBody参数 | tcp设置连接超时时间(单位:秒),默认900,需为10-4000间的整数 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
无
请求示例
1POST /v1/appblb/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 "scheduler":"LeastConnection"
8}
响应示例
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
CreateAppUDPListener创建UDP监听器
- 在指定LoadBalancer下,创建一个基于UDP协议的应用型监听器,监听一个前端端口,将发往该端口的所有UDP流量,根据策略进行转发。
请求结构
1POST /v{version}/appblb/{blbId}/UDPlistener?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "listenerPort":listenerPort,
7 "scheduler":scheduler,
8 "udpSessionTimeout":udpSessionTimeout
9}
请求头域
除公共头域外,无其他特殊头域
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1 |
blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
clientToken | String | 是 | Query参数 | 幂等性Token,长度不超过64位 |
listenerPort | int | 是 | RequestBody参数 | 监听器的监听端口,需为1-65535间的整数 |
scheduler | String | 是 | RequestBody参数 | 负载均衡算法,支持3种方式:"RoundRobin"/"LeastConnection"/"Hash","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"Hash"代表根据源ip哈希 |
udpSessionTimeout | int | 否 | RequestBody参数 | udp会话超时时间。默认为90,需为5-4000间的整数,单位秒 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
无
请求示例
1POST /v1/appblb/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 "scheduler":"LeastConnection",
8 "udpSessionTimeout":90
9}
响应示例
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
CreateAppHTTPListener创建HTTP监听器
- 在指定LoadBalancer下,创建一个基于HTTP协议的应用型监听器,监听一个前端端口,将发往该端口的所有HTTP请求,根据策略转发到后端服务器监听的后端端口上
请求结构
1POST /v{version}/appblb/{blbId}/HTTPlistener?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "listenerPort":listenerPort,
7 "scheduler":scheduler,
8 "keepSession":keepSession,
9 "keepSessionType":keepSessionType,
10 "keepSessionTimeout":keepSessionTimeout,
11 "keepSessionCookieName":keepSessionCookieName,
12 "xForwardedFor":xForwardedFor,
13 "xForwardedProto":xForwardedProto,
14 "serverTimeout":serverTimeout,
15 "redirectPort":redirectPort
16}
请求头域
除公共头域外,无其他特殊头域
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1 |
blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
clientToken | String | 是 | Query参数 | 幂等性Token,长度不超过64位 |
listenerPort | int | 是 | RequestBody参数 | 监听器的监听端口,需为1-65535间的整数 |
scheduler | String | 是 | RequestBody参数 | 负载均衡算法,支持2种方式:"RoundRobin"/"LeastConnection","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数 |
keepSession | boolean | 否 | RequestBody参数 | 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器,默认关闭 |
keepSessionType | String | 否 | RequestBody参数 | 会话保持的cookie处理方式,当且仅当开启会话保持时有效,支持"insert"/"rewrite",默认"insert" |
keepSessionTimeout | int | 否 | RequestBody参数 | 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效,默认3600s,需为1-15552000间的整数 |
keepSessionCookieName | String | 否 | RequestBody参数 | 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效 |
xForwardedFor | boolean | 否 | RequestBody参数 | 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址,默认关闭 |
xForwardedProto | boolean | 否 | RequestBody参数 | 是否开启获取监听协议,开启后后端服务器上可以通过X-Forwarded-Proto这个HTTP Header来获得监听协议,默认关闭 |
serverTimeout | int | 否 | RequestBody参数 | 后端服务器最大超时(单位:秒),默认30s,需为1-3600间的整数 |
redirectPort | int | 否 | RequestBody参数 | 将此监听器收到的请求转发到HTTPS监听器,HTTPS监听器通过这个端口指定 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
无
请求示例
1POST /v1/appblb/lb-j8UqijYf/HTTPlistener?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 "scheduler":"LeastConnection",
8 "xForwardedFor":true,
9 "serverTimeout":1800,
10 "redirectPort":0
11}
响应示例
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
CreateAppHTTPSListener创建HTTPS监听器
- 在指定LoadBalancer下,创建一个基于HTTPS协议的应用型监听器,监听一个前端端口,将发往该端口的所有HTTPS请求,先通过SSL卸载转换为HTTP请求后,再根据策略转发到后端服务器监听的后端端口上
请求结构
1POST /v{version}/appblb/{blbId}/HTTPSlistener?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "listenerPort":listenerPort,
7 "scheduler":scheduler,
8 "keepSession":keepSession,
9 "keepSessionType":keepSessionType,
10 "keepSessionTimeout":keepSessionTimeout,
11 "keepSessionCookieName":keepSessionCookieName,
12 "xForwardedFor":xForwardedFor,
13 "xForwardedProto":xForwardedProto,
14 "serverTimeout":serverTimeout,
15 "certIds":[id1, id2],
16 "encryptionType":encryptionType,
17 "encryptionProtocols":[protocol1, protacol2],
18 "dualAuth":false,
19 "clientCertIds":[id1, id2]
20}
请求头域
除公共头域外,无其他特殊头域
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1 |
blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
clientToken | String | 是 | Query参数 | 幂等性Token,长度不超过64位 |
listenerPort | int | 是 | RequestBody参数 | 监听器的监听端口,需为1-65535间的整数 |
scheduler | String | 是 | RequestBody参数 | 负载均衡算法,支持2种方式:"RoundRobin"/"LeastConnection","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数 |
keepSession | boolean | 否 | RequestBody参数 | 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器,默认关闭 |
keepSessionType | String | 否 | RequestBody参数 | 会话保持的cookie处理方式,当且仅当开启会话保持时有效,支持"insert"/"rewrite",默认"insert" |
keepSessionTimeout | int | 否 | RequestBody参数 | 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效,默认3600s,需为1-15552000间的整数 |
keepSessionCookieName | String | 否 | RequestBody参数 | 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效 |
xForwardedFor | boolean | 否 | RequestBody参数 | 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址,默认关闭 |
xForwardedProto | boolean | 否 | RequestBody参数 | 是否开启获取监听协议,开启后后端服务器上可以通过X-Forwarded-Proto这个HTTP Header来获得监听协议,默认关闭 |
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,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
无
请求示例
1POST /v1/appblb/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 "scheduler":"LeastConnection",
8 "xForwardedFor":true,
9 "serverTimeout":1800,
10 "certIds":["cert-zfj2ey2z4kmm"]
11}
响应示例
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
CreateAppSSLListener创建SSL监听器
- 在指定LoadBalancer下,创建一个基于SSL协议的应用型监听器,监听一个前端端口,将发往该端口的所有SSL流量,根据策略进行转发。
请求结构
1POST /v{version}/appblb/{blbId}/SSLlistener?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "listenerPort":listenerPort,
7 "scheduler":scheduler,
8 "certIds":[id1, id2],
9 "encryptionType":encryptionType,
10 "encryptionProtocols":[protocol1, protacol2],
11 "dualAuth":false,
12 "clientCertIds":[id1, id2]
13}
请求头域
除公共头域外,无其他特殊头域
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1 |
blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
clientToken | String | 是 | Query参数 | 幂等性Token,长度不超过64位 |
listenerPort | int | 是 | RequestBody参数 | 监听器的监听端口,需为1-65535间的整数 |
scheduler | String | 是 | RequestBody参数 | 负载均衡算法,支持3种方式:"RoundRobin"/"LeastConnection"/"Hash","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"Hash"代表根据源ip哈希 |
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,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
无
请求示例
1POST /v1/appblb/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 "scheduler":"LeastConnection",
8 "certIds":["cert-zfj2ey2z4kmm"]
9}
响应示例
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
UpdateAppTCPListener更新TCP监听器
- 更新指定LoadBalancer下的TCP监听器参数,所有请求参数中指定的域都会被更新,未指定的域保持不变,监听器通过端口指定。
请求结构
1PUT /v{version}/appblb/{blbId}/TCPlistener?clientToken={clientToken}&listenerPort={listenerPort} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "scheduler":scheduler,
7 "tcpSessionTimeout":tcpSessionTimeout
8}
请求头域
除公共头域外,无其他特殊头域
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1 |
blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
clientToken | String | 是 | Query参数 | 幂等性Token,长度不超过64位 |
listenerPort | int | 是 | Query参数 | 监听器端口号 |
scheduler | String | 否 | RequestBody参数 | 负载均衡算法,支持3种方式:"RoundRobin"/"LeastConnection"/"Hash","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"Hash"代表根据源ip哈希 |
tcpSessionTimeout | int | 否 | RequestBody参数 | tcp设置连接超时时间(单位:秒),默认900,需为10-4000间的整数 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
无
请求示例
1PUT /v1/appblb/lb-j8UqijYf/TCPlistener?clientToken=asdfg&listenerPort=80 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 "scheduler":"LeastConnection"
7}
响应示例
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
UpdateAppUDPListener更新UDP监听器
- 更新指定LoadBalancer下的UDP监听器参数,所有请求参数中指定的域都会被更新,未指定的域保持不变,监听器通过端口指定。
请求结构
1PUT /v{version}/appblb/{blbId}/UDPlistener?clientToken={clientToken}&listenerPort={listenerPort} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "scheduler":scheduler,
7 "udpSessionTimeout":udpSessionTimeout
8}
请求头域
除公共头域外,无其他特殊头域
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1 |
blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
clientToken | String | 是 | Query参数 | 幂等性Token,长度不超过64位 |
listenerPort | int | 是 | URL参数 | 监听器的端口号 |
scheduler | String | 是 | RequestBody参数 | 负载均衡算法,支持3种方式:"RoundRobin"/"LeastConnection"/"Hash","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"Hash"代表根据源ip哈希 |
udpSessionTimeout | int | 否 | RequestBody参数 | udp会话超时时间。默认为90,需为5-4000间的整数,单位秒 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
无
请求示例
1PUT /v1/appblb/lb-j8UqijYf/UDPlistener?clientToken=asdfg&listenerPort=80 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 "scheduler":"LeastConnection",
7 "udpSessionTimeout":90
8}
响应示例
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
UpdateAppHTTPListener更新HTTP监听器
- 更新指定LoadBalancer下的HTTP监听器参数,所有请求参数中指定的域都会被更新,未指定的域保持不变,监听器通过端口指定
请求结构
1PUT /v{version}/appblb/{blbId}/HTTPlistener?clientToken={clientToken}&listenerPort={listenerPort} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "scheduler":scheduler,
7 "keepSession":keepSession,
8 "keepSessionType":keepSessionType,
9 "keepSessionTimeout":keepSessionTimeout,
10 "keepSessionCookieName":keepSessionCookieName,
11 "xForwardedFor":xForwardedFor,
12 "xForwardedProto":xForwardedProto,
13 "serverTimeout":serverTimeout,
14 "redirectPort":redirectPort
15}
请求头域
除公共头域外,无其他特殊头域
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1 |
blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
clientToken | String | 是 | Query参数 | 幂等性Token,长度不超过64位 |
listenerPort | int | 是 | Query参数 | 要更新的监听器端口,需为1-65535间的整数 |
scheduler | String | 是 | RequestBody参数 | 负载均衡算法,支持2种方式:"RoundRobin"/"LeastConnection","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数 |
keepSession | boolean | 否 | RequestBody参数 | 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器,默认关闭 |
keepSessionType | String | 否 | RequestBody参数 | 会话保持的cookie处理方式,当且仅当开启会话保持时有效,支持"insert"/"rewrite",默认"insert" |
keepSessionTimeout | int | 否 | RequestBody参数 | 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效,默认3600s,需为1-15552000间的整数 |
keepSessionCookieName | String | 否 | RequestBody参数 | 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效 |
xForwardedFor | boolean | 否 | RequestBody参数 | 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址,默认关闭 |
xForwardedProto | boolean | 否 | RequestBody参数 | 是否开启获取监听协议,开启后后端服务器上可以通过X-Forwarded-Proto这个HTTP Header来获得监听协议,默认关闭 |
serverTimeout | int | 否 | RequestBody参数 | 后端服务器最大超时(单位:秒),默认30s,需为1-3600间的整数 |
redirectPort | int | 否 | RequestBody参数 | 将此监听器收到的请求转发到HTTPS监听器,HTTPS监听器通过这个端口指定 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
无
请求示例
1PUT /v1/appblb/lb-j8UqijYf/HTTPlistener?clientToken=asdfg&listenerPort=80 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 "scheduler":"LeastConnection",
7 "xForwardedFor":true,
8 "serverTimeout":1800,
9}
响应示例
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
UpdateAppHTTPSListener更新HTTPS监听器
- 更新指定LoadBalancer下的HTTPS监听器参数,所有请求参数中指定的域都会被更新,未指定的域保持不变,监听器通过端口指定
请求结构
1PUT /v{version}/appblb/{blbId}/HTTPSlistener?clientToken={clientToken}&listenerPort={listenerPort} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "scheduler":scheduler,
7 "keepSession":keepSession,
8 "keepSessionType":keepSessionType,
9 "keepSessionDuration":keepSessionDuration,
10 "keepSessionCookieName":keepSessionCookieName,
11 "xForwardedFor":xForwardedFor,
12 "xForwardedProto":xForwardedProto,
13 "serverTimeout":serverTimeout,
14 "certIds":[id1, id2],
15 "encryptionType":encryptionType,
16 "encryptionProtocols":[protocol1, protacol2],
17 "dualAuth":false,
18 "clientCertIds":[id1, id2]
19}
请求头域
除公共头域外,无其他特殊头域
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1 |
blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
clientToken | String | 是 | Query参数 | 幂等性Token,长度不超过64位 |
listenerPort | int | 是 | Query参数 | 要更新的监听器端口,需为1-65535间的整数 |
scheduler | String | 是 | RequestBody参数 | 负载均衡算法,支持2种方式:"RoundRobin"/"LeastConnection","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数 |
keepSession | boolean | 否 | RequestBody参数 | 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器,默认关闭 |
keepSessionType | String | 否 | RequestBody参数 | 会话保持的cookie处理方式,当且仅当开启会话保持时有效,支持"insert"/"rewrite",默认"insert" |
keepSessionTimeout | int | 否 | RequestBody参数 | 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效,默认3600s,需为1-15552000间的整数 |
keepSessionCookieName | String | 否 | RequestBody参数 | 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效 |
xForwardedFor | boolean | 否 | RequestBody参数 | 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址,默认关闭 |
xForwardedProto | boolean | 否 | RequestBody参数 | 是否开启获取监听协议,开启后后端服务器上可以通过X-Forwarded-Proto这个HTTP Header来获得监听协议,默认关闭 |
serverTimeout | int | 否 | RequestBody参数 | 后端服务器最大超时(单位:秒),默认30s,需为1-3600间的整数 |
certIds | List<String> | 是 | 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,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
无
请求示例
1PUT /v1/appblb/lb-j8UqijYf/HTTPSlistener?clientToken=asdfg&listenerPort=80 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 "scheduler":"LeastConnection",
7 "xForwardedFor":true,
8 "serverTimeout":1800,
9 "certIds":["cert-zfj2ey2z4kmm"]
10}
响应示例
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
UpdateAppSSLListener更新SSL监听器
- 更新指定LoadBalancer下的SSL监听器参数,所有请求参数中指定的域都会被更新,未指定的域保持不变,监听器通过端口指定。
请求结构
1PUT /v{version}/appblb/{blbId}/SSLlistener?clientToken={clientToken}&listenerPort={listenerPort} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "scheduler":scheduler,
7 "certIds":[id1, id2],
8 "encryptionType":encryptionType,
9 "encryptionProtocols":[protocol1, protacol2],
10 "dualAuth":false,
11 "clientCertIds":[id1, id2]
12}
请求头域
除公共头域外,无其他特殊头域
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1 |
blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
clientToken | String | 是 | Query参数 | 幂等性Token,长度不超过64位 |
listenerPort | int | 是 | Query参数 | 要更新的监听器端口,需为1-65535间的整数 |
scheduler | String | 否 | RequestBody参数 | 负载均衡算法,支持3种方式:"RoundRobin"/"LeastConnection"/"Hash","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"Hash"代表根据源ip哈希 |
certIds | List<String> | 是 | 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,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
无
请求示例
1PUT /v1/appblb/lb-j8UqijYf/TCPlistener?clientToken=asdfg&listenerPort=80 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 "scheduler":"LeastConnection",
7 "certIds":["cert-zfj2ey2z4kmm"]
8}
响应示例
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
DescribeAppTCPListeners查询应用型TCP监听器
- 查询指定LoadBalancer下所有TCP监听器的信息
- 支持按监听器端口进行匹配查询
- 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定
请求结构
1GET /v{version}/appblb/{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<AppTCPListenerModel> | 包含查询结果的列表 |
marker | String | 标记查询的起始位置,若结果列表为空,此项不存在 |
isTruncated | boolean | true表示后面还有数据,false表示已经是最后一页 |
nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现 |
maxKeys | int | 每页包含的最大数量 |
请求示例
1GET /v1/appblb/lb-j8UqijYf/TCPlistener?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
响应示例
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 "scheduler": "RoundRobin"
13 },
14 {
15 "listenerPort": 88,
16 "scheduler": "RoundRobin"
17 }
18 ],
19 "marker": "listener-0050",
20 "nextMarker": null,
21 "isTruncated": false,
22 "maxKeys": 2
23}
DescribeAppUDPListeners查询UDP监听器
- 查询指定LoadBalancer下所有UDP监听器的信息
- 支持按监听器端口进行匹配查询
- 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定
请求结构
1GET /v{version}/appblb/{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<AppUDPListenerModel> | 包含查询结果的列表 |
marker | String | 标记查询的起始位置,若结果列表为空,此项不存在 |
isTruncated | boolean | true表示后面还有数据,false表示已经是最后一页 |
nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现 |
maxKeys | int | 每页包含的最大数量 |
请求示例
1GET /v1/appblb/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
响应示例
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 "scheduler": "RoundRobin",
13 "udpSessionTimeout":90
14 },
15 {
16 "listenerPort": 88,
17 "scheduler": "RoundRobin",
18 "udpSessionTimeout":90
19 }
20 ],
21 "marker": "listener-0050",
22 "nextMarker": null,
23 "isTruncated": false,
24 "maxKeys": 2
25}
DescribeAppHTTPListeners查询HTTP监听器
- 查询指定LoadBalancer下所有HTTP监听器的信息
- 支持按监听器端口进行匹配查询
- 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定
请求结构
1GET /v{version}/appblb/{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<AppHTTPListenerModel> | 包含查询结果的列表 |
marker | String | 标记查询的起始位置,若结果列表为空,此项不存在 |
isTruncated | boolean | true表示后面还有数据,false表示已经是最后一页 |
nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现 |
maxKeys | int | 每页包含的最大数量 |
请求示例
1GET /v1/appblb/lb-j8UqijYf/HTTPlistener?maxKeys=2 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T06:42:31Z/1800/host/3f26e5a322d41fa0f3315e906342c2691fe5ee35d21c7e66e425b4ee0f67ced3
响应示例
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 "keepSession": false,
15 "keepSessionType": null,
16 "keepSessionTimeout": null,
17 "keepSessionCookieName": null,
18 "xForwardedFor": false,
19 "serverTimeout": 30,
20 "redirectPort": 80
21 },
22 {
23 "listenerPort": 95,
24 "backendPort": 95,
25 "scheduler": "LeastConnection",
26 "keepSession": false,
27 "keepSessionType": null,
28 "keepSessionTimeout": null,
29 "keepSessionCookieName": null,
30 "xForwardedFor": false,
31 "serverTimeout": 1800,
32 "redirectPort": 80
33 }
34 ],
35 "marker": "listener-005A",
36 "nextMarker": null,
37 "isTruncated": false,
38 "maxKeys": 2
39}
DescribeAppHTTPSListeners查询HTTPS监听器
- 查询指定LoadBalancer下所有HTTPS监听器的信息
- 支持按监听器端口进行匹配查询
- 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定
请求结构
1GET /v{version}/appblb/{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<AppHTTPSListenerModel> | 包含查询结果的列表 |
marker | String | 标记查询的起始位置,若结果列表为空,此项不存在 |
isTruncated | boolean | true表示后面还有数据,false表示已经是最后一页 |
nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现 |
maxKeys | int | 每页包含的最大数量 |
请求示例
1GET /v1/appblb/lb-j8UqijYf/HTTPSlistener?maxKeys=2 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T06:42:31Z/1800/host/3f26e5a322d41fa0f3315e906342c2691fe5ee35d21c7e66e425b4ee0f67ced3
响应示例
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 "keepSession": false,
15 "keepSessionType": null,
16 "keepSessionTimeout": null,
17 "keepSessionCookieName": null,
18 "xForwardedFor": false,
19 "serverTimeout": 30,
20 "certIds": ["cert-zfj2ey2z4kmm"]
21 },
22 {
23 "listenerPort": 95,
24 "backendPort": 95,
25 "scheduler": "LeastConnection",
26 "keepSession": false,
27 "keepSessionType": null,
28 "keepSessionTimeout": null,
29 "keepSessionCookieName": null,
30 "xForwardedFor": false,
31 "serverTimeout": 1800,
32 "certIds": ["cert-zfj2ey2z4kmm"]
33 }
34 ],
35 "marker": "listener-005A",
36 "nextMarker": null,
37 "isTruncated": false,
38 "maxKeys": 2
39}
DescribeAppSSLListeners查询应用型SSL监听器
- 查询指定LoadBalancer下所有SSL监听器的信息
- 支持按监听器端口进行匹配查询
- 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定
请求结构
1GET /v{version}/appblb/{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<AppSSLListenerModel> | 包含查询结果的列表 |
marker | String | 标记查询的起始位置,若结果列表为空,此项不存在 |
isTruncated | boolean | true表示后面还有数据,false表示已经是最后一页 |
nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现 |
maxKeys | int | 每页包含的最大数量 |
请求示例
1GET /v1/appblb/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
响应示例
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 "scheduler": "RoundRobin",
13 "certIds": ["cert-zfj2ey2z4kmm"]
14 },
15 {
16 "listenerPort": 88,
17 "scheduler": "RoundRobin",
18 "certIds": ["cert-zfj2ey2z4kmm"]
19 }
20 ],
21 "marker": "listener-0050",
22 "nextMarker": null,
23 "isTruncated": false,
24 "maxKeys": 2
25}
DescribeAppAllListeners查询所有监听
请求结构
1GET /v{version}/appblb/{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<AppListenerModel> | 包含查询的监听列表 |
请求示例
1GET /v1/appblb/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
返回示例
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 "scheduler": "RoundRobin",
16 "listenerType": "UDP"
17 },
18 {
19 "listenerPort": 80,
20 "scheduler": "RoundRobin",
21 "listenerType": "HTTP",
22 "keepSession": false,
23 "xForwardFor": true,
24 "xForwardedProto": false,
25 "serverTimeout": 30,
26 "redirectPort": 0
27 },
28 {
29 "listenerPort": 81,
30 "scheduler": "RoundRobin",
31 "listenerType": "TCP",
32 "tcpSessionTimeout": 900
33 },
34 {
35 "listenerPort": 443,
36 "scheduler": "RoundRobin",
37 "listenerType": "SSL",
38 "certIds": [
39 "cert-gs8bktrm7drp"
40 ],
41 "dualAuth": false,
42 "encryptionType": "tls_cipher_policy_ie",
43 "encryptionProtocols": [
44 "sslv3",
45 "tlsv10",
46 "tlsv11",
47 "tlsv12"
48 ],
49 "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-ECDSA-RC4-SHA:ECDHE-ECDSA-DES-CBC3-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:ECDHE-RSA-RC4-SHA:ECDHE-RSA-DES-CBC3-SHA:RC4-SHA:AES128-GCM-SHA256:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES256-SHA:AES128-SHA256:DES-CBC3-SHA"
50 },
51 {
52 "listenerPort": 444,
53 "scheduler": "RoundRobin",
54 "listenerType": "HTTPS",
55 "keepSession": false,
56 "xForwardFor": false,
57 "xForwardedProto": false,
58 "serverTimeout": 30,
59 "certIds": [
60 "cert-gs8bktrm7drp"
61 ],
62 "dualAuth": false,
63 "encryptionType": "tls_cipher_policy_1_1",
64 "encryptionProtocols": [
65 "tlsv11",
66 "tlsv12"
67 ],
68 "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"
69 }
70 ]
71}
DeleteAppListeners释放监听器
- 释放指定LoadBalancer下的监听器,监听器通过监听端口来指定
- 支持批量释放
请求结构
1PUT /v{version}/appblb/{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 | 是 | Query参数 | 必须为batchdelete |
clientToken | String | 是 | Query参数 | 幂等性Token |
portList | List\<int> | 否 | RequestBody参数 | 所有待释放的监听器的端口,一起组成一个数组 |
portTypeList | List<PortTypeModel> | 否 | RequestBody参数 | 所有待释放的监听器的端口和协议,一起组成一个数组,如果开通了同端口多协议,并且只想删除其中一个协议,使用这个参数。portList和portTypeList至少传一个。 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
无
请求示例
1PUT /v1/appblb/lb-j8UqijYf/listener?batchdelete&clientToken=abc
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T03:26:45Z/1800/host/c863c8b9f75ff307eb1a3c564307b0833acb9d857c65de108258c3edd4cd0118
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}
响应示例
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
CreatePolicys创建策略
- 在指定应用型BLB监听器端口下创建策略
请求结构
1POST /v{version}/appblb/{blbId}/policys?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "listenerPort": listenerPort,
7 "appPolicyVos": [
8 {
9 "appServerGroupId": appServerGroupId,
10 "backendPort": backendPort,
11 "priority": priority,
12 "desc": desc,
13 "ruleList": [
14 {
15 "key": key,
16 "value": value
17 }
18 ]
19 }
20 ]
21
22}
请求头域
除公共头域外,无其他特殊头域
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1 |
blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
clientToken | String | 是 | Query参数 | 幂等性Token |
listenerPort | int | 是 | RequestBody参数 | 对应所在BLB下监听器端口号 |
appPolicyVos | List<CreateAppPolicy> | 是 | RequestBody参数 | 监听器绑定策略列表,当监听器类型为TCP、UDP、SSL时,只能创建一条且只支持全匹配;当监听器类型为http、https监听器支持多个policy |
type | String | 否 | RequestBody参数 | 当监听器端口下有多个协议时,type必传 |
返回状态码
成功返回200,失败返回见错误码 返回头域
除公共头域外,无其他特殊头域
返回参数
无
请求示例
1POST /v1/appblb/lb-j8UqijYf/policys?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": 98,
7 "type": "HTTP",
8 "appPolicyVos": [
9 {
10 "appServerGroupId": "sg-db3975dc",
11 "backendPort": 83,
12 "priority": 100,
13 "desc": "aa",
14 "ruleList": [
15 {
16 "key": "*",
17 "value": "*"
18 }
19 ]
20 }
21 ]
22}
响应示例
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
DescribePolicys查询对应BLB端口下策略信息
- 查询指定LoadBalancer下所有服务器组的信息
- 支持按监听器端口进行匹配查询
- 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定
请求结构
1GET /v{version}/appblb/{blbId}/policys?marker={marker}&maxKeys={maxKeys}&port={port} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其他特殊头域
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1 |
blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
port | int | 是 | Query参数 | BLB下监听器端口号 |
type | String | 否 | Query参数 | 当监听器端口下有多个协议时,type必传 |
marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置,是一个由系统生成的字符串 |
maxKeys | int | 否 | Query参数 | 每页包含的最大数量,最大数量不超过1000。缺省值为1000 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
policyList | List<AppPolicy> | 包含查询结果的列表 |
marker | String | 标记查询的起始位置,若结果列表为空,此项不存在 |
isTruncated | boolean | true表示后面还有数据,false表示已经是最后一页 |
nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现 |
maxKeys | int | 每页包含的最大数量 |
请求示例
1GET /v1/appblb/lb-j8UqijYf/policys?maxKeys=2&port=80&type=HTTP HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T06:42:31Z/1800/host/3f26e5a322d41fa0f3315e906342c2691fe5ee35d21c7e66e425b4ee0f67ced3
响应示例
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 "marker": "rs-012310",
10 "isTruncated": true,
11 "maxKeys": 1000,
12 "nextMarker": "rs-013214",
13 "policyList":[
14 {
15 "id":"policy_id",
16 "appServerGroupId":”sg_id“,
17 "appServerGroupName":”sg_name“,
18 "frontendPort":80,
19 "type":"TCP",
20 "backendPort":98,
21 "portType":"TCP",
22 "priority":100,
23 "desc":"aa",
24 "groupType":"Server",
25 "ruleList": [
26 {
27 "key": "host",
28 "value": "*.baidu.com"
29 }
30 ]
31 }
32 ]
33}
DeletePolicys批量删除策略
- 批量删除对应BLB端口下的策略
请求结构
1PUT /v{version}/appblb/{blbId}/policys?{action}&clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "port": port,
7 policyIdList: ["policyId1", "policyId2", "policyId3"]
8}
请求头域
除公共头域外,无其他特殊头域
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1 |
blbId | String | 是 | URL参数 | 所属LoadBalancer的标识符 |
action | String | 是 | Query参数 | 必须为batchdelete |
clientToken | String | 是 | Query参数 | 幂等性Token |
port | int | 是 | RequestBody参数 | 要删除策略前端端口 |
policyIdList | List\<String> | 是 | RequestBody参数 | 所有待释放的策略标识符,一起组成一个数组 |
type | String | 否 | RequestBody参数 | 当监听器端口下有多个协议时,type必传 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
无
请求示例
1PUT /v1/appblb/lb-j8UqijYf/policys?batchdelete&clientToken=your_clientToken
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T03:26:45Z/1800/host/c863c8b9f75ff307eb1a3c564307b0833acb9d857c65de108258c3edd4cd0118
4
5{
6 "port":90,
7 "policyIdList": ["ab48bbe", "2520741", "a78e04"]
8}
响应示例
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