Developer Documentation


All the types of LBVirtualServer extend from this abstract class. This is present for extensibility.


Required Property Name Type Description
optional _create_time integer

Timestamp of resource creation

optional _create_user string

ID of the user who created this resource

optional _last_modified_time integer

Timestamp of last modification

optional _last_modified_user string

ID of the user who last modified this resource

optional _links array of ResourceLink

The server will populate this field when returing the resource. Ignored on PUT and POST.

optional _protection string

Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.

optional _revision integer

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.

optional _schema string

Schema for this resource

optional _self SelfResourceLink

Link to this resource

optional _system_owned boolean

Indicates system owned resource

optional access_log_enabled boolean

If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.

optional application_profile_path string

The application profile defines the application protocol characteristics. It is used to influence how load balancing is performed. Currently, LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile, etc are supported.

optional children array of ChildPolicyConfigResource

subtree for this type within policy tree containing nested elements.

optional client_ssl_profile_binding LBClientSslProfileBinding

The setting is used when load balancer acts as an SSL server and terminating the client SSL connection

optional default_pool_member_ports array of string

Default pool member ports when member port is not defined.

optional description string

Description of this resource

optional display_name string

Defaults to ID if not set

optional enabled boolean

Flag to enable the load balancer virtual server.

optional id string

Unique identifier of this resource

optional ip_address string

Configures the IP address of the LBVirtualServer where it receives all client connections and distributes them among the backend servers.

optional lb_persistence_profile_path string

Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.

optional lb_service_path string

virtual servers can be associated to LBService(which is similar to physical/virtual load balancer), LB virtual servers, pools and other entities could be defined independently, the LBService identifier list here would be used to maintain the relationship of LBService and other LB entities.

optional marked_for_delete boolean

Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.

optional max_concurrent_connections integer

To ensure one virtual server does not over consume resources, affecting other applications hosted on the same LBS, connections to a virtual server can be capped. If it is not specified, it means that connections are unlimited.

optional max_new_connection_rate integer

To ensure one virtual server does not over consume resources, connections to a member can be rate limited. If it is not specified, it means that connection rate is unlimited.

optional parent_path string

Path of its parent

optional path string

Absolute path of this object

optional pool_path string

The server pool(LBPool) contains backend servers. Server pool consists of one or more servers, also referred to as pool members, that are similarly configured and are running the same application.

optional ports array of string

Ports contains a list of at least one port or port range such as “80”, “1234-1236”. Each port element in the list should be a single port or a single port range.

optional relative_path string

Path relative from its parent

optional resource_type string

The type of this resource.

optional rules array of LBRule

Load balancer rules allow customization of load balancing behavior using match/action rules. Currently, load balancer rules are supported for only layer 7 virtual servers with LBHttpProfile.

optional server_ssl_profile_binding LBServerSslProfileBinding

The setting is used when load balancer acts as an SSL client and establishing a connection to the backend server.

optional sorry_pool_path string

When load balancer can not select a backend server to serve the request in default pool or pool in rules, the request would be served by sorry server pool.

optional tags array of Tag

Opaque identifiers meaningful to the API user


Was this page helpful?