UpdateLoadBalancer

URLs

PUT zstack/v1/load-balancers/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateLoadBalancer": {
    "name": "Test-Lb",
    "description": "info"
  },
  "systemTags": [],
  "userTags": []
}

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateLoadBalancer":{"name":"Test-Lb","description":"info"}}' \
http://localhost:8080/zstack/v1/load-balancers/a355359f46d13e5ab64d6eeff66aedbf/actions

Request Parameters

Name	Type	Location	Description	Optional Value	Starting Version
uuid	String	url	The resource UUID.		0.6
name	String	body (contained in the updateLoadBalancer structure)	Optional. The resource name.		0.6
description	String	body (contained in the updateLoadBalancer structure)	Optional. The detailed description of the resource.		0.6
resourceUuid	String	body (contained in the updateLoadBalancer structure)	Optional.		0.6
systemTags	List	body	Optional. The system tags.		0.6
userTags	List	body	Optional. The user tags.		0.6

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

{
    "error": {
        "code": "SYS.1001",
        "description": "A message or a operation timeout",
        "details": "Create VM on KVM timeout after 300s"
    }
}

Java SDK

UpdateLoadBalancerAction action = new UpdateLoadBalancerAction();
action.uuid = "a355359f46d13e5ab64d6eeff66aedbf";
action.name = "Test-Lb";
action.description = "info";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateLoadBalancerAction.Result res = action.call();

Python SDK

UpdateLoadBalancerAction action = UpdateLoadBalancerAction()
action.uuid = "a355359f46d13e5ab64d6eeff66aedbf"
action.name = "Test-Lb"
action.description = "info"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateLoadBalancerAction.Result res = action.call()