Key |
Returned |
Description |
items
complex
|
always |
List of items
|
|
affinity_cookie_ttl_sec
int
|
success |
Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
When the load balancing scheme is INTERNAL, this field is not used.
|
|
backends
complex
|
success |
The list of backends that serve this BackendService.
|
|
|
balancing_mode
str
|
success |
Specifies the balancing mode for this backend.
For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
This cannot be used for internal load balancing.
|
|
|
capacity_scaler
str
|
success |
A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).
Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
This cannot be used for internal load balancing.
|
|
|
description
str
|
success |
An optional description of this resource.
Provide this property when you create the resource.
|
|
|
group
dict
|
success |
This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself.
No two backends in a backend service are allowed to use same Instance Group resource.
When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
|
|
|
max_connections
int
|
success |
The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
This cannot be used for internal load balancing.
|
|
|
max_connections_per_instance
int
|
success |
The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
This cannot be used for internal load balancing.
|
|
|
max_rate
int
|
success |
The max requests per second (RPS) of the group.
Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
This cannot be used for internal load balancing.
|
|
|
max_rate_per_instance
str
|
success |
The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
This cannot be used for internal load balancing.
|
|
|
max_utilization
str
|
success |
Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
This cannot be used for internal load balancing.
|
|
cdn_policy
complex
|
success |
Cloud CDN configuration for this BackendService.
|
|
|
cache_key_policy
complex
|
success |
The CacheKeyPolicy for this CdnPolicy.
|
|
|
|
include_host
bool
|
success |
If true requests to different hosts will be cached separately.
|
|
|
|
include_protocol
bool
|
success |
If true, http and https requests will be cached separately.
|
|
|
|
include_query_string
bool
|
success |
If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.
If false, the query string will be excluded from the cache key entirely.
|
|
|
|
query_string_blacklist
list
|
success |
Names of query string parameters to exclude in cache keys.
All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both.
'&' and '=' will be percent encoded and not treated as delimiters.
|
|
|
|
query_string_whitelist
list
|
success |
Names of query string parameters to include in cache keys.
All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both.
'&' and '=' will be percent encoded and not treated as delimiters.
|
|
connection_draining
complex
|
success |
Settings for connection draining.
|
|
|
draining_timeout_sec
int
|
success |
Time for which instance will be drained (not accept new connections, but still work to finish started).
|
|
creation_timestamp
str
|
success |
Creation timestamp in RFC3339 text format.
|
|
description
str
|
success |
An optional description of this resource.
|
|
enable_cdn
bool
|
success |
If true, enable Cloud CDN for this BackendService.
When the load balancing scheme is INTERNAL, this field is not used.
|
|
health_checks
list
|
success |
The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
For internal load balancing, a URL to a HealthCheck resource must be specified instead.
|
|
id
int
|
success |
The unique identifier for the resource.
|
|
name
str
|
success |
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
|
|
port_name
str
|
success |
Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
When the load balancing scheme is INTERNAL, this field is not used.
|
|
protocol
str
|
success |
The protocol this BackendService uses to communicate with backends.
Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.
For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
|
|
region
str
|
success |
The region where the regional backend service resides.
This field is not applicable to global backend services.
|
|
session_affinity
str
|
success |
Type of session affinity to use. The default is NONE.
When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
When the protocol is UDP, this field is not used.
|
|
timeout_sec
int
|
success |
How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].
|