Application IPv6 BLB Listener Related Interfaces

Updated at：2025-10-16

CreateAppTCPListener: Create TCP listener

Within the specified LoadBalancer, create a TCP-based application BLB listener to monitor a frontend port and forward all TCP traffic to this port according to defined policies.

Request structure

Plain Text

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}

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
clientToken	String	Yes	Query	Idempotency Token, with length no more than 64 characters.
listenerPort	int	Yes	RequestBody	The listener port, which shall be an integer between 1 and 65535.
scheduler	String	Yes	RequestBody	Load balancer algorithm supporting 3 methods: "RoundRobin"/"LeastConnection"/"Hash", among which "RoundRobin" means weighted round-robin, "LeastConnection" means weighted minimum connection counts, and "Hash" means source IP-based hashing.
tcpSessionTimeout	int	No	RequestBody	TCP connection timeout duration setting (unit: second). It is 900 by default, and shall be an integer between 10 and 4000.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

None

Request example

Plain Text

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}

Response example

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

CreateAppUDPListener: Creates UDP listener

Create a UDP-based application listener for the specified LoadBalancer to listen on a frontend port and forward all UDP traffic to it based on defined policies.

Request structure

Plain Text

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}

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
clientToken	String	Yes	Query	Idempotency Token, with length no more than 64 characters.
listenerPort	int	Yes	RequestBody	The listener port, which shall be an integer between 1 and 65535.
scheduler	String	Yes	RequestBody	Load balancer algorithm supporting 3 methods: "RoundRobin"/"LeastConnection"/"Hash", among which "RoundRobin" means weighted round-robin, "LeastConnection" means weighted minimum connection counts, and "Hash" means source IP-based hashing.
udpSessionTimeout	int	No	RequestBody	UDP session timeout duration. The default is 90 seconds, but it can be set as an integer between 5 and 4000 seconds.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

None

Request example

Plain Text

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}

Response example

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

CreateAppHTTPListener: Create HTTP listener

Under the specified LoadBalancer, create an HTTP-based application listener listening to a frontend port to forward all HTTP requests to the backend port listened to by real servers according to policies.

Request structure

Plain Text

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}

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
clientToken	String	Yes	Query	Idempotency Token, with length no more than 64 characters.
listenerPort	int	Yes	RequestBody	The listener port, which shall be an integer between 1 and 65535.
scheduler	String	Yes	RequestBody	Load balancer algorithm supporting 2 methods: "RoundRobin"/"LeastConnection", among which "RoundRobin" means weighted round-robin, and "LeastConnection" means minimum connection counts.
keepSession	boolean	No	RequestBody	Whether to enable the session persistence function, meaning requests from the same client will be sent to the same real server. It is disabled by default.
keepSessionType	String	No	RequestBody	Cookie handling method for session persistence, valid only when the session persistence is enabled, supporting "insert"/"rewrite". It is "insert" by default.
keepSessionTimeout	int	No	RequestBody	Cookie validity period for session persistence (unit: second). It is valid only when session persistence is enabled. It is 3600s by default, and shall be an integer between 1 and 15552000.
keepSessionCookieName	String	No	RequestBody	Cookie name to be overwritten for session persistence, valid only when the session persistence is enabled and keepSessionType="rewrite".
xForwardedFor	boolean	No	RequestBody	Whether to enable retrieving the real IP of the client. Once it is enabled, the real server can retrieve the real IP address of the client via the HTTP Header X-Forwarded-For. It is disabled by default.
xForwardedProto	boolean	No	RequestBody	Whether to enable retrieving listener protocol. Once it is enabled, real servers can acquire the listener protocol via the X-Forwarded-Proto HTTP Header. It is disabled by default.
serverTimeout	int	No	RequestBody	Real server maximum timeout (unit: second). It is 30 s by default, and shall be an integer between 1 and 3600.
redirectPort	int	No	RequestBody	Requests received by this listener is forwarded to the HTTPS listener, which is specified through this port.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

None

Request example

Plain Text

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}

Response example

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

CreateAppHTTPSListener: Create HTTPS listener

