Creates a server group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateServerGroup

The operation that you want to perform. Set the value to CreateServerGroup.

ServerGroupName String Yes sg-atstuj3rtoptyui****

The name of the server group. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.

ServerGroupType String No Instance

The type of the server group. Valid values:

  • Instance: a server group that consists of servers. You can add Elastic Compute Service (ECS) instances, elastic network interfaces (ENIs), and elastic container instances to this type of server group. This is the default value.
  • Ip: a server group that consists of IP addresses. You can add IP addresses to this type of server group.
VpcId String No vpc-bp15zckdt37pq72zv****

The ID of the virtual private cloud (VPC). You can add only servers that are deployed in the specified VPC to the server group.

Note This parameter is required if the ServerGroupType parameter is set to Instance or Ip.
Scheduler String No Wrr

The scheduling algorithm. Valid values:

  • Wrr: Backend servers that have higher weights receive more requests than those that have lower weights. This is the default value.
  • Wlc: Requests are distributed based on the weight and load of each backend server. The load refers to the number of connections to a backend server. If multiple backend servers have the same weight, requests are routed to the backend server with the least connections.
  • Sch: specifies consistent hashing that is based on source IP addresses.
Protocol String No HTTP

The server protocol. Valid values:

  • HTTP: allows you to associate HTTPS, HTTP, or QUIC listeners with backend servers. This is the default value.
  • HTTPS: allows you to associate HTTPS listeners with backend servers.
ResourceGroupId String No rg-atstuj3rtop****

The ID of the resource group.

HealthCheckConfig Object Yes

The configuration of health checks.

HealthCheckConnectPort Integer No 80

The backend port that is used for health checks.

Valid values: 0 to 65535.

Default value: 0. This value indicates that the port on a backend server is used for health checks.

HealthCheckEnabled Boolean Yes true

Specifies whether to enable the health check feature. Valid values:

  • true: enables the feature.
  • false: disables the feature.
HealthCheckHost String No www.test.com

The domain name that is used for health checks. The domain name must meet the following requirements:

  • The domain name must be 1 to 80 characters in length.
  • The domain name can contain lowercase letters, digits, hyphens (-), and periods (.).
  • The domain name must contain at least one period (.),and cannot start or end with a period (.).
  • The rightmost field can contain only letters, and cannot contain digits or hyphens (-).
  • Other fields cannot start or end with a hyphen (-).
Note This parameter is required only if the HealthCheckProtocol parameter is set to HTTP.
HealthCheckCodes Array of String No 200

The HTTP status code that indicates a successful health check. Multiple HTTP status codes can be specified as a list.

Note This parameter is required only if the HealthCheckProtocol parameter is set to HTTP.

Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. Default value: http_2xx.

HealthCheckHttpVersion String No HTTP1.0

The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1.

Note This parameter is required only if the HealthCheckProtocol parameter is set to HTTP.
HealthCheckInterval Integer No 5

The time interval between two consecutive health checks. Unit: seconds.

Valid values: 1 to 50.

Default value: 2.

HealthCheckMethod String No HEAD

The HTTP method that is used for health checks. Valid values: GET and HEAD. Default value: HEAD.

Note This parameter is required only if the HealthCheckProtocol parameter is set to HTTP.
HealthCheckPath String No /test/index.html

The URL that is used for health checks.

The URL must be 1 to 80 characters in length, and can contain letters, digits, and the following special characters:

- / .% ?# & =.

It can also contain the following extended characters:

_ ; ~ ! ( )* [ ] @ $ ^ : ' , +.

The URL must start with a forward slash (/).

Note This parameter is required only if the HealthCheckProtocol parameter is set to HTTP.
HealthCheckProtocol String No HTTP

The protocol that is used for health checks. Valid values: HTTP and HTTPS.

HealthCheckTimeout Integer No 3

The timeout period of a health check. If a backend server does not respond within the specified timeout period, the backend server fails the health check. Unit: seconds.

Valid values: 1 to 300.

Default value: 5.

Note If the value of the HealthCheckTimeout parameter is smaller than that of the HealthCheckInterval parameter, the timeout period specified by the HealthCheckTimeout parameter is ignored and the period of time specified by the HealthCheckInterval parameter is used as the timeout period.
HealthyThreshold Integer No 4

