Remove backend servers from an Edge Load Balancer by using RemoveBackendServers - ENS

Operation description

Rate limit: 100 requests per second.
up to 10 times per second per account.

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

ens:RemoveBackendServers

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The ID of the Edge Load Balancer (ELB) instance.	lb-5ovkn1piwqmoqrfjdyhq4****
BackendServers	array<object>	Yes	The list of backend servers that you want to remove. You can remove up to 20 backend servers at a time.
	object	No	The list of backend servers that you want to remove. You can remove up to 20 backend servers at a time.
ServerId	string	Yes	The instance ID of the backend server.	i-5uf68ts0fqexe1a4n****
Weight	integer	No	The weight of the backend server.	100
Type	string	No	The type of backend server. Valid values: ens: an Edge Node Service (ENS) instance. eni: an Elastic Network Interface (ENI).	ens
Ip	string	No	The IP address of the backend server.	192.168.0.1
Port	integer	No	The backend port that is used by the Edge Load Balancer (ELB) instance.	0

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
BackendServers	object
BackendServer	array<object>	The list of backend servers that you want to add to the SLB instance.
	object
ServerId	string	The instance ID of the backend server.	i-5vb5h5njxiuhn48a****
Weight	integer	The weight of the backend server. Note The value 0 indicates that requests are not forwarded to the backend server.	50
Type	string	The type of the backend server. Valid values: ens: an ENS instance. eni: an ENI.	ens
Ip	string	The IP address of the backend server.	192.168.0.1
Port	integer	The backend port that is used by the ELB instance.	0

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "BackendServers": {
    "BackendServer": [
      {
        "ServerId": "i-5vb5h5njxiuhn48a****",
        "Weight": 50,
        "Type": "ens",
        "Ip": "192.168.0.1",
        "Port": 0
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ens.interface.error	An error occurred while call the API.
400	LoadBalancerNotFound	The input parameter LoadBalancerId that is not found.	The load balancing instance does not exist.
400	IncorrectInstanceStatus	The current status of the resource does not support this operation.	The current operation is not supported. The disk is being reset.
400	Missing%s	You must specify the parameter %s.
400	Invalid%s	The specified parameter %s is invalid.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.