For a list of methods for this resource, see the end of this page.
Resource representations
A BackendService resource. This resource defines a group of backend VMs together with their serving capacity.
{
"kind": "compute#backendService",
"id": unsigned long,
"creationTimestamp": string,
"name": string,
"description": string,
"selfLink": string,
"backends": [
{
"description": string,
"group": string,
"balancingMode": string,
"maxUtilization": float,
"maxRate": integer,
"maxRatePerInstance": float,
"capacityScaler": float
}
],
"healthChecks": [
string
],
"timeoutSec": integer,
"port": integer,
"protocol": string,
"fingerprint": bytes
}
| Property name | Value | Description | Notes |
|---|---|---|---|
backends[]
|
list
|
The list of backends that serve this BackendService. | |
backends[].
balancingMode
|
string
|
The balancing mode of this backend, default is UTILIZATION.
Acceptable values are:
|
|
backends[].
capacityScaler
|
float
|
The multiplier (a value between 0 and 1e6) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0, 1e6]. | |
backends[].
description
|
string
|
An optional textual description of the resource, which is provided by the client when the resource is created. | |
backends[].
group
|
string
|
URL of a zonal Cloud Resource View resource. This resource view defines the list of instances that serve traffic. Member virtual machine instances from each resource view must live in the same zone as the resource view itself. No two backends in a backend service are allowed to use same Resource View resource. | |
backends[].
maxRate
|
integer
|
The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. | |
backends[].
maxRatePerInstance
|
float
|
The max RPS that a single backed 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. | |
backends[].
maxUtilization
|
float
|
Used when 'balancingMode' is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0, 1]. | |
creationTimestamp
|
string
|
Creation timestamp in RFC3339 text format (output only). | |
description
|
string
|
An optional textual description of the resource; provided by the client when the resource is created. | |
fingerprint
|
bytes
|
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService. | |
healthChecks[]
|
list
|
The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required. | |
id
|
unsigned long
|
Unique identifier for the resource; defined by the server (output only). | |
kind
|
string
|
Type of the resource. | |
name
|
string
|
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. | |
port
|
integer
|
The TCP port to connect on the backend. The default value is 80. | |
protocol
|
string
|
Acceptable values are:
|
|
selfLink
|
string
|
Server defined URL for the resource (output only). | |
timeoutSec
|
integer
|
How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. |
Methods
- delete
- Deletes the specified BackendService resource.
- get
- Returns the specified BackendService resource.
- getHealth
- Gets the most recent health check results for this BackendService.
- insert
- Creates a BackendService resource in the specified project using the data included in the request.
- list
- Retrieves the list of BackendService resources available to the specified project.
- patch
- Update the entire content of the BackendService resource. This method supports patch semantics.
- update
- Update the entire content of the BackendService resource.