Build a GWLB Server Group Using CreateServerGroup API - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Creates a load balancing server group.

Operation description

The CreateServerGroup API operation is asynchronous. After you call this operation, the system returns a request ID, but the server group is not yet created and the creation task is still running in the background. You can call ListServerGroups to query the creation status of the server group:

If the server group is in the Creating state, the server group is being created.
If the server group is in the Available state, the server group is created.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

gwlb:CreateServerGroup

create

*ServerGroup

acs:gwlb:{#regionId}:{#accountId}:servergroup/*

*VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

None

Request parameters

Parameter	Type	Required	Description	Example
ServerGroupType	string	No	The server group type. Valid values: Instance (default): server type. This type of server group supports adding Ecs, Eni, and Eci instances. Ip: IP address type. This type of server group supports directly adding backend servers by IP address. Valid values: Instance : Server type. Ip : IP address type.	Instance
ServerGroupName	string	No	The name of the server group. The name must be 2 to 128 characters in length, and must start with a letter or Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-).	testServerGroupName
Protocol	string	No	The backend forwarding protocol. Valid values: GENEVE (default). Valid values: GENEVE : GENEVE	GENEVE
Scheduler	string	No	The scheduling algorithm. Valid values: 5TCH (default): 5-tuple hash. A consistent hash based on the 5-tuple (source IP address, destination IP address, source port, destination port, and protocol). Requests from the same flow are scheduled to the same backend server. 3TCH: 3-tuple hash. A consistent hash based on the 3-tuple (source IP address, destination IP address, and protocol). Requests from the same flow are scheduled to the same backend server. 2TCH: 2-tuple hash. A consistent hash based on the 2-tuple (source IP address and destination IP address). Requests from the same flow are scheduled to the same backend server. Valid values: 2TCH : 2-tuple hash. 5TCH : 5-tuple hash. 3TCH : 3-tuple hash.	5TCH
ServerFailoverMode	string	No	The processing method for existing traffic when a server fails. Valid values: NoRebalance (default): Do not rebalance existing traffic. Rebalance: Rebalance existing traffic. Valid values: Rebalance : Rebalance existing traffic. NoRebalance : Do not rebalance existing traffic.	NoRebalance
VpcId	string	Yes	The VPC-connected instance ID. Note If ServerGroupType is set to Instance, only servers in this VPC can be added to the server group.	vpc-bp15zckdt37pq72zv****
ResourceGroupId	string	No	The ID of the resource group.	rg-atstuj3rtop****
ConnectionDrainConfig	object	No	The connection draining configurations.
ConnectionDrainEnabled	boolean	No	Specifies whether to enable connection draining. Valid values: true: Enable connection draining. false (default): Disable connection draining.	false
ConnectionDrainTimeout	integer	No	The connection draining timeout period. Unit: seconds. Valid values: 1 to 3600. Default value: 300.	300
HealthCheckConfig	object	No	The health check configurations.
HealthCheckConnectPort	integer	No	The port of the backend server used for health checks. Valid values: 1 to 65535. Default value: 80.	80
HealthCheckConnectTimeout	integer	No	The maximum timeout period for a health check response. Unit: seconds. Valid values: 1 to 300. Default value: 5.	5
HealthCheckDomain	string	No	The domain name used for health checks. Valid values: $SERVER_IP (default): The internal IP address of the backend server. domain: A specified domain name. The domain name must be 1 to 80 characters in length, and can contain only letters, digits, hyphens (-), and periods (.). Note This parameter takes effect only when HealthCheckProtocol is set to HTTP.	$SERVER_IP
HealthCheckEnabled	boolean	No	Specifies whether to enable health checks. Valid values: true (default): Enable health checks. false: Disable health checks.	true
HealthCheckHttpCode	array	No	The list of HTTP status codes for healthy responses.
	string	No	The HTTP status codes for healthy responses. Separate multiple HTTP status codes with commas (,). Valid values: http_2xx http_3xx http_4xx http_5xx Default value: http_2xx. Note This parameter takes effect only when HealthCheckProtocol is set to HTTP. Valid values: http_4xx : An HTTP 4xx status code indicates a healthy state. http_3xx : An HTTP 3xx status code indicates a healthy state. http_5xx : An HTTP 5xx status code indicates a healthy state. http_2xx : An HTTP 2xx status code indicates a healthy state.	http_2xx
HealthCheckInterval	integer	No	The interval between two consecutive health checks. Unit: seconds. Valid values: 1 to 50. Default value: 10.	10
HealthCheckPath	string	No	The health check path. The path must be 1 to 80 characters in length, and can contain only letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), ampersands (&), and the following extended characters: _;~!()[]@$^:',+=. The path must start with a forward slash (/). Note* This parameter takes effect only when HealthCheckProtocol is set to HTTP.	/test/index.html
HealthCheckProtocol	string	No	The health check protocol. Valid values: TCP (default): The system sends SYN handshake packets to check whether the server port is alive. HTTP: The system sends GET requests to simulate browser access and check whether the server application is healthy.	TCP
HealthyThreshold	integer	No	The number of consecutive successful health checks that must occur before the health check state of a backend server is changed from fail to success. Valid values: 2 to 10. Default value: 2.	2
UnhealthyThreshold	integer	No	The number of consecutive failed health checks that must occur before the health check state of a backend server is changed from success to fail. Valid values: 2 to 10. Default value: 2.	2
HealthCheckReq	string	No
HealthCheckExp	string	No
Tag	array<object>	No	The list of tags. You can specify up to 20 tags in a single call.
	object	No	The tag.
Key	string	No	The tag key. The tag key cannot be an empty string. The tag key can be up to 128 characters in length, and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	testTagKey
Value	string	No	The tag value. The tag value can be up to 256 characters in length, and cannot contain `http://` or `https://`.	testTagValue
DryRun	boolean	No	Specifies whether to only precheck the request. Valid values: true: The system prechecks the request without creating the server group. The system checks whether required parameters are specified, the request format, and service limits. If the request fails the precheck, the system returns an error. If the request passes the precheck, the system returns the error code DryRunOperation. false (default): The system sends a normal request. If the request passes the precheck, the system returns an HTTP 2xx status code and creates the server group.	False
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is unique.	123e4567-e89b-12d3-a456-42665544****

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroupId	string	The ID of the server group.	sgp-atstuj3rtoptyui****

Examples

Success response

JSON format

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.HealthCheckProtocol	The param of %s is illegal.	The health check protocol is invalid. Check the input parameters.
400	QuotaExceeded.ServerGroupsNum	The quota of %s is exceeded for resource %s, usage %s/%s.	The quota gwlb_quota_servergroups_num has exceeded the quota limit.
400	DuplicatedParam.TagKey	The param of %s is duplicated.	The parameter of tag key is duplicated.
400	IllegalParam.TagKey	The param of %s is illegal.
404	ResourceNotFound.Vpc	The specified resource of %s is not found.	The specified virtual private cloud resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.