project STRING Required

Name of the project scoping this request

filter STRING

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 =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

maxResults INTEGER

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

orderBy STRING

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 orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported

pageToken STRING

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results

id STRING

[Output Only] Unique identifier for the resource; defined by the server

items OBJECT

A list of BackendServicesScopedList resources

items.customKey OBJECT

Add additional named properties

items.customKey.backendServices[] OBJECT

Represents a Backend Service resource.

Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services.

A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director.

A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

items.customKey.backendServices[].affinityCookieTtlSec INTEGER

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 is one day (86,400)

items.customKey.backendServices[].cdnPolicy OBJECT

Message containing Cloud CDN configuration for a backend service

items.customKey.backendServices[].connectionDraining OBJECT

Message containing connection draining configuration

items.customKey.backendServices[].creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

items.customKey.backendServices[].customRequestHeaders[] STRING

items.customKey.backendServices[].description STRING

An optional description of this resource. Provide this property when you create the resource

items.customKey.backendServices[].enableCDN BOOLEAN

If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS

items.customKey.backendServices[].fingerprint BINARY

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, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a BackendService

items.customKey.backendServices[].healthChecks[] STRING

items.customKey.backendServices[].iap OBJECT

Identity-Aware Proxy

items.customKey.backendServices[].id INTEGER

[Output Only] The unique identifier for the resource. This identifier is defined by the server

items.customKey.backendServices[].kind STRING

[Output Only] Type of resource. Always compute#backendService for backend services

items.customKey.backendServices[].loadBalancingScheme ENUMERATION

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

items.customKey.backendServices[].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

items.customKey.backendServices[].port INTEGER

Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.

This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing)

items.customKey.backendServices[].portName STRING

A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.

Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Blaancing)

items.customKey.backendServices[].protocol ENUMERATION

The protocol this BackendService uses to communicate with backends.

Possible values are HTTP, HTTPS, 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.customKey.backendServices[].region STRING

[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.customKey.backendServices[].securityPolicy STRING

[Output Only] The resource URL for the security policy associated with this backend service

items.customKey.backendServices[].selfLink STRING

[Output Only] Server-defined URL for the resource

items.customKey.backendServices[].sessionAffinity ENUMERATION

Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.

When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. GENERATED_COOKIE is only available if the protocol is HTTP or HTTPS.

When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.

When the loadBalancingScheme is INTERNAL_SELF_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE

items.customKey.backendServices[].timeoutSec INTEGER

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.customKey.warning OBJECT

Informational warning which replaces the list of backend services when the list is empty

items.customKey.warning.code ENUMERATION

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response

items.customKey.warning.data[] OBJECT

items.customKey.warning.data[].key STRING

[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 scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)

items.customKey.warning.data[].value STRING

[Output Only] A warning data value corresponding to the key

items.customKey.warning.message STRING

[Output Only] A human-readable description of the warning code

kind STRING

Type of resource

nextPageToken STRING

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results

selfLink STRING

[Output Only] Server-defined URL for this resource

warning OBJECT

[Output Only] Informational warning message

warning.code ENUMERATION

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response

warning.data[] OBJECT

warning.data[].key STRING

[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 scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)

warning.data[].value STRING

[Output Only] A warning data value corresponding to the key

warning.message STRING

[Output Only] A human-readable description of the warning code