Get Load Balancer Pool Status

Get Load Balancer Pool Status

Returns the status of the given load balancer pool by given load balancer serives id and load balancer pool id.

Request
URI
GET
https://nsxmanager.your.domain/api/v1/loadbalancer/services/{service-id}/pools/{pool-id}/status
COPY
Path Parameters
string
service-id
Required

service-id

string
pool-id
Required

pool-id

Query Parameters
string
source
Optional

Data source type.

Possible values are : realtime, cached,
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns LbPoolStatus of type(s) application/json 
{
    "status": "string",
    "last_update_timestamp": 0,
    "pool_id": "string",
    "members": [
        {
            "status": "string",
            "failure_cause": "string",
            "last_check_time": 0,
            "ip_address": "string",
            "last_state_change_time": 0,
            "port": "string"
        }
    ]
}
string
status
Optional

UP means that all primary members are in UP status. PARTIALLY_UP means that some(not all) primary members are in UP status, the number of these active members is larger or equal to certain number(min_active_members) which is defined in LbPool. When there are no backup members which are in the UP status, the number(min_active_members) would be ignored. PRIMARY_DOWN means that less than certain(min_active_members) primary members are in UP status but backup members are in UP status, connections to this pool would be dispatched to backup members. DOWN means that all primary and backup members are DOWN. DETACHED means that the pool is not bound to any virtual server. UNKOWN means that no status reported from transport-nodes. The associated load balancer service may be working(or not working).

Possible values are : UP, PARTIALLY_UP, PRIMARY_DOWN, DOWN, DETACHED, UNKNOWN,
integer As int64 As int64
last_update_timestamp
Optional

Timestamp when the data was last updated

string
pool_id
Required

Load balancer pool identifier

array of LbPoolMemberStatus
members
Optional

Status of load balancer pool members


400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

404
Returns NotFound of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

