Idempotency Token, with length no more than 64 characters.
name
String
No
RequestBody
Name of server group for easy memorization. Length: 1 – 65 bytes, starting with a letter. It can contain letters, numbers and the characters -_/. If this parameter is not specified, it will be generated automatically.
desc
String
No
RequestBody
Server group description, allowing users to include more details. The length can range from 0–450 bytes, and Chinese is supported. By default, it is left empty.
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
id
String
Server group ID
name
String
Server group name
desc
String
Server group description
status
String
Server group status. See details in [blbStatus](BLB/API Reference/Appendix.md#blbStatus).
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.
Idempotency Token, with length no more than 64 characters.
sgId
String
Yes
RequestBody
ID of the server group to be updated
name
String
No
RequestBody
Name of server group for easy memorization. Length: 1 – 65 bytes, starting with a letter. It can contain letters, numbers and the characters -_/. If this parameter is not specified, it will be generated automatically.
desc
String
No
RequestBody
Server group description, allowing users to include more details. The length can range from 0–450 bytes, and Chinese is supported. By default, it is left empty.
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)
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)
Idempotency Token, with length no more than 64 characters.
sgId
String
Yes
RequestBody
ID of the server group to be deleted
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)
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
CreateAppServerGroupPort: Create application server group port
Under the specified application BLB, create a backend port for the server group, which distributes all traffic to this port through weighted round-robin to the servers in its bound server list.
Idempotency Token, with length no more than 64 characters.
sgId
String
Yes
RequestBody
Server group identifier of the port
port
int
Yes
RequestBody
Port No., which shall be an integer between 1 and 65535.
type
String
Yes
RequestBody
Protocol type of listener port, "TCP"/"UDP"/"HTTP"
enableHealthCheck
Boolean
No
RequestBody
Whether to enable health check. It is true by default.
healthCheck
String
No
RequestBody
Health check protocol, supporting "HTTP"/"TCP"/"UDP"/"ICMP". It is TCP for TCP, UDP for UDP, and HTTP for HTTP by default.
healthCheckPort
int
No
RequestBody
Health check port. The allowed range is 1-65535, it is the port value by default, and is valid when the health check protocol is "HTTP".
healthCheckUrlPath
String
No
RequestBody
Health check URI. It is / by default. It is valid when the health check protocol is "HTTP".
healthCheckTimeoutInSecond
int
No
RequestBody
Health check timeout duration (unit: second). It is 3 by default, and shall be an integer between 1 and 60.
healthCheckIntervalInSecond
int
No
RequestBody
Health check interval (unit: second). It is 3 by default, and shall be an integer between 1 and 10.
healthCheckDownRetry
int
No
RequestBody
Unhealthy threshold represents the number of consecutive health check failures required to block the real server. Default is 3, and it must be an integer between 2 and 5.
healthCheckUpRetry
int
No
RequestBody
Healthy threshold represents the number of consecutive successful health checks required to set the real server as available. Default is 3, and it must be an integer between 2 and 5.
healthCheckNormalStatus
String
No
RequestBody
HTTP status codes for successful health checks, supporting combinations of 5 types of status codes such as "http_1xx|http_2xx". It is "http_2xx|http_3xx" by default. It is valid when the health check protocol is "HTTP".
healthCheckHost
String
No
RequestBody
The header field of the Layer 7 health check request will include the specified host field, such as "localhost", and the default is "". It is valid when the health check protocol is "HTTP".
udpHealthCheckString
String
No
RequestBody
Health check fields for UDP server. When the health check protocol is "UDP", it must be loaded.
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
id
String
Server group port ID
status
String
Server group port status. See details in [blbStatus](BLB/API Reference/Appendix.md#blbStatus).
Idempotency Token, with length no more than 64 characters.
sgId
String
Yes
RequestBody
Server group identifier of the port
portId
String
Yes
RequestBody
Port identifier of real server group to be updated
enableHealthCheck
Boolean
No
RequestBody
Whether to enable health check. It is true by default.
healthCheck
String
No
RequestBody
Health check protocol, supporting "HTTP"/"TCP"/"UDP"/"ICMP". It is TCP for TCP, UDP for UDP, and HTTP for HTTP by default.
healthCheckPort
int
No
RequestBody
Health check port. It is the port value by default, and is valid when the health check protocol is "HTTP".
healthCheckUrlPath
String
No
RequestBody
Health check URI. It is / by default. It is valid when the health check protocol is "HTTP".
healthCheckTimeoutInSecond
int
No
RequestBody
Health check timeout duration (unit: second). It is 3 by default, and shall be an integer between 1 and 60.
healthCheckIntervalInSecond
int
No
RequestBody
Health check interval (unit: second). It is 3 by default, and shall be an integer between 1 and 10.
healthCheckDownRetry
int
No
RequestBody
Unhealthy threshold represents the number of consecutive health check failures required to block the real server. Default is 3, and it must be an integer between 2 and 5.
healthCheckUpRetry
int
No
RequestBody
Healthy threshold represents the number of consecutive successful health checks required to set the real server as available. Default is 3, and it must be an integer between 2 and 5.
healthCheckNormalStatus
String
No
RequestBody
HTTP status codes for successful health checks, supporting combinations of 5 types of status codes such as "http_1xx|http_2xx". It is "http_2xx|http_3xx" by default. It is valid when the health check protocol is "HTTP".
healthCheckHost
String
No
RequestBody
The header field of the Layer 7 health check request will include the specified host field, such as "localhost", and the default is "". It is valid when the health check protocol is "HTTP".
udpHealthCheckString
String
No
RequestBody
Health check fields for UDP server. When the health check protocol is "UDP", it must be loaded.
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)
Idempotency Token, with length no more than 64 characters.
sgId
String
Yes
RequestBody
ID of the server group of the port to be deleted
portIdList
List\
Yes
RequestBody
All port IDs to be deleted form an array.
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)
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 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
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)
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)
Describe the operation to be performed. It is batchdelete for this API.
clientToken
String
Yes
Query
Idempotency Token, with length no more than 64 characters.
sgId
String
Yes
RequestBody
The server group ID to which the RS to be deleted belongs
backendServerIdList
List\
Yes
RequestBody
All identifiers of real servers to be deleted form an array
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)
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)
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)
