All Products
Search
Document Center

Server Load Balancer:UpdateServerGroupAttribute

更新時間:Nov 11, 2024

Updates the attributes of a server group.

Operation description

UpdateServerGroupAttribute is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the ListServerGroups operation to query the status of the task.

  • If the server group is in the Configuring state, the configuration of the server group is being modified.
  • If the server group is in the Available state, the configuration of the server group is modified.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
gwlb:UpdateServerGroupAttributeupdate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ServerGroupIdstringYes

The server group ID.

sgp-atstuj3rtoptyui****
ServerGroupNamestringNo

The server group name.

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

testServerGroupName
SchedulerstringNo

The scheduling algorithm. Valid values:

  • 5TCH: specifies consistent hashing that is based on the following factors: source IP address, destination IP address, source port, protocol, and destination port. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 3TCH: specifies consistent hashing that is based on the following factors: source IP address, destination IP address, and protocol. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 2TCH: specifies consistent hashing that is based on the following factors: source IP address and destination IP address. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
5TCH
ConnectionDrainConfigobjectNo

The configurations of connection draining.

ConnectionDrainEnabledbooleanNo

Specifies whether to enable connection draining. Valid values:

  • true
  • false
false
ConnectionDrainTimeoutintegerNo

The timeout period of connection draining.

Unit: seconds

Valid values: 1 to 3600.

300
HealthCheckConfigobjectNo

The configurations of the health check feature.

HealthCheckConnectPortintegerNo

The backend server port that is used by health checks.

Valid values: 1 to 65535.

80
HealthCheckConnectTimeoutintegerNo

The maximum timeout period of a health check response.

Unit: seconds

Valid values: 1 to 300.

5
HealthCheckDomainstringNo

The domain name that is used for health checks. Valid values:

  • $SERVER_IP: the internal IP address of a backend server.
  • domain: a domain name. The domain name must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), and periods (.).
Note This parameter takes effect only if you set HealthCheckProtocol to HTTP.
$SERVER_IP
HealthCheckEnabledbooleanNo

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

  • true
  • false
true
HealthCheckHttpCodearrayNo

The HTTP status codes that the system returns for health checks.

HealthCheckHttpCodestringNo

The HTTP status code to return for health checks. Separate multiple HTTP status codes with commas (,). Valid values:

  • http_2xx: HTTP 2xx status codes.
  • http_3xx: HTTP 3xx status codes.
  • http_4xx: HTTP 4xx status codes.
  • http_5xx: HTTP 5xx status codes.

Default value: http_2xx.

Note This parameter takes effect only if you set HealthCheckProtocol to HTTP.
http_2xx
HealthCheckIntervalintegerNo

The interval at which health checks are performed.

Unit: seconds

Valid values: 1 to 50.

10
HealthCheckPathstringNo

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: - / . % ? # & The URL must start with a forward slash (/).

Note This parameter takes effect only if you set HealthCheckProtocol to HTTP.
/test/index.html
HealthCheckProtocolstringNo

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

  • TCP: TCP health checks send TCP SYN packets to a backend server to check whether the port of the backend server is reachable.
  • HTTP: HTTP health checks simulate a process that uses a web browser to access resources by sending HEAD or GET requests to an instance. These requests are used to check whether the instance is healthy.
TCP
HealthyThresholdintegerNo

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

Valid values: 2 to 10.

2
UnhealthyThresholdintegerNo

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

Valid values: 2 to 10.

2
DryRunbooleanNo

Specifies whether to perform only a dry run without performing the actual request. Valid values:

  • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
false
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token 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 request ID as the client token. The request ID may be different for each request.
123e4567-e89b-12d3-a456-42665544****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

54B48E3D-DF70-471B-AA93-08E683A1B45

Examples

Sample success responses

JSONformat

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45\n"
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalParam.HealthCheckProtocolThe param of %s is illegal.The health check protocol is invalid. Check the input parameters.
400IncorrectStatus.ServerGroupThe status of %s [%s] is incorrect.The status of %s [%s] is incorrect.
404ResourceNotFound.ServerGroupThe specified resource of %s is not found.The specified server group resource does not exist.

For a list of error codes, visit the Service error codes.