LbService (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_protection Indicates protection status of this resource

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.
string Readonly
_revision Generation of this resource config

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.
int
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
access_log_enabled Whether access log is enabled boolean Deprecated
attachment The target which is used to instantiate Lb service.

LBS could be instantiated (or created) on the Logical router, etc.
Typically, it could be applied to Tier1 LogicalRouter. It can be
attached to Tier0 LogicalRouter either in non-multi-tenant environments
or to provide load balancing for infrastructure services offered by
the provider.
If size is set to DLB for distribution, the attachment is optional.
The supported attachment is NSGroup consisting of VIFs of that load
balancer's clients.
If the attachment is not specified and size is DLB, the associated
load balancer settings are applied to all supported transport nodes.
ResourceReference
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
Sortable
enabled Whether the load balancer service is enabled boolean Default: "True"
error_log_level Error log level of load balancer service

Load balancer engine writes information about encountered issues of
different severity levels to the error log. This setting is used to
define the severity level of the error log.
LbLogLevel Default: "INFO"
id Unique identifier of this resource string Sortable
relax_scale_validation Whether scale validation is relaxed

If relax_scale_validation is true, the scale validations for virtual
servers/pools/pool members/rules are relaxed for load balancer service.
When load balancer service is deployed on edge nodes, the scale of
virtual servers/pools/pool members for the load balancer service should
not exceed the scale number of the largest load balancer size which
could be configured on a certain edge form factor. For example, the
largest load balancer size supported on a MEDIUM edge node is MEDIUM.
So one SMALL load balancer deployed on MEDIUM edge nodes can support
the scale number of MEDIUM load balancer. It is not recommended to
enable active monitors if relax_scale_validation is true due to
performance consideration.
If relax_scale_validation is false, scale numbers should be validated
for load balancer service.
boolean Default: "False"
resource_type Must be set to the value LbService string
size The size of load balancer service LbServiceSize Default: "SMALL"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
virtual_server_ids Virtual server identifier list

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 virtual
server identifier list here would be used to maintain the relationship of
LbService and other Lb entities.
array of string