Delete a GWLB Instance Safely with API & DryRun Validation - GWLB - Alibaba Cloud - Server Load Balancer

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

gwlb:DeleteLoadBalancer

delete

*LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

None

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The ID of the gateway load balancing instance.	gwlb-9njtjmqt7zfcqm****
DryRun	boolean	No	Specifies whether to only precheck the request. Valid values: true: sends a check request and does not delete the instance. Check items include whether required parameters are specified, the request format, and service limits. If the check fails, the corresponding error is returned. If the check succeeds, the `DryRunOperation` error code is returned. false (default): sends a normal request. If the check succeeds, an HTTP 2xx 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 generate a parameter value from your client to ensure that the value is unique among different requests. The ClientToken parameter supports only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is unique.	123e4567-e89b-12d3-a456-42665544****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	37907828-01AB-5AC3-9DDE-25D419091D54

Examples

Success response

JSON format

{
  "RequestId": "37907828-01AB-5AC3-9DDE-25D419091D54"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	Resource %s with business state %s does not support current operation
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.	Resource %s current state %s does not support operation
400	MissingParam.LoadBalancerId	The param of LoadBalancerId is missing.	Load balancing ID parameter missing
400	ResourceAlreadyAssociated.GwlbeAssociated	The specified resource of %s is already associated.	The specified resource %s is already associated
400	ResourceNotFound.LoadBalancer	The specified resource of %s is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.