Edit a node pool

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

This operation updates name and/or algorithm of the specified node pool

Request

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

Request Parameters

accountId - string

The selected account id.

lbId - string

The selected loadbalancer id.

nodePoolId - string

The selected node pool id.

Request Body

partial update is supported

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

Parameters

displayName - string

Optional, The display name of the node pool.

port - integer

Optional, The tcp port the load balancer will act on

Allowed range is 1 ~ 65535

algorithm - string

Optional, Load balancing algorithm to be used

Allowed values are ROUND_ROBIN or SOURCE_IP

timeout - integer

Optional, Load balancer timeout (ex, check, connect timeouts)

protocol - string

Optional, The protocol to be balanced by this load balancer

Allowed values are TCP or HTTP. (Note: HTTPS is not supported)

Response

Response Codes

204 No Content

400 Bad Request

The request has wrong data

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 partial details of the specified node pool

Request

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

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

Response

HTTP/1.1 204 OK

blog comments powered by Disqus