Delete an Application Load Balancer instance with DeleteLoadBalancer - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Operation description

DeleteLoadBalancer is an asynchronous operation. The system returns a request ID, but the ALB instance is not deleted immediately. The deletion task continues in the background. Call GetLoadBalancerAttribute to invoke the query for the deletion status of the ALB instance:

If the ALB instance is in the Deleting state, the instance is being deleted.
If the specified ALB instance cannot be found, the instance is deleted.

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

alb:DeleteLoadBalancer

delete

*LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

None

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The ID of the ALB instance.	alb-o9ulmq5hgn68jk****
ClientToken	string	No	The client token used to ensure the idempotency of the request. Generate a unique token for each request. ClientToken supports ASCII characters only.	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Sends a dry run request without deleting the ALB instance. The system checks whether the required parameters are specified, the request format is valid, and the business limits are met. If the check fails, the corresponding error is returned. If the check passes, the error code `DryRunOperation` is returned. false (default): Sends a normal request. If the check passes, the system returns an `HTTP 2xx` status code and performs the operation.	true
RetainResourceType	array	No	The types of resources that are automatically created and attached by ALB and need to be retained. When you release a public-facing ALB instance, you can set this parameter to eip to retain the EIP that ALB automatically created and attached. Anycast EIPs cannot be retained. EIPs that you manually attached are automatically retained.
	string	No	The type of resource to retain. Set this parameter to eip to retain the elastic IP address (EIP).	eip

Response elements

Element	Type	Description	Example
	object	The response for the delete load balancing instance operation.
JobId	string	The ID of the asynchronous task.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Examples

Success response

JSON format

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.	The current status of the instance does not support this operation.
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	The business status of %s [%s] is incorrect.
400	OperationDenied.DeletionProtectionEnabled	The operation is not allowed because of %s.	The operation is not allowed because of %s.
403	Forbidden.LoadBalancer	Authentication has failed for LoadBalancer.	Authorization failed.
404	ResourceNotFound.LoadBalancer	The specified resource %s is not found.	The specified resource %s is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.