LBService (schema)

Loadbalancer Service

Loadbalancer Service.
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 Flag to enable access log boolean Deprecated
children subtree for this type within policy tree

subtree for this type within policy tree containing nested elements.
array of ChildPolicyConfigResource
Children are not allowed for this type
connectivity_path The connectivity target used to instantiate the LBService

LBS could be instantiated (or created) on the Tier-1, etc.
For now, only the Tier-1 object is supported.
string
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 Flag to enable the load balancer service

Flag to enable the load balancer service.
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
marked_for_delete Indicates whether the intent object is marked for deletion

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.
boolean Readonly
Default: "False"
overridden Indicates whether this object is the overridden intent object

Global intent objects cannot be modified by the user.
However, certain global intent objects can be overridden locally by use
of this property. In such cases, the overridden local values take
precedence over the globally defined values for the properties.
boolean Readonly
Default: "False"
parent_path Path of its parent

Path of its parent
string Readonly
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
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 Load balancer service size

Load balancer service size.
LbServiceSize Default: "SMALL"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
unique_id A unique identifier assigned by the system

This is a UUID generated by the GM/LM to uniquely identify
entites in a federated environment. For entities that are
stretched across multiple sites, the same ID will be used
on all the stretched sites.
string Readonly