Under the specified LoadBalancer, create an application listener based on HTTPS to listen to a frontend port, convert all HTTPS requests to that port into HTTP requests via SSL uninstallation, then forward them to the backend port listened to by real servers according to policies.

Request structure

Plain Text

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}

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
clientToken	String	Yes	Query	Idempotency Token, with length no more than 64 characters.
listenerPort	int	Yes	RequestBody	The listener port, which shall be an integer between 1 and 65535.
scheduler	String	Yes	RequestBody	Load balancer algorithm supporting 2 methods: "RoundRobin"/"LeastConnection", among which "RoundRobin" means weighted round-robin, and "LeastConnection" means minimum connection counts.
keepSession	boolean	No	RequestBody	Whether to enable the session persistence function, meaning requests from the same client will be sent to the same real server. It is disabled by default.
keepSessionType	String	No	RequestBody	Cookie handling method for session persistence, valid only when the session persistence is enabled, supporting "insert"/"rewrite". It is "insert" by default.
keepSessionTimeout	int	No	RequestBody	Cookie validity period for session persistence (unit: second). It is valid only when session persistence is enabled. It is 3600s by default, and shall be an integer between 1 and 15552000.
keepSessionCookieName	String	No	RequestBody	Cookie name to be overwritten for session persistence, valid only when the session persistence is enabled and keepSessionType="rewrite".
xForwardedFor	boolean	No	RequestBody	Whether to enable retrieving the real IP of the client. Once it is enabled, the real server can retrieve the real IP address of the client via the HTTP Header X-Forwarded-For. It is disabled by default.
xForwardedProto	boolean	No	RequestBody	Whether to enable retrieving listener protocol. Once it is enabled, real servers can acquire the listener protocol via the X-Forwarded-Proto HTTP Header. It is disabled by default.
serverTimeout	int	No	RequestBody	Real server maximum timeout (unit: second). It is 30 s by default, and shall be an integer between 1 and 3600.
certIds	List\	Yes	RequestBody	Certificate chain to be loaded by the listener
encryptionType	String	No	RequestBody	Encryption option. It is tls_cipher_policy_default by default. Support: tls_cipher_policy_default/tls_cipher_policy_1_1/tls_cipher_policy_1_2/tls_cipher_policy_1_2_secure/userDefind. For corresponding encryption protocols and cipher suites, refer to [encryption](BLB/API Reference/Appendix.md#encryption).
encryptionProtocols	List	No	RequestBody	When encryptionType is userDefined, the protocol type list is a string array composed of the combinations of three protocols: "tlsv10", "tlsv11" and "tlsv12" protocol.
appliedCiphers	String	No	RequestBody	For the cipher suite, refer to [encryption](BLB/API Reference/Appendix.md#encryption) Different suites shall be separated by colons ":".
dualAuth	boolean	No	RequestBody	Whether to enable mutual authentication, and it is disabled by default.
clientCertIds	List\	No	RequestBody	It is the loaded client certificate chain when dualAuth is true.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

None

Request example

Plain Text

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}

Response example

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

CreateAppSSLListener: Create SSL listener

Create an SSL-based application listener for the specified LoadBalancer to listen on a frontend port and forward all SSL traffic to it according to defined policies.

Request structure

Plain Text

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}

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
clientToken	String	Yes	Query	Idempotency Token, with length no more than 64 characters.
listenerPort	int	Yes	RequestBody	The listener port, which shall be an integer between 1 and 65535.
scheduler	String	Yes	RequestBody	Load balancer algorithm supporting 3 methods: "RoundRobin"/"LeastConnection"/"Hash", among which "RoundRobin" means weighted round-robin, "LeastConnection" means weighted minimum connection counts, and "Hash" means source IP-based hashing.
certIds	List\	Yes	RequestBody	Certificate chain to be loaded by the listener
encryptionType	String	No	RequestBody	Encryption option. It is tls_cipher_policy_default by default. Support: tls_cipher_policy_default/tls_cipher_policy_1_1/tls_cipher_policy_1_2/tls_cipher_policy_1_2_secure/userDefind. For corresponding encryption protocols and cipher suites, refer to [encryption](BLB/API Reference/Appendix.md#encryption).
encryptionProtocols	List	No	RequestBody	When encryptionType is userDefined, the protocol type list is a string array composed of the combinations of three protocols: "tlsv10", "tlsv11" and "tlsv12" protocol.
appliedCiphers	String	No	RequestBody	For the cipher suite, refer to [encryption](BLB/API Reference/Appendix.md#encryption) Different suites shall be separated by colons ":".
dualAuth	boolean	No	RequestBody	Whether to enable mutual authentication, and it is disabled by default.
clientCertIds	List\	No	RequestBody	It is the loaded client certificate chain when dualAuth is true.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

None

Request example

Plain Text

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}

Response example

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

UpdateAppTCPListener: Update TCP listener

Update TCP listener parameters for the specified LoadBalancer. All specified domains in the request parameters will be updated, while unspecified domains will remain unchanged. Listeners must be designated via ports.

Request structure

Plain Text

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}

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
clientToken	String	Yes	Query	Idempotency Token, with length no more than 64 characters.
listenerPort	int	Yes	Query	Listener port No.
scheduler	String	No	RequestBody	Load balancer algorithm supporting 3 methods: "RoundRobin"/"LeastConnection"/"Hash", among which "RoundRobin" means weighted round-robin, "LeastConnection" means weighted minimum connection counts, and "Hash" means source IP-based hashing.
tcpSessionTimeout	int	No	RequestBody	TCP connection timeout duration setting (unit: second). It is 900 by default, and shall be an integer between 10 and 4000.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

