ModifyBackend

1. API Description

This API is used to modify the configurations of one or more backend servers added to a specified listener, including the weight and forwarding port.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

loadBalancerId

Yes

String

Load balance instance ID.

listenerId

Yes

String

The listener ID of the load balancer.

backendServers

Yes

Array of BackendServer

List of backend servers to be modified.

3. Output Parameters

Parameter Name
Type
Description

requestId

String

The unique request ID, which is returned for each request. RequestId is required to locate a problem.

4. Code Example

Modify the weight and port of the backend server added to a listener.

POST /api/v2/zlb HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyBackend
<Common Request Params>

Request:
{
  "loadBalancerId" : "<loadBalancerId>",
  "listenerId" : "<listenerId>",
  "backendServers" : [
    {
      "instanceId" : "<backendServerId>",
      "privateIpAddress": "10.0.0.1",
      "weight": "50",
      "port": 10
    }
  ]
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code
Error code
Description

400

INVALID_BACKEND_SERVER_PORT

Invalid listening port.

404

INVALID_LB_LISTENER_NOT_FOUND

When a listener listens on multiple ports, the backend port must match and cannot be set manually.

Last updated