The number of health checks that an unhealthy backend server must consecutively pass before it is declared healthy. In this case, the health status is changed from fail to success.

Valid values: 2 to 10.

Default value: 3.

UnhealthyThreshold Integer No 4

The number of health checks that a healthy backend server must consecutively fail before it is declared unhealthy. In this case, the health status is changed from success to fail.

Valid values: 2 to 10.

Default value: 3.

StickySessionConfig Object No

The configuration of session persistence.

Note This parameter is required if the ServerGroupType parameter is set to Instance or Ip.
Cookie String No B490B5EBF6F3CD402E515D22BCDA****

The cookie to be configured on the backend server.

The cookie must be 1 to 200 characters in length, and can contain ASCII characters and digits. It cannot contain commas (,), semicolons (;), or spaces. It cannot start with a dollar sign ($).

Note This parameter is required if the StickySessionEnabled parameter is set to true and the StickySessionType parameter is set to Server.
CookieTimeout Integer No 1000

The timeout period of the cookie. Unit: seconds.

Valid values: 1 to 86400.

Default value: 1000.

Note This parameter is required if the StickySessionEnabled parameter is set to true and the StickySessionType parameter is set to Insert.
StickySessionEnabled Boolean No true

Specifies whether to enable session persistence. Valid values: true and false.

Note This parameter is required if the ServerGroupType parameter is set to Instance or Ip.
StickySessionType String No Insert

The method that is used to handle a cookie. Valid values:

  • Insert : inserts a cookie. This is the default value.

    Application Load Balancer (ALB) inserts the server ID as a cookie into the first HTTP or HTTPS response that is sent to a client. The next request from the client will contain this cookie, and the listener will distribute this request to the recorded backend server.

  • Server: rewrites a cookie.

    When ALB detects a user-defined cookie, it uses the user-defined cookie to rewrite the original cookie. The next request from the client will contain the user-defined cookie, and the listener will distribute this request to the recorded backend server.

Note This parameter is required if the StickySessionEnabled parameter is set to true.
ClientToken String No 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

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 make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The ID of each request is unique.
DryRun Boolean No true

Specifies whether only to precheck the request. Valid values:

  • true: only prechecks the request and does not perform the requested operation. The system checks the required parameters, request format, and service limits. If the request fails the precheck, an error code is returned based on the cause of the failure. If the request passes the precheck, the DryRunOperation error code is returned.
  • false: prechecks the request and performs the requested operation. After the request passes the precheck, an HTTP 2xx status code is returned and the system performs the operation. This is the default value.

Response parameters

Parameter Type Example Description
JobId String 72dcd26b-f12d-4c27-b3af-18f6aed5****

The ID of the asynchronous task.

RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

The ID of the request.

ServerGroupId String sg-atstuj3rtoptyui****

The ID of the server group.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateServerGroup
&ServerGroupName=sg-atstuj3rtoptyui****
&ServerGroupType=Instance
&VpcId=vpc-bp15zckdt37pq72zv****
&Scheduler=Wrr
&Protocol=HTTP
&ResourceGroupId=rg-atstuj3rtop****
&HealthCheckConfig={"HealthCheckConnectPort":80,"HealthCheckEnabled":true,"HealthCheckHost":"www.test.com","HealthCheckCodes":["200"],"HealthCheckHttpVersion":"HTTP1.0","HealthCheckInterval":5,"HealthCheckMethod":"HEAD","HealthCheckPath":"/test/index.html","HealthCheckProtocol":"HTTP","HealthCheckTimeout":3,"HealthyThreshold":4,"UnhealthyThreshold":4}
&StickySessionConfig={"Cookie":"B490B5EBF6F3CD402E515D22BCDA****","CookieTimeout":1000,"StickySessionEnabled":true,"StickySessionType":"Insert"}
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&DryRun=true
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateServerGroupResponse>
    <JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    <ServerGroupId>sg-atstuj3rtoptyui****</ServerGroupId>
</CreateServerGroupResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "JobId" : "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "ServerGroupId" : "sg-atstuj3rtoptyui****"
}

Error codes

HTTP status code Error code Error message Description
400 QuotaExceeded.ServerGroupsNum The quota of %s is exceeded, usage %s/%s. The error message returned because the usage %s has exceeded the quota %s.

For a list of error codes, visit the API Error Center.