Get Load Balancer Pool Statistics

Returns the statistics 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}/statistics

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.

BasicAuth

Responses

200

Returns LbPoolStatistics of type(s) application/json

{
    "last_update_timestamp": 0,
    "statistics": {
        "source_ip_persistence_entry_size": 0,
        "packets_out": 0,
        "bytes_out_rate": "number",
        "total_sessions": 0,
        "http_request_rate": "number",
        "bytes_out": 0,
        "packets_in_rate": "number",
        "bytes_in_rate": "number",
        "current_sessions": 0,
        "max_sessions": 0,
        "packets_out_rate": "number",
        "http_requests": 0,
        "bytes_in": 0,
        "current_session_rate": "number",
        "packets_in": 0
    },
    "pool_id": "string",
    "members": [
        {
            "statistics": {
                "source_ip_persistence_entry_size": 0,
                "packets_out": 0,
                "bytes_out_rate": "number",
                "total_sessions": 0,
                "http_request_rate": "number",
                "bytes_out": 0,
                "packets_in_rate": "number",
                "bytes_in_rate": "number",
                "current_sessions": 0,
                "max_sessions": 0,
                "packets_out_rate": "number",
                "http_requests": 0,
                "bytes_in": 0,
                "current_session_rate": "number",
                "packets_in": 0
            },
            "ip_address": "string",
            "port": "string"
        }
    ]
}

integer As int64 As int64

last_update_timestamp

Optional

Timestamp when the data was last updated

LbStatisticsCounter

statistics

Required

statistics

string

pool_id

Required

Load balancer pool identifier

array of LbPoolMemberStatistics

members

Optional

Statistics of load balancer pool members

400

Returns BadRequest of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

403

Returns Forbidden of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

404

Returns NotFound of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

412

Returns PreconditionFailed of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

500

Returns InternalServerError of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

503

Returns ServiceUnavailable of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error