All Products
Search
Document Center

ENS:RemoveBackendServers

Last Updated:Jul 26, 2024

Removes backend servers.

Operation description

  • You can call this operation up to 100 times per second.
  • You can call this operation up to 10 times per second per account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
ens:RemoveBackendServers
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LoadBalancerIdstringYes

The ID of the Edge Load Balancer (ELB) instance.

lb-5ovkn1piwqmoqrfjdyhq4****
BackendServersarray<object>Yes

The list of backend servers that you want to remove. You can remove up to 20 backend servers at a time.

objectYes
ServerIdstringYes

The instance ID of the backend server.

i-5uf68ts0fqexe1a4n****
WeightintegerNo

The weight of the backend server.

100
TypestringNo

The type of the backend server. Valid values:

  • ens: an Edge Node Service (ENS) instance.
  • eni: an elastic network interface (ENI).
ens
IpstringNo

The IP address of the backend server.

192.168.0.1
PortintegerNo

The backend port that is used by the ELB instance.

0

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
BackendServersarray<object>

The list of backend servers that you want to add to the SLB instance.

object
ServerIdstring

The instance ID of the backend server.

i-5vb5h5njxiuhn48a****
Weightinteger

The weight of the backend server.

Note The value 0 indicates that requests are not forwarded to the backend server.
50
Typestring

The type of the backend server. Valid values:

  • ens: an ENS instance.
  • eni: an ENI.
ens
Ipstring

The IP address of the backend server.

192.168.0.1
Portinteger

The backend port that is used by the ELB instance.

0

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400ens.interface.errorAn error occurred while call the API.-
400LoadBalancerNotFoundThe input parameter LoadBalancerId that is not found.-
400IncorrectInstanceStatusThe current status of the resource does not support this operation.The current operation is not supported. The disk is being reset.
400Missing%sYou must specify the parameter %s.-
400Invalid%sThe specified parameter %s is invalid.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

Change history

Change timeSummary of changesOperation
2023-09-21The Error code has changedView Change Details