On This Page
Services Operations
POST
Add Instance Endpoint
POST
Add Member Add Member
POST
Add Rule In Section
POST
Add Rules In Section Create Multiple
POST
Add Section
POST
Add Section With Rules Create With Rules
POST
Add Service Attachment
POST
Add Service Insertion Rule In Section
POST
Add Service Insertion Rules In Section Create Multiple
POST
Add Service Insertion Section
POST
Add Service Insertion Section With Rules Create With Rules
POST
Add Service Insertion Service
POST
Add Service Instance
POST
Check Member If Exists Check If Exists
POST
Clear Dns Forwarder Cache Clear Cache
POST
Create Dhcp Ip Pool
POST
Create Dhcp Profile
POST
Create Dhcp Server
POST
Create Dhcp Static Binding
POST
Create Dns Forwader
POST
Create Load Balancer Application Profile
POST
Create Load Balancer Client Ssl Profile
POST
Create Load Balancer Monitor
POST
Create Load Balancer Persistence Profile
POST
Create Load Balancer Pool
POST
Create Load Balancer Rule
POST
Create Load Balancer Server Ssl Profile
POST
Create Load Balancer Service
POST
Create Load Balancer Tcp Profile
POST
Create Load Balancer Virtual Server
POST
Create Load Balancer Virtual Server With Rules Create With Rules
POST
Create Metadata Proxy
DELETE
Delete Dhcp Ip Pool
DELETE
Delete Dhcp Profile
DELETE
Delete Dhcp Server
DELETE
Delete Dhcp Static Binding
DELETE
Delete Dns Forwarder
DELETE
Delete Instance Endpoint
DELETE
Delete Load Balancer Application Profile
DELETE
Delete Load Balancer Client Ssl Profile
DELETE
Delete Load Balancer Monitor
DELETE
Delete Load Balancer Persistence Profile
DELETE
Delete Load Balancer Pool
DELETE
Delete Load Balancer Rule
DELETE
Delete Load Balancer Server Ssl Profile
DELETE
Delete Load Balancer Service
DELETE
Delete Load Balancer Tcp Profile
DELETE
Delete Load Balancer Virtual Server
DELETE
Delete Metadata Proxy
DELETE
Delete Rule
DELETE
Delete Section
DELETE
Delete Service Attachment
DELETE
Delete Service Insertion Rule
DELETE
Delete Service Insertion Section
DELETE
Delete Service Insertion Service
DELETE
Delete Service Instance
POST
Delete Service V Ms Delete
POST
Deploy Service V Ms Deploy
POST
Disable Firewall On Target Resource Disable Firewall
POST
Enable Firewall On Target Resource Enable Firewall
GET
Get Dhcp Lease Info
GET
Get Dhcp Statistics
GET
Get Dhcp Status
GET
Get Exclude List
GET
Get Firewall Section Stats
GET
Get Firewall Stats
GET
Get Firewall Status
GET
Get Firewall Status On Target Resource
GET
Get Instance Endpoint
GET
Get Load Balancer Pool Statistics
GET
Get Load Balancer Pool Status
GET
Get Load Balancer Service Statistics
GET
Get Load Balancer Service Status
GET
Get Load Balancer Virtual Server Statistics
GET
Get Load Balancer Virtual Server Status
GET
Get Metadata Proxy Statistics
GET
Get Metadata Proxy Status
GET
Get Rule
GET
Get Rules
GET
Get Rule State
GET
Get Runtime Interface Operational Status
GET
Get Runtime Interface Statistics
GET
Get Section
GET
Get Sections Summary
GET
Get Section State
POST
Get Section With Rules List With Rules
GET
Get Service Attachment
GET
Get Service Insertion Rule
GET
Get Service Insertion Rules
GET
Get Service Insertion Section
POST
Get Service Insertion Section With Rules List With Rules
GET
Get Service Insertion Service
GET
Get Service Instance
GET
List Dhcp Ip Pools
GET
List Dhcp Profiles
GET
List Dhcp Servers
GET
List Dhcp Static Bindings
GET
List Dns Forwaders
GET
List Firewall Status
GET
List Instance Endpoints
GET
List Instance Runtimes
GET
List Load Balancer Application Profiles
GET
List Load Balancer Client Ssl Profiles
GET
List Load Balancer Monitors
GET
List Load Balancer Persistence Profiles
GET
List Load Balancer Pools
GET
List Load Balancer Pool Statistics
GET
List Load Balancer Pool Statuses
GET
List Load Balancer Rules
GET
List Load Balancer Server Ssl Profiles
GET
List Load Balancer Services
GET
List Load Balancer Ssl Ciphers And Protocols
GET
List Load Balancer Tcp Profiles
GET
List Load Balancer Virtual Servers
GET
List Load Balancer Virtual Servers Statistics
GET
List Load Balancer Virtual Server Statuses
GET
List Metadata Proxy
GET
List Sections
GET
List Service Attachments
GET
List Service Insertion Sections
GET
List Service Insertion Services
GET
List Service Instances For Service
POST
Lock Section Lock
GET
Lookup Address
POST
Perform Pool Member Action
GET
Read Dhcp Ip Pool
GET
Read Dhcp Profile
GET
Read Dhcp Server
GET
Read Dhcp Static Binding
GET
Read Dns Forwader
GET
Read Firewall Rule
GET
Read Load Balancer Application Profile
GET
Read Load Balancer Client Ssl Profile
GET
Read Load Balancer Monitor
GET
Read Load Balancer Persistence Profile
GET
Read Load Balancer Pool
GET
Read Load Balancer Rule
GET
Read Load Balancer Server Ssl Profile
GET
Read Load Balancer Service
GET
Read Load Balancer Service Debug Info
GET
Read Load Balancer Service Usage
GET
Read Load Balancer Tcp Profile
GET
Read Load Balancer Virtual Server
GET
Read Metadata Proxy
POST
Remove Member Remove Member
POST
Reset Firewall Rule Stats Reset
POST
Revise Rule Revise
POST
Revise Section Revise
POST
Revise Section With Rules Revise With Rules
POST
Revise Service Insertion Rule Revise
POST
Revise Service Insertion Section Revise
POST
Revise Service Insertion Section With Rules Revise With Rules
POST
Unlock Section Unlock
PUT
Update Dhcp Ip Pool
PUT
Update Dhcp Profile
PUT
Update Dhcp Server
PUT
Update Dhcp Static Binding
PUT
Update Dns Forwarder
PUT
Update Exclude List
PUT
Update Firewall Status
PUT
Update Load Balancer Application Profile
PUT
Update Load Balancer Client Ssl Profile
PUT
Update Load Balancer Monitor
PUT
Update Load Balancer Persistence Profile
PUT
Update Load Balancer Pool
PUT
Update Load Balancer Rule
PUT
Update Load Balancer Server Ssl Profile
PUT
Update Load Balancer Service
PUT
Update Load Balancer Tcp Profile
PUT
Update Load Balancer Virtual Server
PUT
Update Load Balancer Virtual Server With Rules Update With Rules
PUT
Update Metadata Proxy
PUT
Update Rule
PUT
Update Section
POST
Update Section With Rules Update With Rules
PUT
Update Service Insertion Rule
PUT
Update Service Insertion Section
POST
Update Service Insertion Section With Rules Update With Rules
PUT
Update Service Insertion Service
PUT
Update Service Instance
POST
Upgrade Service V Ms Upgrade