Get Load Balancer Pool
Retrieves a specific Load Balancer Pool.
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/loadBalancer/pools/{poolId}
COPY
Path Parameters
string
poolId
Required
poolId
string
poolId
Required
poolId
Responses
200
OK
Returns EdgeLoadBalancerPool of type(s) application/json;version=39.0
This response body class contains 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
}
Availability
Added in 35.0
Edge Gateway Load Balancer Pool Operations
DELETE
Delete Load Balancer Pool
GET
Get Load Balancer Pool
PUT
Update Load Balancer Pool