BackendServices

A Backend Service resource defines a group of virtual machines that will serve traffic for load balancing.

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 virtual machines and 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,
      "maxConnections": integer,
      "maxConnectionsPerInstance": integer,
      "capacityScaler": float
    }
  ],
  "healthChecks": [
    string
  ],
  "timeoutSec": integer,
  "port": integer,
  "protocol": string,
  "fingerprint": bytes,
  "portName": string,
  "enableCDN": boolean,
  "sessionAffinity": string,
  "affinityCookieTtlSec": integer,
  "region": string,
  "loadBalancingScheme": string,
  "connectionDraining": {
    "drainingTimeoutSec": integer
  },
  "iap": {
    "enabled": boolean,
    "oauth2ClientId": string,
    "oauth2ClientSecret": string,
    "oauth2ClientSecretSha256": string
  },
  "cdnPolicy": {
    "cacheKeyPolicy": {
      "includeProtocol": boolean,
      "includeHost": boolean,
      "includeQueryString": boolean,
      "queryStringWhitelist": [
        string
      ],
      "queryStringBlacklist": [
        string
      ]
    }
  }
}
Property name Value Description Notes
affinityCookieTtlSec integer 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[] list The list of backends that serve this BackendService.
backends[].balancingMode string 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).

For Internal Load Balancing, the default and only supported mode is CONNECTION.
backends[].capacityScaler float 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.
backends[].description string An optional description of this resource. Provide this property when you create the resource.
backends[].group string The fully-qualified URL of a Instance Group resource. 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.

Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.

When the BackendService has load balancing scheme INTERNAL, the instance group must be within the same region as the BackendService.
backends[].maxConnections integer 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.
backends[].maxConnectionsPerInstance integer 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.
backends[].maxRate integer 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.
backends[].maxRatePerInstance float 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.
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.0, 1.0].

This cannot be used for internal load balancing.
cdnPolicy nested object Cloud CDN configuration for this BackendService.
cdnPolicy.cacheKeyPolicy nested object The CacheKeyPolicy for this CdnPolicy.
cdnPolicy.cacheKeyPolicy.includeHost boolean If true, requests to different hosts will be cached separately.
cdnPolicy.cacheKeyPolicy.includeProtocol boolean If true, http and https requests will be cached separately.
cdnPolicy.cacheKeyPolicy.includeQueryString boolean 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.
cdnPolicy.cacheKeyPolicy.queryStringBlacklist[] list 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.
cdnPolicy.cacheKeyPolicy.queryStringWhitelist[] list 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.
connectionDraining nested object
connectionDraining.drainingTimeoutSec integer Time for which instance will be drained (not accept new connections, but still work to finish started).
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
description string An optional description of this resource. Provide this property when you create the resource.
enableCDN boolean If true, enable Cloud CDN for this BackendService.

When the load balancing scheme is INTERNAL, this field is not used.
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 or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend.

For internal load balancing, a URL to a HealthCheck resource must be specified instead.
iap nested object
iap.enabled boolean
iap.oauth2ClientId string
iap.oauth2ClientSecret string
iap.oauth2ClientSecretSha256 string [Output Only] SHA256 hash value for the field oauth2_client_secret above.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kind string [Output Only] Type of resource. Always compute#backendService for backend services.
loadBalancingScheme string Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL.
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. 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 integer Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.

This cannot be used for internal load balancing.

portName string 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 string 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 string [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
sessionAffinity string 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.
timeoutSec integer How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.

Methods

aggregatedList
Retrieves the list of all BackendService resources, regional and global, available to the specified project.
delete
Deletes the specified BackendService resource.
get
Returns the specified BackendService resource. Get a list of available backend services by making a list() request.
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. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.
list
Retrieves the list of BackendService resources available to the specified project.
patch
Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
update
Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

外出先でもリソースをモニタリング

Google Cloud Console アプリを入手して、プロジェクトの管理にお役立てください。

フィードバックを送信...