None

Request example

Plain Text

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}

Response example

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

UpdateAppUDPListener: Update UDP listener

Update the parameters of a UDP listener under the specified LoadBalancer. All domains specified in the request parameters will be updated, while unspecified domains will remain unchanged. Listeners are identified by ports.

Request structure

Plain Text

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}

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
clientToken	String	Yes	Query	Idempotency Token, with length no more than 64 characters.
listenerPort	int	Yes	URL parameter	Listener port No.
scheduler	String	Yes	RequestBody	Load balancer algorithm supporting 3 methods: "RoundRobin"/"LeastConnection"/"Hash", among which "RoundRobin" means weighted round-robin, "LeastConnection" means weighted minimum connection counts, and "Hash" means source IP-based hashing.
udpSessionTimeout	int	No	RequestBody	UDP session timeout duration. The default is 90 seconds, but it can be set as an integer between 5 and 4000 seconds.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

None

Request example

Plain Text

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}

Response example

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

UpdateAppHTTPListener: Update HTTP listener

Update HTTP listener parameters under the specified LoadBalancer. Domains in all the request parameters will be updated; unspecified domains remain unchanged. Listeners are specified via ports.

Request structure

Plain Text

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}

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
clientToken	String	Yes	Query	Idempotency Token, with length no more than 64 characters.
listenerPort	int	Yes	Query	The listener port to be updated, which shall be an integer between 1 and 65535.
scheduler	String	Yes	RequestBody	Load balancer algorithm supporting 2 methods: "RoundRobin"/"LeastConnection", among which "RoundRobin" means weighted round-robin, and "LeastConnection" means minimum connection counts.
keepSession	boolean	No	RequestBody	Whether to enable the session persistence function, meaning requests from the same client will be sent to the same real server. It is disabled by default.
keepSessionType	String	No	RequestBody	Cookie handling method for session persistence, valid only when the session persistence is enabled, supporting "insert"/"rewrite". It is "insert" by default.
keepSessionTimeout	int	No	RequestBody	Cookie validity period for session persistence (unit: second). It is valid only when session persistence is enabled. It is 3600s by default, and shall be an integer between 1 and 15552000.
keepSessionCookieName	String	No	RequestBody	Cookie name to be overwritten for session persistence, valid only when the session persistence is enabled and keepSessionType="rewrite".
xForwardedFor	boolean	No	RequestBody	Whether to enable retrieving the real IP of the client. Once it is enabled, the real server can retrieve the real IP address of the client via the HTTP Header X-Forwarded-For. It is disabled by default.
xForwardedProto	boolean	No	RequestBody	Whether to enable retrieving listener protocol. Once it is enabled, real servers can acquire the listener protocol via the X-Forwarded-Proto HTTP Header. It is disabled by default.
serverTimeout	int	No	RequestBody	Real server maximum timeout (unit: second). It is 30 s by default, and shall be an integer between 1 and 3600.
redirectPort	int	No	RequestBody	Requests received by this listener is forwarded to the HTTPS listener, which is specified through this port.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

