DeleteServerGroup - Server Load Balancer - Alibaba Cloud Documentation Center

Deletes a Network Load Balancer (NLB) server group.

Operation description

You can delete server groups that are not associated with listeners.

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
nlb:DeleteServerGroup	delete	*ServerGroup `acs:nlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ServerGroupId	string	Yes	The ID of the server group.	sgp-atstuj3rtoptyui****
DryRun	boolean	No	Specifies whether to perform a dry run, without sending the actual request. Valid values: true: performs a dry run. The system checks the required parameters, request syntax, and limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	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 make sure that it is unique among different requests. The token can only contain ASCII characters. Note If you do not set this parameter, the system automatically uses the value of RequestId as the value of ClientToken. RequestId of each API request may be different.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	No	The ID of the region where the NLB instance is deployed. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	RpcResponse
RequestId	string	The ID of the request.	54B48E3D-DF70-471B-AA93-08E683A1B45
JobId	string	The ID of the asynchronous task.	72dcd26b-f12d-4c27-b3af-18f6aed5****

Examples

Sample success responses

JSONformat

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceInUse.ServerGroup	The specified resource of ServerGroup is in use.	The specified server group resource is being used. Please try again later.
400	SystemBusy	System is busy, please try again later.	-
400	IncorrectStatus.serverGroup	The status of servergroup [%s] is incorrect.	The current operation cannot be performed on the server group as its status is unavailable. Please check if the server group is currently undergoing any other operations.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	Request validation has been passed with DryRun flag set.
400	Conflict.Lock	The Lock [%s] is conflict.	The specific resource is conflict.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	Authentication is failed for NoPermission.
404	ResourceNotFound.serverGroup	The specified resource of serverGroup is not found.	The specified resource of serverGroup is not found. Please check the input parameters.

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

Change history

Change time	Summary of changes	Operation
2024-01-24	The Error code has changed	View Change Details
2023-12-18	The Error code has changed	View Change Details
2023-09-05	The Error code has changed	View Change Details
2023-08-22	The Error code has changed	View Change Details