Read Load Balancer Virtual Server

Retrieve a load balancer virtual server.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/loadbalancer/virtual-servers/{virtual-server-id}

COPY

Path Parameters

string

virtual-server-id

Required

virtual-server-id

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns LbVirtualServer of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineLbVirtualServer1

{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_revision": 0,
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_create_user": "string",
    "_protection": "string",
    "_create_time": 0,
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "ip_protocol": "string",
    "server_tcp_profile_id": "string",
    "sorry_pool_id": "string",
    "port": "string",
    "server_ssl_profile_binding": {
        "server_auth_crl_ids": [
            "string"
        ],
        "server_auth": "string",
        "certificate_chain_depth": 0,
        "client_certificate_id": "string",
        "server_auth_ca_ids": [
            "string"
        ],
        "ssl_profile_id": "string"
    },
    "pool_id": "string",
    "client_tcp_profile_id": "string",
    "default_pool_member_port": "string",
    "access_log_enabled": false,
    "application_profile_id": "string",
    "max_concurrent_connections": 0,
    "rule_ids": [
        "string"
    ],
    "max_new_connection_rate": 0,
    "persistence_profile_id": "string",
    "client_ssl_profile_binding": {
        "client_auth": "string",
        "ssl_profile_id": "string",
        "certificate_chain_depth": 0,
        "client_auth_ca_ids": [
            "string"
        ],
        "default_certificate_id": "string",
        "sni_certificate_ids": [
            "string"
        ],
        "client_auth_crl_ids": [
            "string"
        ]
    },
    "default_pool_member_ports": [
        "string"
    ],
    "ip_address": "string",
    "ports": [
        "string"
    ],
    "enabled": false
}

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