None

Request example

Plain Text

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}

Response example

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

UpdateAppHTTPSListener: Update HTTPS listener

Update HTTPS listener parameters under the specified LoadBalancer. Domains in all the request parameters will be updated; unspecified domains remain unchanged. Listeners are specified via ports.

Request structure

Plain Text

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}

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
clientToken	String	Yes	Query	Idempotency Token, with length no more than 64 characters.
listenerPort	int	Yes	Query	The listener port to be updated, which shall be an integer between 1 and 65535.
scheduler	String	Yes	RequestBody	Load balancer algorithm supporting 2 methods: "RoundRobin"/"LeastConnection", among which "RoundRobin" means weighted round-robin, and "LeastConnection" means minimum connection counts.
keepSession	boolean	No	RequestBody	Whether to enable the session persistence function, meaning requests from the same client will be sent to the same real server. It is disabled by default.
keepSessionType	String	No	RequestBody	Cookie handling method for session persistence, valid only when the session persistence is enabled, supporting "insert"/"rewrite". It is "insert" by default.
keepSessionTimeout	int	No	RequestBody	Cookie validity period for session persistence (unit: second). It is valid only when session persistence is enabled. It is 3600s by default, and shall be an integer between 1 and 15552000.
keepSessionCookieName	String	No	RequestBody	Cookie name to be overwritten for session persistence, valid only when the session persistence is enabled and keepSessionType="rewrite".
xForwardedFor	boolean	No	RequestBody	Whether to enable retrieving the real IP of the client. Once it is enabled, the real server can retrieve the real IP address of the client via the HTTP Header X-Forwarded-For. It is disabled by default.
xForwardedProto	boolean	No	RequestBody	Whether to enable retrieving listener protocol. Once it is enabled, real servers can acquire the listener protocol via the X-Forwarded-Proto HTTP Header. It is disabled by default.
serverTimeout	int	No	RequestBody	Real server maximum timeout (unit: second). It is 30 s by default, and shall be an integer between 1 and 3600.
certIds	List	Yes	RequestBody	Certificate chain to be loaded by the listener
encryptionType	String	No	RequestBody	Encryption options. Support: tls_cipher_policy_default/tls_cipher_policy_1_1/tls_cipher_policy_1_2/tls_cipher_policy_1_2_secure/userDefind. For corresponding encryption protocols and cipher suites, refer to [encryption](BLB/API Reference/Appendix.md#encryption).
encryptionProtocols	List	No	RequestBody	When encryptionType is userDefined, the protocol type list is a string array composed of the combinations of three protocols: "tlsv10", "tlsv11" and "tlsv12" protocol.
appliedCiphers	String	No	RequestBody	For the cipher suite, refer to [encryption](BLB/API Reference/Appendix.md#encryption) Different suites shall be separated by colons ":".
dualAuth	boolean	No	RequestBody	Whether to enable mutual authentication, and it is disabled by default.
clientCertIds	List	No	RequestBody	It is the loaded client certificate chain when dualAuth is true.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

None

Request example

Plain Text

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}

Response example

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

UpdateAppSSLListener: Update SSL listener

Update the parameters of an SSL listener under the specified LoadBalancer. All domains specified in the request parameters will be updated, while unspecified domains will remain unchanged. Listeners are identified by ports.

Request structure

Plain Text

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}

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
clientToken	String	Yes	Query	Idempotency Token, with length no more than 64 characters.
listenerPort	int	Yes	Query	The listener port to be updated, which shall be an integer between 1 and 65535.
scheduler	String	No	RequestBody	Load balancer algorithm supporting 3 methods: "RoundRobin"/"LeastConnection"/"Hash", among which "RoundRobin" means weighted round-robin, "LeastConnection" means weighted minimum connection counts, and "Hash" means source IP-based hashing.
certIds	List	Yes	RequestBody	Certificate chain to be loaded by the listener
encryptionType	String	No	RequestBody	Encryption options. Support: tls_cipher_policy_default/tls_cipher_policy_1_1/tls_cipher_policy_1_2/tls_cipher_policy_1_2_secure/userDefind. For corresponding encryption protocols and cipher suites, refer to [encryption](BLB/API Reference/Appendix.md#encryption).
encryptionProtocols	List	No	RequestBody	When encryptionType is userDefined, the protocol type list is a string array composed of the combinations of three protocols: "tlsv10", "tlsv11" and "tlsv12" protocol.
appliedCiphers	String	No	RequestBody	For the cipher suite, refer to [encryption](BLB/API Reference/Appendix.md#encryption) Different suites shall be separated by colons ":".
dualAuth	boolean	No	RequestBody	Whether to enable mutual authentication, and it is disabled by default.
clientCertIds	List	No	RequestBody	It is the loaded client certificate chain when dualAuth is true.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

None

Request example

Plain Text

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}

Response example

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

DescribeAppTCPListeners: Query application TCP listeners

Query information of all TCP listeners under the specified LoadBalancer
Support querying by listener port for matching items
Results support marker-based pagination, with a default page size of 1000, which can be specified via the maxKeys parameter.

Request structure

Plain Text

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

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
listenerPort	int	No	Query	Listener port to be queried
marker	String	No	Query	The starting position of the batch list query is a system-generated string
maxKeys	int	No	Query	Maximum number of items per page is 1,000, with a default value of 1000.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

Parameter name	Types	Description
listenerList	List<[AppTCPListenerModel](BLB/API Reference/Appendix.md#AppTCPListenerModel)>	List containing query results
marker	String	Marker indicating the starting position of the query. If the result list is empty, this field does not exist.
isTruncated	boolean	true indicates there is more data later, false indicates it is the last page
nextMarker	String	The marker value needed to fetch the next page. This field is absent when isTruncated is false.
maxKeys	int	Maximum number of items included per page

Request example

Plain Text

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

Response example

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            "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: Query UDP listeners

Query information of all UDP listeners under the specified LoadBalancer
Support querying by listener port for matching items
Results support marker-based pagination, with a default page size of 1000, which can be specified via the maxKeys parameter.

Request structure

Plain Text

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

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
listenerPort	int	No	Query	Listener port to be queried
marker	String	No	Query	The starting position of the batch list query is a system-generated string
maxKeys	int	No	Query	Maximum number of items per page is 1,000, with a default value of 1000.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md#Error code)

Response headers

No special headers beyond common headers.

Response parameters

Parameter name	Types	Description
listenerList	List<[AppUDPListenerModel](BLB/API Reference/Appendix.md#AppUDPListenerModel)>	List containing query results
marker	String	Marker indicating the starting position of the query. If the result list is empty, this field does not exist.
isTruncated	boolean	true indicates there is more data later, false indicates it is the last page
nextMarker	String	The marker value needed to fetch the next page. This field is absent when isTruncated is false.
maxKeys	int	Maximum number of items included per page

Request example

Plain Text

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

Response example

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            "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: Query HTTP listeners

Query information of all HTTP listeners under the specified LoadBalancer
Support querying by listener port for matching items
Results support marker-based pagination, with a default page size of 1000, which can be specified via the maxKeys parameter.

Request structure

Plain Text

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

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
listenerPort	int	No	Query	Listener port to be queried
marker	String	No	Query	The starting position of the batch list query is a system-generated string
maxKeys	int	No	Query	Maximum number of items per page is 1,000, with a default value of 1000.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

Parameter name	Types	Description
listenerList	List<[AppHTTPListenerModel](BLB/API Reference/Appendix.md#AppHTTPListenerModel)>	List containing query results
marker	String	Marker indicating the starting position of the query. If the result list is empty, this field does not exist.
isTruncated	boolean	true indicates there is more data later, false indicates it is the last page
nextMarker	String	The marker value needed to fetch the next page. This field is absent when isTruncated is false.
maxKeys	int	Maximum number of items included per page

Request example

Plain Text

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

Response example

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            "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: Query HTTPS listeners

Query information of all HTTPS listeners under the specified LoadBalancer
Support querying by listener port for matching items
Results support marker-based pagination, with a default page size of 1000, which can be specified via the maxKeys parameter.

Request structure

Plain Text

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

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
listenerPort	int	No	Query	Listener port to be queried
marker	String	No	Query	The starting position of the batch list query is a system-generated string
maxKeys	int	No	Query	Maximum number of items per page is 1,000, with a default value of 1000.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md#Error code)

Response headers

No special headers beyond common headers.

Response parameters

Parameter name	Types	Description
listenerList	List<[AppHTTPSListenerModel](BLB/API Reference/Appendix.md#AppHTTPSListenerModel)>	List containing query results
marker	String	Marker indicating the starting position of the query. If the result list is empty, this field does not exist.
isTruncated	boolean	true indicates there is more data later, false indicates it is the last page
nextMarker	String	The marker value needed to fetch the next page. This field is absent when isTruncated is false.
maxKeys	int	Maximum number of items included per page

Request example

Plain Text

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

Response example

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            "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: Query application SSL listeners

Query information of all SSL listeners under the specified LoadBalancer
Support querying by listener port for matching items
Results support marker-based pagination, with a default page size of 1000, which can be specified via the maxKeys parameter.

Request structure

Plain Text

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

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
listenerPort	int	No	Query	Listener port to be queried
marker	String	No	Query	The starting position of the batch list query is a system-generated string
maxKeys	int	No	Query	Maximum number of items per page is 1,000, with a default value of 1000.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

Parameter name	Types	Description
listenerList	List<[AppSSLListenerModel](BLB/API Reference/Appendix.md#AppSSLListenerModel)>	List containing query results
marker	String	Marker indicating the starting position of the query. If the result list is empty, this field does not exist.
isTruncated	boolean	true indicates there is more data later, false indicates it is the last page
nextMarker	String	The marker value needed to fetch the next page. This field is absent when isTruncated is false.
maxKeys	int	Maximum number of items included per page

Request example

Plain Text

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

Response example

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            "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: Query all listeners

Request structure

Plain Text

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

Request headers

There are no special headers required beyond the common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
listenerPort	int	No	Query	Listener port to be queried
marker	String	No	Query	The starting position of the batch list query is a system-generated string
maxKeys	int	No	Query	Maximum number of items included per page, maximum: 1,000, default: 1,000

Response headers

No special headers are required beyond the standard ones.

Response parameters

Parameter name	Types	Description
marker	String	Mark the starting position of the query.
isTruncated	boolean	true indicates there is more data later, false indicates it is the last page
nextMarker	String	The marker value needed to fetch the next page. This field is absent when isTruncated is false.
maxKeys	int	Maximum number of items included per page
listenerList	List<[AppListenerModel](BLB/API Reference/Appendix.md#AppListenerModel)>	Contain the listener list queried

Request example

Plain Text

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

Response example

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        "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: Delete listener

Delete listeners under the specified LoadBalancer. Those listeners are specified by listener ports.
Supports batch deletion

Request structure

Plain Text

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 Or
9{
10    "portTypeList":[
11        {
12            "port":port,
13            "type":"type"
14        },
15        {
16            "port":port,
17            "type":"type"
18        },
19    ]
20}

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
action	String	Yes	Query	It must be batchdelete.
clientToken	String	Yes	Query	Idempotency Token
portList	List\	No	RequestBody	All ports of listeners to be deleted form an array.
portTypeList	List<[PortTypeModel](BLB/API Reference/Appendix.md#PortTypeModel)>	No	RequestBody	An array of all ports and protocols of listeners to be deleted. If multiple protocols on the same port are enabled and only one protocol needs to be removed, use this parameter. At least one of portList or portTypeList must be provided.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

None

Request example

Plain Text

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 Or
9{
10    "portTypeList":[
11        {
12            "port":80,
13            "type":"TCP"
14        },
15        {
16            "port":80,
17            "type":"UDP"
18        },
19    ]
20}

Response example

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

CreatePolicys: Create policies

Create policies under the specified application BLB listener port

Request structure

Plain Text

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}

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
clientToken	String	Yes	Query	Idempotency Token
listenerPort	int	Yes	RequestBody	Corresponding listener port No. under the BLB
appPolicyVos	List<[CreateAppPolicy](BLB/API Reference/Appendix.md#CreateAppPolicy)>	Yes	RequestBody	List of listener binding policies. For TCP, UDP, and SSL listeners, one policy can be created only and full match is supported only. Multiple policies are supported for HTTP and HTTPS listeners.
type	String	No	RequestBody	When multiple protocols exist under a listener port, type is required.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md) Response headers

No special headers beyond common headers.

Response parameters

None

Request example

Plain Text

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}

Response example

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

DescribePolicys: Query policy information under the corresponding BLB port

You can query information of all server groups under the specified LoadBalancer
Support querying by listener port for matching items
Results support marker-based pagination, with a default page size of 1000, which can be specified via the maxKeys parameter.

Request structure

Plain Text

1GET /v{version}/appblb/{blbId}/policys?marker={marker}&maxKeys={maxKeys}&port={port} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
port	int	Yes	Query	Listener port No. under BLB
type	String	No	Query	When multiple protocols exist under a listener port, type is required.
marker	String	No	Query	The starting position of the batch list query is a system-generated string
maxKeys	int	No	Query	Maximum number of items per page is 1,000, with a default value of 1000.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

Parameter name	Types	Description
policyList	List<[AppPolicy](BLB/API Reference/Appendix.md#AppPolicy)>	List containing query results
marker	String	Marker indicating the starting position of the query. If the result list is empty, this field does not exist.
isTruncated	boolean	true indicates there is more data later, false indicates it is the last page
nextMarker	String	The marker value needed to fetch the next page. This field is absent when isTruncated is false.
maxKeys	int	Maximum number of items included per page

Request example

Plain Text

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

Response example

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    "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: Delete policies in batches

Delete policies under the corresponding BLB port in batches

Request structure

Plain Text

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}

Request headers

No special headers beyond common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
blbId	String	Yes	URL parameter	LoadBalancer identifier
action	String	Yes	Query	It must be batchdelete.
clientToken	String	Yes	Query	Idempotency Token
port	int	Yes	RequestBody	Frontend port of the policy to be deleted
policyIdList	List\	Yes	RequestBody	All identifiers of policies to be deleted form an array
type	String	No	RequestBody	When multiple protocols exist under a listener port, type is required.

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](BLB/API Reference/Error code.md)

Response headers

No special headers beyond common headers.

Response parameters

None

Request example

Plain Text

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}

Response example

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

Application IPv6 BLB Instance Related Interfaces

Application IPv6 BLB Security Group Related Interfaces

BLB BLB

BLB BLB

Application IPv6 BLB Listener Related Interfaces

CreateAppTCPListener: Create TCP listener

CreateAppUDPListener: Creates UDP listener

CreateAppHTTPListener: Create HTTP listener

CreateAppHTTPSListener: Create HTTPS listener

CreateAppSSLListener: Create SSL listener

UpdateAppTCPListener: Update TCP listener

UpdateAppUDPListener: Update UDP listener

UpdateAppHTTPListener: Update HTTP listener

UpdateAppHTTPSListener: Update HTTPS listener

UpdateAppSSLListener: Update SSL listener

DescribeAppTCPListeners: Query application TCP listeners

DescribeAppUDPListeners: Query UDP listeners

DescribeAppHTTPListeners: Query HTTP listeners

DescribeAppHTTPSListeners: Query HTTPS listeners

DescribeAppSSLListeners: Query application SSL listeners

DescribeAppAllListeners: Query all listeners

DeleteAppListeners: Delete listener

CreatePolicys: Create policies

DescribePolicys: Query policy information under the corresponding BLB port

DeletePolicys: Delete policies in batches