- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
Retrieves the list of regional BackendService resources available to the specified project in the given region.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/backendServices
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
region |
Name of the region scoping this request. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example, |
orderBy |
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using Currently, only sorting by |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "items": [ { "id": string, "creationTimestamp": string, "name": string, "description": string, "selfLink": string, "backends": [ { "description": string, "group": string, "balancingMode": enum, "maxUtilization": number, "maxRate": number, "maxRatePerInstance": number, "maxRatePerEndpoint": number, "maxConnections": number, "maxConnectionsPerInstance": number, "maxConnectionsPerEndpoint": number, "capacityScaler": number, "failover": boolean } ], "healthChecks": [ string ], "timeoutSec": number, "port": number, "protocol": enum, "fingerprint": string, "portName": string, "enableCDN": boolean, "sessionAffinity": enum, "affinityCookieTtlSec": number, "region": string, "failoverPolicy": { "disableConnectionDrainOnFailover": boolean, "dropTrafficIfUnhealthy": boolean, "failoverRatio": number }, "loadBalancingScheme": enum, "connectionDraining": { "drainingTimeoutSec": number }, "iap": { "enabled": boolean, "oauth2ClientId": string, "oauth2ClientSecret": string, "oauth2ClientSecretSha256": string }, "cdnPolicy": { "cacheKeyPolicy": { "includeProtocol": boolean, "includeHost": boolean, "includeQueryString": boolean, "queryStringWhitelist": [ string ], "queryStringBlacklist": [ string ] }, "signedUrlKeyNames": [ string ], "signedUrlCacheMaxAgeSec": string }, "customRequestHeaders": [ string ], "securityPolicy": string, "logConfig": { "enable": boolean, "sampleRate": number }, "localityLbPolicy": enum, "consistentHash": { "httpCookie": { "name": string, "path": string, "ttl": { "seconds": string, "nanos": number } }, "httpHeaderName": string, "minimumRingSize": string }, "circuitBreakers": { "connectTimeout": { "seconds": string, "nanos": number }, "maxRequestsPerConnection": number, "maxConnections": number, "maxPendingRequests": number, "maxRequests": number, "maxRetries": number }, "outlierDetection": { "consecutiveErrors": number, "interval": { "seconds": string, "nanos": number }, "baseEjectionTime": { "seconds": string, "nanos": number }, "maxEjectionPercent": number, "enforcingConsecutiveErrors": number, "enforcingSuccessRate": number, "successRateMinimumHosts": number, "successRateRequestVolume": number, "successRateStdevFactor": number, "consecutiveGatewayFailure": number, "enforcingConsecutiveGatewayFailure": number }, "network": string, "loadBalancingSchemeAlts": [ enum ], "serviceProtocolAlts": [ enum ], "kind": string } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "kind": string } |
Fields | |
---|---|
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
A list of BackendService resources. |
items[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
items[].name |
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 |
items[].description |
An optional description of this resource. Provide this property when you create the resource. |
items[].selfLink |
[Output Only] Server-defined URL for the resource. |
items[].backends[] |
The list of backends that serve this BackendService. |
items[].backends[].description |
An optional description of this resource. Provide this property when you create the resource. |
items[].backends[].group |
The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's
You must use the fully-qualified URL (starting with |
items[].backends[].balancingMode |
Specifies the balancing mode for the backend. When choosing a balancing mode, you need to consider the
|
items[].backends[].maxUtilization |
Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is This parameter can be used in conjunction with |
items[].backends[].maxRate |
The max requests per second (RPS) of the group. Can be used with either This cannot be used for internal load balancing. |
items[].backends[].maxRatePerInstance |
Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group. If the backend's Not available if the backend's |
items[].backends[].maxRatePerEndpoint |
Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG. If the backend's Not available if the backend's |
items[].backends[].maxConnections |
Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's Not available if the backend's |
items[].backends[].maxConnectionsPerInstance |
Defines a maximum target for simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's Not available if the backend's |
items[].backends[].maxConnectionsPerEndpoint |
Defines a maximum target for simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's Not available if the backend's |
items[].backends[].capacityScaler |
A multiplier applied to the group's maximum servicing capacity (based on This cannot be used for internal load balancing. |
items[].backends[].failover |
This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. |
items[].healthChecks[] |
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. |
items[].timeoutSec |
The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds. |
items[].port |
Deprecated in favor of This cannot be used if the |
items[].protocol |
The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information. |
items[].fingerprint |
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 To see the latest fingerprint, make a A base64-encoded string. |
items[].portName |
A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the Must be omitted when the |
items[].enableCDN |
If |
items[].sessionAffinity |
Type of session affinity to use. The default is When the When the When the |
items[].affinityCookieTtlSec |
If set to |
items[].region |
[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
items[].failoverPolicy |
Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend. |
items[].failoverPolicy.disableConnectionDrainOnFailover |
This can be set to The default is |
items[].failoverPolicy.dropTrafficIfUnhealthy |
Applicable only to Failover for Internal TCP/UDP Load Balancing. If set to The default is |
items[].failoverPolicy.failoverRatio |
Applicable only to Failover for Internal TCP/UDP Load Balancing. The value of the field must be in the range |
items[].loadBalancingScheme |
Specifies the load balancer type. Choose |
items[].connectionDraining |
|
items[].connectionDraining.drainingTimeoutSec |
The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the |
items[].iap |
|
items[].iap.enabled |
|
items[].iap.oauth2ClientId |
|
items[].iap.oauth2ClientSecret |
|
items[].iap.oauth2ClientSecretSha256 |
[Output Only] SHA256 hash value for the field oauth2ClientSecret above. |
items[].cdnPolicy |
Cloud CDN configuration for this BackendService. |
items[].cdnPolicy.cacheKeyPolicy |
The CacheKeyPolicy for this CdnPolicy. |
items[].cdnPolicy.cacheKeyPolicy.includeProtocol |
If true, http and https requests will be cached separately. |
items[].cdnPolicy.cacheKeyPolicy.includeHost |
If true, requests to different hosts will be cached separately. |
items[].cdnPolicy.cacheKeyPolicy.includeQueryString |
If true, include query string parameters in the cache key according to queryStringWhitelist and queryStringBlacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. |
items[].cdnPolicy.cacheKeyPolicy.queryStringWhitelist[] |
Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify queryStringWhitelist or queryStringBlacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. |
items[].cdnPolicy.cacheKeyPolicy.queryStringBlacklist[] |
Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify queryStringWhitelist or queryStringBlacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. |
items[].cdnPolicy.signedUrlKeyNames[] |
[Output Only] Names of the keys for signing request URLs. |
items[].cdnPolicy.signedUrlCacheMaxAgeSec |
Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a |
items[].customRequestHeaders[] |
Headers that the HTTP/S load balancer should add to proxied requests. |
items[].securityPolicy |
[Output Only] The resource URL for the security policy associated with this backend service. |
items[].logConfig |
This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. |
items[].logConfig.enable |
This field denotes whether to enable logging for the load balancer traffic served by this backend service. |
items[].logConfig.sampleRate |
This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0. |
items[].localityLbPolicy |
The load balancing algorithm used within the scope of the locality. The possible values are:
This field is applicable to either: If |
items[].consistentHash |
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when This field is applicable to either:
|
items[].consistentHash.httpCookie |
Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the |
items[].consistentHash.httpCookie.name |
Name of the cookie. |
items[].consistentHash.httpCookie.path |
Path to set for the cookie. |
items[].consistentHash.httpCookie.ttl |
Lifetime of the cookie. |
items[].consistentHash.httpCookie.ttl.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
items[].consistentHash.httpCookie.ttl.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
items[].consistentHash.httpHeaderName |
The hash based on the value of the specified header field. This field is applicable if the |
items[].consistentHash.minimumRingSize |
The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. |
items[].circuitBreakers |
Settings controlling the volume of connections to a backend service. If not set, this feature is considered disabled. This field is applicable to either:
|
items[].circuitBreakers.connectTimeout |
The timeout for new network connections to hosts. |
items[].circuitBreakers.connectTimeout.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
items[].circuitBreakers.connectTimeout.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
items[].circuitBreakers.maxRequestsPerConnection |
Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. |
items[].circuitBreakers.maxConnections |
The maximum number of connections to the backend service. If not specified, there is no limit. |
items[].circuitBreakers.maxPendingRequests |
The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. |
items[].circuitBreakers.maxRequests |
The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit. |
items[].circuitBreakers.maxRetries |
The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. |
items[].outlierDetection |
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either:
|
items[].outlierDetection.consecutiveErrors |
Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. |
items[].outlierDetection.interval |
Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. |
items[].outlierDetection.interval.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
items[].outlierDetection.interval.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
items[].outlierDetection.baseEjectionTime |
The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. |
items[].outlierDetection.baseEjectionTime.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
items[].outlierDetection.baseEjectionTime.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
items[].outlierDetection.maxEjectionPercent |
Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. |
items[].outlierDetection.enforcingConsecutiveErrors |
The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. |
items[].outlierDetection.enforcingSuccessRate |
The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. |
items[].outlierDetection.successRateMinimumHosts |
The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. |
items[].outlierDetection.successRateRequestVolume |
The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. |
items[].outlierDetection.successRateStdevFactor |
This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. |
items[].outlierDetection.consecutiveGatewayFailure |
The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. |
items[].outlierDetection.enforcingConsecutiveGatewayFailure |
The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. |
items[].network |
The URL of the network to which this backend service belongs. This field can only be spcified when the load balancing scheme is set to |
items[].kind |
[Output Only] Type of resource. Always |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
kind |
[Output Only] Type of resource. Always |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:
compute.regionBackendServices.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.