Update Load Balancer Pool

Updates a specific Load Balancer Pool.

Request

URI

PUT

https://{api_host}/cloudapi/1.0.0/loadBalancer/pools/{poolId}

COPY

Path Parameters

string

poolId

Required

poolId

string

poolId

Required

poolId

Request Body

EdgeLoadBalancerPool of type(s) application/json

Optional

This request body class requires all of the following: EdgeLoadBalancerPoolCommonProperties , InlineEdgeLoadBalancerPool1

{
    "status": {},
    "id": "string",
    "description": "string",
    "enabled": false,
    "passiveMonitoringEnabled": false,
    "healthStatus": "string",
    "memberCount": 0,
    "enabledMemberCount": 0,
    "upMemberCount": 0,
    "healthMessage": "string",
    "name": "string",
    "defaultPort": 0,
    "portTranslationEnabled": false,
    "gracefulTimeoutPeriod": 0,
    "algorithm": "string",
    "healthMonitors": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "type": "string",
            "systemDefined": false,
            "successfulChecksCount": 0,
            "failedChecksCount": 0,
            "sendInterval": 0,
            "receiveTimeout": 0,
            "httpSettings": {
                "port": 0,
                "requestHeader": "string",
                "requestBody": "string",
                "useExactRequest": false,
                "expectedResponseData": "string",
                "expectedResponseCodes": [
                    "string"
                ],
                "authSettings": {
                    "type": "string",
                    "username": "string",
                    "password": "string"
                }
            },
            "httpsSettings": {
                "port": 0,
                "requestHeader": "string",
                "requestBody": "string",
                "useExactRequest": false,
                "expectedResponseData": "string",
                "expectedResponseCodes": [
                    "string"
                ],
                "authSettings": {
                    "type": "string",
                    "username": "string",
                    "password": "string"
                }
            },
            "tcpSettings": {
                "port": 0,
                "requestData": "string",
                "expectedResponseData": "string"
            },
            "udpSettings": {
                "port": 0,
                "requestData": "string",
                "expectedResponseData": "string"
            },
            "gatewayRef": {
                "name": "string",
                "id": "string"
            }
        }
    ],
    "persistenceProfile": {
        "name": "string",
        "type": "string",
        "value": "string"
    },
    "members": [
        {
            "ipAddress": "string",
            "port": 0,
            "ratio": 0,
            "enabled": false,
            "healthStatus": "string",
            "markedDownBy": [
                "string"
            ],
            "detailedHealthMessage": "string"
        }
    ],
    "memberGroupRef": {
        "name": "string",
        "id": "string"
    },
    "virtualServiceRefs": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "gatewayRef": {
        "name": "string",
        "id": "string"
    },
    "caCertificateRefs": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "commonNameCheckEnabled": false,
    "domainNames": [
        "*.example.com",
        "www.vmware.com"
    ],
    "sslEnabled": false
}

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

Availability

Added in 35.0

On This Page

Description

Request