Edit a load balancer

PUT /accounts/{accountId}/loadbalancers/{lbId}

This operation will update name and/or algorithm of the specified load balancer.

Request

URI Parameters

accountId - string

The selected account Id.

lbId - string

The unique identifier of the firewall group.

Request Body

{ 
       "displayName" : "{lbDisplayName}",
       "algorithm" : "{lbAlgorithm}",
       "timeout": {lbTimeout},
       "protocol": "{lbProtocol}"
    }
 }

Parameters

displayName - string

optional, new name for this load balancer (must be unique)

algorithm - string

optional, the new load balancing algorithm to use. ROUND_ROBIN or SOURCE_IP

timeout - integer

optional, timeout seconds

protocol - string

optional, HTTP or TCP

Response

Response Codes

204 No Content

401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

404 Not Found

The resource does not exist.

Examples

Successfully edit details for specified load balancer

Request

PUT /accounts/{accountId}/loadbalancers/0001
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

{
    "displayName": "New display name", 
    "algorithm": "SOURCE_IP"
}

Response

HTTP/1.1 204 OK

Failure while trying to edit a load balancer that does not exist

Request

PUT /accounts/{accountId}/loadbalancers/{fake_loadBalancerId}
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

Response

HTTP/1.1 404 Not Found

blog comments powered by Disqus