Call the DeleteServerGroup API to delete a server group - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Operation description

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

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

nlb:DeleteServerGroup

delete

*ServerGroup

acs:nlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
ServerGroupId	string	Yes	The server group ID.	sgp-atstuj3rtoptyui****
DryRun	boolean	No	Whether to perform a dry run. Valid values: true: checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits, without performing the operation. If the check fails, the corresponding error message is returned. If the check passes, the `DryRunOperation` error code is returned. false (default): sends the request. If the request passes validation, a 2xx HTTP status code is returned and the operation is performed.	false
ClientToken	string	No	The client token that ensures the idempotence of the request. You can use the client to generate the token. The token must be unique among different requests and can contain only ASCII characters. Note If you do not set this parameter, the value of RequestId is used.** The value of RequestId** is different for each request.	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 elements

Element	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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.