Scale Load Balancer

Scale Load Balancer

Second day scale operation for load balancer

Request
URI
POST
https://vra-interop-222-139.lvn.broadcom.net/iaas/api/load-balancers/{id}/operations/scale
COPY
Path Parameters
string
id
Required

The ID of the load balancer.

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about


Request Body

LoadBalancer Specification instance

LoadBalancerSpecification of type(s) application/json
Required

Show optional properties

{
    "name": "string",
    "projectId": "e058",
    "routes": [
        {
            "protocol": "TCP, UDP",
            "port": "80",
            "memberProtocol": "TCP, UDP",
            "memberPort": "80"
        }
    ],
    "nics": [
        {}
    ]
}
{
    "name": "string",
    "projectId": "e058",
    "deploymentId": "123e4567-e89b-12d3-a456-426655440000",
    "customProperties": {
        "customProperties": "string"
    },
    "description": "string",
    "routes": [
        {
            "protocol": "TCP, UDP",
            "port": "80",
            "memberProtocol": "TCP, UDP",
            "memberPort": "80",
            "algorithm": "ROUND_ROBIN",
            "algorithmParameters": "uriLength=10\nurlParam=section",
            "healthCheckConfiguration": {
                "protocol": "HTTP, HTTPS",
                "port": "80",
                "urlPath": "/index.html",
                "intervalSeconds": 60,
                "timeoutSeconds": 5,
                "unhealthyThreshold": 5,
                "healthyThreshold": 2,
                "httpMethod": "GET, OPTIONS, POST, HEAD, PUT",
                "requestBody": "http_request.body",
                "responseBody": "http_response.body",
                "passiveMonitor": false
            }
        }
    ],
    "nics": [
        {
            "name": "string",
            "description": "string",
            "deviceIndex": 1,
            "networkId": "54097407-4532-460c-94a8-8f9e18f4c925",
            "fabricNetworkId": "54097407-4532-460c-94a8-8f9e18f4c925",
            "addresses": [
                "10.1.2.190"
            ],
            "macAddress": "[\"00:50:56:99:d8:34\"]",
            "securityGroupIds": [
                "string"
            ],
            "customProperties": {
                "awaitIp": "true"
            }
        }
    ],
    "targetLinks": [
        "/iaas/machines/eac3d"
    ],
    "tags": [
        {
            "key": "ownedBy",
            "value": "Rainpole"
        }
    ],
    "internetFacing": false,
    "type": "SMALL, MEDIUM, LARGE",
    "loggingLevel": "ERROR, WARNING, INFO, DEBUG"
}
string
name
Required

A human-friendly name used as an identifier in APIs that support this option.

string
projectId
Required

The id of the project the current user belongs to.

string
deploymentId
Optional

The id of the deployment that is associated with this resource

object
customProperties
Optional

Additional custom properties that may be used to extend this resource.

string
description
Optional

A human-friendly description.

array of object
routes
Required

The load balancer route configuration regarding ports and protocols.

array of object
nics
Required

A set of network interface specifications for this load balancer.

array of string
targetLinks
Optional

A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.

array of object
tags
Optional

A set of tag keys and optional values that should be set on any resource that is produced from this specification.

boolean
internetFacing
Optional

An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.

string
type
Optional

Define the type/variant of load balancer numbers e.g.for NSX the number virtual servers and pool members load balancer can host

string
loggingLevel
Optional

Defines logging level for collecting load balancer traffic logs.

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns RequestTracker of type(s) application/json
"RequestTracker Object"
integer As int32 As int32
progress
Required

Progress of the request as percentage.

string
message
Optional

Status message of the request.

string
status
Required

Status of the request.

Possible values are : FINISHED, INPROGRESS, FAILED,
array of string
resources
Optional

Collection of resources.

string
name
Optional

Name of the operation.

string
id
Required

ID of this request.

string
selfLink
Required

Self link of this request.

string
deploymentId
Optional

ID of the deployment, this request is connected to.


403

Forbidden

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


404

Not found

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","nics":["object"],"projectId:"string","routes":["object"]}' https://{api_host}/iaas/api/load-balancers/{id}/operations/scale