Google - API Compute Engine

GET

/{project}/aggregated/acceleratorTypes

Retrieves an aggregated list of accelerator types.

Request

Path

Name	Data Type	Description
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`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.
`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.
`maxResults`	integer Default value: `500` Minimum: 0	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)
`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).

Responses

200Successful response

Body

Name Data Type Description

AcceleratorTypeAggregatedList

AcceleratorTypeAggregatedList object

Properties

`warning`
`selfLink`	string	[Output Only] Server-defined URL for this 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.
`kind`	string Default value: `compute#acceleratorTypeAggregatedList`	[Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList for aggregated lists of accelerator types.
`items`	object	A list of AcceleratorTypesScopedList resources.
`id`	string	[Output Only] Unique identifier for the resource; defined by the server.

GET

/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}

Returns the specified accelerator type.

Request

Path

Name	Data Type	Description
`acceleratorType`	string	Name of the accelerator type to return.
`zone`	string	The name of the zone for this request.
`project`	string	Project ID for this request.

Responses

200Successful response

Body

Name Data Type Description

AcceleratorType


                        AcceleratorType

object

Represents an Accelerator Type resource.

Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==)

Properties


                        zone

string

[Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.


                        selfLink

string

[Output Only] Server-defined fully-qualified URL for this resource.


                        name

string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

[Output Only] Name of the resource.


                        maximumCardsPerInstance

integer

[Output Only] Maximum accelerator cards allowed per instance.


                        kind

string
Default value: compute#acceleratorType

[Output Only] The type of the resource. Always compute#acceleratorType for accelerator types.

id

string

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


                        description

string

[Output Only] An optional textual description of the resource.


                        deprecated

DeprecationStatus

[Output Only] The deprecation status associated with this accelerator type.


                        DeprecationStatus

object

Deprecation status for a public resource.

Properties

`state`	string Allowed values: - `ACTIVE` - `DELETED` - `DEPRECATED` - `OBSOLETE`	The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
`replacement`	string	The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
`obsolete`	string	An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.
`deprecated`	string	An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.
`deleted`	string	An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.


                        creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

GET

/{project}/zones/{zone}/acceleratorTypes

Retrieves a list of accelerator types available to the specified project.

Request

Path

Name	Data Type	Description
`zone`	string	The name of the zone for this request.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`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.
`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.
`maxResults`	integer Default value: `500` Minimum: 0	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)
`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).

Responses

200Successful response

Body

Name Data Type Description

AcceleratorTypeList


                        AcceleratorTypeList

object

Contains a list of accelerator types.

Properties

warning


                        selfLink

string

[Output Only] Server-defined URL for this 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.


                        kind

string
Default value: compute#acceleratorTypeList

[Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types.


                        items

array [AcceleratorType]

A list of AcceleratorType resources.


                        AcceleratorType

object

Represents an Accelerator Type resource.

Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==)

Properties

`zone`	string	[Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`selfLink`	string	[Output Only] Server-defined fully-qualified URL for this resource.
`name`	string Pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`	[Output Only] Name of the resource.
`maximumCardsPerInstance`	integer	[Output Only] Maximum accelerator cards allowed per instance.
`kind`	string Default value: `compute#acceleratorType`	[Output Only] The type of the resource. Always compute#acceleratorType for accelerator types.
`id`	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`description`	string	[Output Only] An optional textual description of the resource.
`deprecated`	DeprecationStatus	[Output Only] The deprecation status associated with this accelerator type.
`creationTimestamp`	string	[Output Only] Creation timestamp in RFC3339 text format.

id

string

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

GET

/{project}/aggregated/addresses

Retrieves an aggregated list of addresses.

Request

Path

Name	Data Type	Description
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`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.
`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.
`maxResults`	integer Default value: `500` Minimum: 0	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)
`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).

Responses

200Successful response

Body

Name Data Type Description

AddressAggregatedList

AddressAggregatedList object

Properties

`warning`
`selfLink`	string	[Output Only] Server-defined URL for this 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.
`kind`	string Default value: `compute#addressAggregatedList`	[Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.
`items`	object	A list of AddressesScopedList resources.
`id`	string	[Output Only] Unique identifier for the resource; defined by the server.

DELETE

/{project}/regions/{region}/addresses/{address}

Deletes the specified address resource.

Request

Path

Name	Data Type	Description
`address`	string	Name of the address resource to delete.
`region`	string	Name of the region for this request.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

GET

/{project}/regions/{region}/addresses/{address}

Returns the specified address resource.

Request

Path

Name	Data Type	Description
`address`	string	Name of the address resource to return.
`region`	string	Name of the region for this request.
`project`	string	Project ID for this request.

Responses

200Successful response

Body

Name Data Type Description

Address


                        Address

object

Represents an IP Address resource.

An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses.

A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==)

Properties

`users`	array [string]	[Output Only] The URLs of the resources that are using this address.
`subnetwork`	string	The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
`status`	string Allowed values: - `IN_USE` - `RESERVED` - `RESERVING`	[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.
`purpose`	string Allowed values: - `DNS_RESOLVER` - `GCE_ENDPOINT` - `NAT_AUTO` - `VPC_PEERING`	The purpose of this resource, which can be one of the following values: `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. `DNS_RESOLVER` for a DNS resolver address in a subnetwork `VPC_PEERING` for addresses that are reserved for VPC peer networks. `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
`prefixLength`	integer	The prefix length if the resource reprensents an IP range.
`networkTier`	string Allowed values: - `PREMIUM` - `STANDARD`	This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer. If this field is not specified, it is assumed to be PREMIUM.
`network`	string	The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
`name`	string Pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`	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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
`kind`	string Default value: `compute#address`	[Output Only] Type of the resource. Always compute#address for addresses.
`ipVersion`	string Allowed values: - `IPV4` - `IPV6` - `UNSPECIFIED_VERSION`	The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.
`id`	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`description`	string	An optional description of this resource. Provide this field when you create the resource.
`creationTimestamp`	string	[Output Only] Creation timestamp in RFC3339 text format.
`addressType`	string Allowed values: - `EXTERNAL` - `INTERNAL` - `UNSPECIFIED_TYPE`	The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
`address`	string	The static IP address represented by this resource.

GET

/{project}/regions/{region}/addresses

Retrieves a list of addresses contained within the specified region.

Request

Path

Name	Data Type	Description
`region`	string	Name of the region for this request.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`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.
`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.
`maxResults`	integer Default value: `500` Minimum: 0	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)
`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).

Responses

200Successful response

Body

Name Data Type Description

AddressList


                        AddressList

object

Contains a list of addresses.

Properties

warning


                        selfLink

string

[Output Only] Server-defined URL for this 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.


                        kind

string
Default value: compute#addressList

[Output Only] Type of resource. Always compute#addressList for lists of addresses.


                        items

array [Address]

A list of Address resources.


                        Address

object

Represents an IP Address resource.

An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses.

A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==)

Properties

`users`	array [string]	[Output Only] The URLs of the resources that are using this address.
`subnetwork`	string	The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
`status`	string Allowed values: - `IN_USE` - `RESERVED` - `RESERVING`	[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.
`purpose`	string Allowed values: - `DNS_RESOLVER` - `GCE_ENDPOINT` - `NAT_AUTO` - `VPC_PEERING`	The purpose of this resource, which can be one of the following values: `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. `DNS_RESOLVER` for a DNS resolver address in a subnetwork `VPC_PEERING` for addresses that are reserved for VPC peer networks. `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
`prefixLength`	integer	The prefix length if the resource reprensents an IP range.
`networkTier`	string Allowed values: - `PREMIUM` - `STANDARD`	This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer. If this field is not specified, it is assumed to be PREMIUM.
`network`	string	The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
`name`	string Pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`	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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
`kind`	string Default value: `compute#address`	[Output Only] Type of the resource. Always compute#address for addresses.
`ipVersion`	string Allowed values: - `IPV4` - `IPV6` - `UNSPECIFIED_VERSION`	The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.
`id`	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`description`	string	An optional description of this resource. Provide this field when you create the resource.
`creationTimestamp`	string	[Output Only] Creation timestamp in RFC3339 text format.
`addressType`	string Allowed values: - `EXTERNAL` - `INTERNAL` - `UNSPECIFIED_TYPE`	The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
`address`	string	The static IP address represented by this resource.

id

string

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

POST

/{project}/regions/{region}/addresses

Creates an address resource in the specified project by using the data included in the request.

Request

Path

Name	Data Type	Description
`region`	string	Name of the region for this request.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Body

Name Data Type Description

Address


                        Address

object

Represents an IP Address resource.

An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses.

A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==)

Properties

`users`	array [string]	[Output Only] The URLs of the resources that are using this address.
`subnetwork`	string	The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
`status`	string Allowed values: - `IN_USE` - `RESERVED` - `RESERVING`	[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.
`purpose`	string Allowed values: - `DNS_RESOLVER` - `GCE_ENDPOINT` - `NAT_AUTO` - `VPC_PEERING`	The purpose of this resource, which can be one of the following values: `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. `DNS_RESOLVER` for a DNS resolver address in a subnetwork `VPC_PEERING` for addresses that are reserved for VPC peer networks. `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
`prefixLength`	integer	The prefix length if the resource reprensents an IP range.
`networkTier`	string Allowed values: - `PREMIUM` - `STANDARD`	This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer. If this field is not specified, it is assumed to be PREMIUM.
`network`	string	The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
`name`	string Pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`	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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
`kind`	string Default value: `compute#address`	[Output Only] Type of the resource. Always compute#address for addresses.
`ipVersion`	string Allowed values: - `IPV4` - `IPV6` - `UNSPECIFIED_VERSION`	The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.
`id`	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`description`	string	An optional description of this resource. Provide this field when you create the resource.
`creationTimestamp`	string	[Output Only] Creation timestamp in RFC3339 text format.
`addressType`	string Allowed values: - `EXTERNAL` - `INTERNAL` - `UNSPECIFIED_TYPE`	The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
`address`	string	The static IP address represented by this resource.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

GET

/{project}/aggregated/autoscalers

Retrieves an aggregated list of autoscalers.

Request

Path

Name	Data Type	Description
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`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.
`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.
`maxResults`	integer Default value: `500` Minimum: 0	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)
`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).

Responses

200Successful response

Body

Name Data Type Description

AutoscalerAggregatedList

AutoscalerAggregatedList object

Properties

`warning`
`selfLink`	string	[Output Only] Server-defined URL for this 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.
`kind`	string Default value: `compute#autoscalerAggregatedList`	[Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.
`items`	object	A list of AutoscalersScopedList resources.
`id`	string	[Output Only] Unique identifier for the resource; defined by the server.

DELETE

/{project}/zones/{zone}/autoscalers/{autoscaler}

Deletes the specified autoscaler.

Request

Path

Name	Data Type	Description
`autoscaler`	string	Name of the autoscaler to delete.
`zone`	string	Name of the zone for this request.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

GET

/{project}/zones/{zone}/autoscalers/{autoscaler}

Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request.

Request

Path

Name	Data Type	Description
`autoscaler`	string	Name of the autoscaler to return.
`zone`	string	Name of the zone for this request.
`project`	string	Project ID for this request.

Responses

200Successful response

Body

Name Data Type Description

Autoscaler


                        Autoscaler

object

Represents an Autoscaler resource.

Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.

For zonal managed instance groups resource, use the autoscaler resource.

For regional managed instance groups, use the regionAutoscalers resource. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

Properties


                        zone

string

[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).


                        target

string

URL of the managed instance group that this autoscaler will scale.


                        statusDetails

array [AutoscalerStatusDetails]

[Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.

AutoscalerStatusDetails object

Properties

`type`	string Allowed values: - `ALL_INSTANCES_UNHEALTHY` - `BACKEND_SERVICE_DOES_NOT_EXIST` - `CAPPED_AT_MAX_NUM_REPLICAS` - `CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE` - `CUSTOM_METRIC_INVALID` - `MIN_EQUALS_MAX` - `MISSING_CUSTOM_METRIC_DATA_POINTS` - `MISSING_LOAD_BALANCING_DATA_POINTS` - `MODE_OFF` - `MODE_ONLY_UP` - `MORE_THAN_ONE_BACKEND_SERVICE` - `NOT_ENOUGH_QUOTA_AVAILABLE` - `REGION_RESOURCE_STOCKOUT` - `SCALING_TARGET_DOES_NOT_EXIST` - `UNKNOWN` - `UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION` - `ZONE_RESOURCE_STOCKOUT`	The type of error, warning, or notice returned. Current set of possible values: ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. The autoscaler can add instances but not remove any. MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.
`message`	string	The status message.


                        status

string
Allowed values:
- ACTIVE
- DELETING
- ERROR
- PENDING

[Output Only] The status of the autoscaler configuration. Current set of possible values:

PENDING: Autoscaler backend hasn't read new/updated configuration.
DELETING: Configuration is being deleted.
ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field.
ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.


                        selfLink

string

[Output Only] Server-defined URL for the resource.


                        region

string

[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).


                        recommendedSize

integer

[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction.


                        name

string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

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.


                        kind

string
Default value: compute#autoscaler

[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

id

string

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


                        description

string

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


                        creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.


                        autoscalingPolicy

AutoscalingPolicy

The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.

If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.


                        AutoscalingPolicy

object

Cloud Autoscaler policy.

Properties

`mode`	string Allowed values: - `OFF` - `ON` - `ONLY_UP`	Defines operating mode for this policy.
`minNumReplicas`	integer	The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
`maxNumReplicas`	integer	The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
`loadBalancingUtilization`	AutoscalingPolicyLoadBalancingUtilization	Configuration parameters of autoscaling based on load balancer.
`customMetricUtilizations`	array [AutoscalingPolicyCustomMetricUtilization]	Configuration parameters of autoscaling based on a custom metric.
`cpuUtilization`	AutoscalingPolicyCpuUtilization	Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
`coolDownPeriodSec`	integer	The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

GET

/{project}/zones/{zone}/autoscalers

Retrieves a list of autoscalers contained within the specified zone.

Request

Path

Name	Data Type	Description
`zone`	string	Name of the zone for this request.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`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.
`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.
`maxResults`	integer Default value: `500` Minimum: 0	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)
`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).

Responses

200Successful response

Body

Name Data Type Description

AutoscalerList


                        AutoscalerList

object

Contains a list of Autoscaler resources.

Properties

warning


                        selfLink

string

[Output Only] Server-defined URL for this 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.


                        kind

string
Default value: compute#autoscalerList

[Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.


                        items

array [Autoscaler]

A list of Autoscaler resources.


                        Autoscaler

object

Represents an Autoscaler resource.

Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.

For zonal managed instance groups resource, use the autoscaler resource.

For regional managed instance groups, use the regionAutoscalers resource. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

Properties

`zone`	string	[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
`target`	string	URL of the managed instance group that this autoscaler will scale.
`statusDetails`	array [AutoscalerStatusDetails]	[Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
`status`	string Allowed values: - `ACTIVE` - `DELETING` - `ERROR` - `PENDING`	[Output Only] The status of the autoscaler configuration. Current set of possible values: PENDING: Autoscaler backend hasn't read new/updated configuration. DELETING: Configuration is being deleted. ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
`recommendedSize`	integer	[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction.
`name`	string Pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`	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.
`kind`	string Default value: `compute#autoscaler`	[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
`id`	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`description`	string	An optional description of this resource. Provide this property when you create the resource.
`creationTimestamp`	string	[Output Only] Creation timestamp in RFC3339 text format.
`autoscalingPolicy`	AutoscalingPolicy	The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.

id

string

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

PATCH

/{project}/zones/{zone}/autoscalers

Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Request

Path

Name	Data Type	Description
`zone`	string	Name of the zone for this request.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
`autoscaler`	string	Name of the autoscaler to patch.

Body

Name Data Type Description

Autoscaler


                        Autoscaler

object

Represents an Autoscaler resource.

Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.

For zonal managed instance groups resource, use the autoscaler resource.

For regional managed instance groups, use the regionAutoscalers resource. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

Properties


                        zone

string

[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).


                        target

string

URL of the managed instance group that this autoscaler will scale.


                        statusDetails

array [AutoscalerStatusDetails]

[Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.

AutoscalerStatusDetails object

Properties

`type`	string Allowed values: - `ALL_INSTANCES_UNHEALTHY` - `BACKEND_SERVICE_DOES_NOT_EXIST` - `CAPPED_AT_MAX_NUM_REPLICAS` - `CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE` - `CUSTOM_METRIC_INVALID` - `MIN_EQUALS_MAX` - `MISSING_CUSTOM_METRIC_DATA_POINTS` - `MISSING_LOAD_BALANCING_DATA_POINTS` - `MODE_OFF` - `MODE_ONLY_UP` - `MORE_THAN_ONE_BACKEND_SERVICE` - `NOT_ENOUGH_QUOTA_AVAILABLE` - `REGION_RESOURCE_STOCKOUT` - `SCALING_TARGET_DOES_NOT_EXIST` - `UNKNOWN` - `UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION` - `ZONE_RESOURCE_STOCKOUT`	The type of error, warning, or notice returned. Current set of possible values: ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. The autoscaler can add instances but not remove any. MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.
`message`	string	The status message.


                        status

string
Allowed values:
- ACTIVE
- DELETING
- ERROR
- PENDING

[Output Only] The status of the autoscaler configuration. Current set of possible values:

PENDING: Autoscaler backend hasn't read new/updated configuration.
DELETING: Configuration is being deleted.
ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field.
ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.


                        selfLink

string

[Output Only] Server-defined URL for the resource.


                        region

string

[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).


                        recommendedSize

integer

[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction.


                        name

string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

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.


                        kind

string
Default value: compute#autoscaler

[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

id

string

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


                        description

string

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


                        creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.


                        autoscalingPolicy

AutoscalingPolicy

The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.

If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.


                        AutoscalingPolicy

object

Cloud Autoscaler policy.

Properties

`mode`	string Allowed values: - `OFF` - `ON` - `ONLY_UP`	Defines operating mode for this policy.
`minNumReplicas`	integer	The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
`maxNumReplicas`	integer	The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
`loadBalancingUtilization`	AutoscalingPolicyLoadBalancingUtilization	Configuration parameters of autoscaling based on load balancer.
`customMetricUtilizations`	array [AutoscalingPolicyCustomMetricUtilization]	Configuration parameters of autoscaling based on a custom metric.
`cpuUtilization`	AutoscalingPolicyCpuUtilization	Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
`coolDownPeriodSec`	integer	The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

POST

/{project}/zones/{zone}/autoscalers

Creates an autoscaler in the specified project using the data included in the request.

Request

Path

Name	Data Type	Description
`zone`	string	Name of the zone for this request.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Body

Name Data Type Description

Autoscaler


                        Autoscaler

object

Represents an Autoscaler resource.

Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.

For zonal managed instance groups resource, use the autoscaler resource.

For regional managed instance groups, use the regionAutoscalers resource. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

Properties


                        zone

string

[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).


                        target

string

URL of the managed instance group that this autoscaler will scale.


                        statusDetails

array [AutoscalerStatusDetails]

[Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.

AutoscalerStatusDetails object

Properties

`type`	string Allowed values: - `ALL_INSTANCES_UNHEALTHY` - `BACKEND_SERVICE_DOES_NOT_EXIST` - `CAPPED_AT_MAX_NUM_REPLICAS` - `CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE` - `CUSTOM_METRIC_INVALID` - `MIN_EQUALS_MAX` - `MISSING_CUSTOM_METRIC_DATA_POINTS` - `MISSING_LOAD_BALANCING_DATA_POINTS` - `MODE_OFF` - `MODE_ONLY_UP` - `MORE_THAN_ONE_BACKEND_SERVICE` - `NOT_ENOUGH_QUOTA_AVAILABLE` - `REGION_RESOURCE_STOCKOUT` - `SCALING_TARGET_DOES_NOT_EXIST` - `UNKNOWN` - `UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION` - `ZONE_RESOURCE_STOCKOUT`	The type of error, warning, or notice returned. Current set of possible values: ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. The autoscaler can add instances but not remove any. MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.
`message`	string	The status message.


                        status

string
Allowed values:
- ACTIVE
- DELETING
- ERROR
- PENDING

[Output Only] The status of the autoscaler configuration. Current set of possible values:

PENDING: Autoscaler backend hasn't read new/updated configuration.
DELETING: Configuration is being deleted.
ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field.
ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.


                        selfLink

string

[Output Only] Server-defined URL for the resource.


                        region

string

[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).


                        recommendedSize

integer

[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction.


                        name

string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

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.


                        kind

string
Default value: compute#autoscaler

[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

id

string

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


                        description

string

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


                        creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.


                        autoscalingPolicy

AutoscalingPolicy

The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.

If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.


                        AutoscalingPolicy

object

Cloud Autoscaler policy.

Properties

`mode`	string Allowed values: - `OFF` - `ON` - `ONLY_UP`	Defines operating mode for this policy.
`minNumReplicas`	integer	The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
`maxNumReplicas`	integer	The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
`loadBalancingUtilization`	AutoscalingPolicyLoadBalancingUtilization	Configuration parameters of autoscaling based on load balancer.
`customMetricUtilizations`	array [AutoscalingPolicyCustomMetricUtilization]	Configuration parameters of autoscaling based on a custom metric.
`cpuUtilization`	AutoscalingPolicyCpuUtilization	Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
`coolDownPeriodSec`	integer	The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

PUT

/{project}/zones/{zone}/autoscalers

Updates an autoscaler in the specified project using the data included in the request.

Request

Path

Name	Data Type	Description
`zone`	string	Name of the zone for this request.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
`autoscaler`	string	Name of the autoscaler to update.

Body

Name Data Type Description

Autoscaler


                        Autoscaler

object

Represents an Autoscaler resource.

Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.

For zonal managed instance groups resource, use the autoscaler resource.

For regional managed instance groups, use the regionAutoscalers resource. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

Properties


                        zone

string

[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).


                        target

string

URL of the managed instance group that this autoscaler will scale.


                        statusDetails

array [AutoscalerStatusDetails]

[Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.

AutoscalerStatusDetails object

Properties

`type`	string Allowed values: - `ALL_INSTANCES_UNHEALTHY` - `BACKEND_SERVICE_DOES_NOT_EXIST` - `CAPPED_AT_MAX_NUM_REPLICAS` - `CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE` - `CUSTOM_METRIC_INVALID` - `MIN_EQUALS_MAX` - `MISSING_CUSTOM_METRIC_DATA_POINTS` - `MISSING_LOAD_BALANCING_DATA_POINTS` - `MODE_OFF` - `MODE_ONLY_UP` - `MORE_THAN_ONE_BACKEND_SERVICE` - `NOT_ENOUGH_QUOTA_AVAILABLE` - `REGION_RESOURCE_STOCKOUT` - `SCALING_TARGET_DOES_NOT_EXIST` - `UNKNOWN` - `UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION` - `ZONE_RESOURCE_STOCKOUT`	The type of error, warning, or notice returned. Current set of possible values: ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. The autoscaler can add instances but not remove any. MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.
`message`	string	The status message.


                        status

string
Allowed values:
- ACTIVE
- DELETING
- ERROR
- PENDING

[Output Only] The status of the autoscaler configuration. Current set of possible values:

PENDING: Autoscaler backend hasn't read new/updated configuration.
DELETING: Configuration is being deleted.
ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field.
ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.


                        selfLink

string

[Output Only] Server-defined URL for the resource.


                        region

string

[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).


                        recommendedSize

integer

[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction.


                        name

string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

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.


                        kind

string
Default value: compute#autoscaler

[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

id

string

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


                        description

string

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


                        creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.


                        autoscalingPolicy

AutoscalingPolicy

The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.

If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.


                        AutoscalingPolicy

object

Cloud Autoscaler policy.

Properties

`mode`	string Allowed values: - `OFF` - `ON` - `ONLY_UP`	Defines operating mode for this policy.
`minNumReplicas`	integer	The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
`maxNumReplicas`	integer	The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
`loadBalancingUtilization`	AutoscalingPolicyLoadBalancingUtilization	Configuration parameters of autoscaling based on load balancer.
`customMetricUtilizations`	array [AutoscalingPolicyCustomMetricUtilization]	Configuration parameters of autoscaling based on a custom metric.
`cpuUtilization`	AutoscalingPolicyCpuUtilization	Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
`coolDownPeriodSec`	integer	The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

POST

/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey

Adds a key for validating requests with signed URLs for this backend bucket.

Request

Path

Name	Data Type	Description
`backendBucket`	string	Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Body

Name Data Type Description

SignedUrlKey


                        SignedUrlKey

object

Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs

Properties

`keyValue`	string	128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.
`keyName`	string Pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`	Name of the key. 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.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

POST

/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey

Deletes a key for validating requests with signed URLs for this backend bucket.

Request

Path

Name	Data Type	Description
`backendBucket`	string	Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
`keyName`	string	The name of the Signed URL Key to delete.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

DELETE

/{project}/global/backendBuckets/{backendBucket}

Deletes the specified BackendBucket resource.

Request

Path

Name	Data Type	Description
`backendBucket`	string	Name of the BackendBucket resource to delete.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

GET

/{project}/global/backendBuckets/{backendBucket}

Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.

Request

Path

Name	Data Type	Description
`backendBucket`	string	Name of the BackendBucket resource to return.
`project`	string	Project ID for this request.

Responses

200Successful response

Body

Name Data Type Description

BackendBucket


                        BackendBucket

object

Represents a Cloud Storage Bucket resource.

This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.

Properties


                        selfLink

string

[Output Only] Server-defined URL for the resource.


                        name

string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

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.


                        kind

string
Default value: compute#backendBucket

Type of the resource.

id

string

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


                        enableCdn

boolean

If true, enable Cloud CDN for this BackendBucket.


                        description

string

An optional textual description of the resource; provided by the client when the resource is created.


                        creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.


                        cdnPolicy

BackendBucketCdnPolicy

Cloud CDN configuration for this BackendBucket.


                        BackendBucketCdnPolicy

object

Message containing Cloud CDN configuration for a backend bucket.

Properties

`signedUrlKeyNames`	array [string]	[Output Only] Names of the keys for signing request URLs.
`signedUrlCacheMaxAgeSec`	string	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 "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.


                        bucketName

string

Cloud Storage bucket name.

PATCH

/{project}/global/backendBuckets/{backendBucket}

Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Request

Path

Name	Data Type	Description
`backendBucket`	string	Name of the BackendBucket resource to patch.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Body

Name Data Type Description

BackendBucket


                        BackendBucket

object

Represents a Cloud Storage Bucket resource.

This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.

Properties


                        selfLink

string

[Output Only] Server-defined URL for the resource.


                        name

string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

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.


                        kind

string
Default value: compute#backendBucket

Type of the resource.

id

string

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


                        enableCdn

boolean

If true, enable Cloud CDN for this BackendBucket.


                        description

string

An optional textual description of the resource; provided by the client when the resource is created.


                        creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.


                        cdnPolicy

BackendBucketCdnPolicy

Cloud CDN configuration for this BackendBucket.


                        BackendBucketCdnPolicy

object

Message containing Cloud CDN configuration for a backend bucket.

Properties

`signedUrlKeyNames`	array [string]	[Output Only] Names of the keys for signing request URLs.
`signedUrlCacheMaxAgeSec`	string	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 "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.


                        bucketName

string

Cloud Storage bucket name.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

PUT

/{project}/global/backendBuckets/{backendBucket}

Updates the specified BackendBucket resource with the data included in the request.

Request

Path

Name	Data Type	Description
`backendBucket`	string	Name of the BackendBucket resource to update.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Body

Name Data Type Description

BackendBucket


                        BackendBucket

object

Represents a Cloud Storage Bucket resource.

This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.

Properties


                        selfLink

string

[Output Only] Server-defined URL for the resource.


                        name

string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

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.


                        kind

string
Default value: compute#backendBucket

Type of the resource.

id

string

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


                        enableCdn

boolean

If true, enable Cloud CDN for this BackendBucket.


                        description

string

An optional textual description of the resource; provided by the client when the resource is created.


                        creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.


                        cdnPolicy

BackendBucketCdnPolicy

Cloud CDN configuration for this BackendBucket.


                        BackendBucketCdnPolicy

object

Message containing Cloud CDN configuration for a backend bucket.

Properties

`signedUrlKeyNames`	array [string]	[Output Only] Names of the keys for signing request URLs.
`signedUrlCacheMaxAgeSec`	string	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 "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.


                        bucketName

string

Cloud Storage bucket name.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

GET

/{project}/global/backendBuckets

Retrieves the list of BackendBucket resources available to the specified project.

Request

Path

Name	Data Type	Description
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`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.
`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.
`maxResults`	integer Default value: `500` Minimum: 0	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)
`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).

Responses

200Successful response

Body

Name Data Type Description

BackendBucketList


                        BackendBucketList

object

Contains a list of BackendBucket resources.

Properties

warning


                        selfLink

string

[Output Only] Server-defined URL for this 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.


                        kind

string
Default value: compute#backendBucketList

Type of resource.


                        items

array [BackendBucket]

A list of BackendBucket resources.


                        BackendBucket

object

Represents a Cloud Storage Bucket resource.

This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.

Properties

`selfLink`	string	[Output Only] Server-defined URL for the resource.
`name`	string Pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`	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.
`kind`	string Default value: `compute#backendBucket`	Type of the resource.
`id`	string	[Output Only] Unique identifier for the resource; defined by the server.
`enableCdn`	boolean	If true, enable Cloud CDN for this BackendBucket.
`description`	string	An optional textual description of the resource; provided by the client when the resource is created.
`creationTimestamp`	string	[Output Only] Creation timestamp in RFC3339 text format.
`cdnPolicy`	BackendBucketCdnPolicy	Cloud CDN configuration for this BackendBucket.
`bucketName`	string	Cloud Storage bucket name.

id

string

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

POST

/{project}/global/backendBuckets

Creates a BackendBucket resource in the specified project using the data included in the request.

Request

Path

Name	Data Type	Description
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Body

Name Data Type Description

BackendBucket


                        BackendBucket

object

Represents a Cloud Storage Bucket resource.

This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.

Properties


                        selfLink

string

[Output Only] Server-defined URL for the resource.


                        name

string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

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.


                        kind

string
Default value: compute#backendBucket

Type of the resource.

id

string

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


                        enableCdn

boolean

If true, enable Cloud CDN for this BackendBucket.


                        description

string

An optional textual description of the resource; provided by the client when the resource is created.


                        creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.


                        cdnPolicy

BackendBucketCdnPolicy

Cloud CDN configuration for this BackendBucket.


                        BackendBucketCdnPolicy

object

Message containing Cloud CDN configuration for a backend bucket.

Properties

`signedUrlKeyNames`	array [string]	[Output Only] Names of the keys for signing request URLs.
`signedUrlCacheMaxAgeSec`	string	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 "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.


                        bucketName

string

Cloud Storage bucket name.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

GET

/{project}/aggregated/backendServices

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

Request

Path

Name	Data Type	Description
`project`	string	Name of the project scoping this request.

Query

Name	Data Type	Description
`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.
`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.
`maxResults`	integer Default value: `500` Minimum: 0	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)
`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).

Responses

200Successful response

Body

Name Data Type Description

BackendServiceAggregatedList


                        BackendServiceAggregatedList

object

Contains a list of BackendServicesScopedList.

Properties

`warning`
`selfLink`	string	[Output Only] Server-defined URL for this 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.
`kind`	string Default value: `compute#backendServiceAggregatedList`	Type of resource.
`items`	object	A list of BackendServicesScopedList resources.
`id`	string	[Output Only] Unique identifier for the resource; defined by the server.

POST

/{project}/global/backendServices/{backendService}/addSignedUrlKey

Adds a key for validating requests with signed URLs for this backend service.

Request

Path

Name	Data Type	Description
`backendService`	string	Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Body

Name Data Type Description

SignedUrlKey


                        SignedUrlKey

object

Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs

Properties

`keyValue`	string	128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.
`keyName`	string Pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`	Name of the key. 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.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

POST

/{project}/global/backendServices/{backendService}/deleteSignedUrlKey

Deletes a key for validating requests with signed URLs for this backend service.

Request

Path

Name	Data Type	Description
`backendService`	string	Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
`keyName`	string	The name of the Signed URL Key to delete.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

POST

/{project}/global/backendServices/{backendService}/getHealth

Gets the most recent health check results for this BackendService.

Request

Path

Name	Data Type	Description
`backendService`	string	Name of the BackendService resource to which the queried instance belongs.
`project`	string

Body

Name Data Type Description

ResourceGroupReference

ResourceGroupReference object

Properties


                        group

string

A URI referencing one of the instance groups or network endpoint groups listed in the backend service.

Responses

200Successful response

Body

Name Data Type Description

BackendServiceGroupHealth

BackendServiceGroupHealth object

Properties


                        kind

string
Default value: compute#backendServiceGroupHealth

[Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.


                        healthStatus

array [HealthStatus]

Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks.

HealthStatus object

Properties

`port`	integer	The port on the instance.
`ipAddress`	string	The IP address represented by this resource.
`instance`	string	URL of the instance resource.
`healthState`	string Allowed values: - `HEALTHY` - `UNHEALTHY`	Health state of the instance.

POST

/{project}/global/backendServices/{backendService}/setSecurityPolicy

Sets the security policy for the specified backend service.

Request

Path

Name	Data Type	Description
`backendService`	string	Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Body

Name Data Type Description

SecurityPolicyReference

SecurityPolicyReference object

Properties

securityPolicy string

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

DELETE

/{project}/global/backendServices/{backendService}

Deletes the specified BackendService resource.

Request

Path

Name	Data Type	Description
`backendService`	string	Name of the BackendService resource to delete.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

GET

/{project}/global/backendServices/{backendService}

Returns the specified BackendService resource. Gets a list of available backend services.

Request

Path

Name	Data Type	Description
`backendService`	string	Name of the BackendService resource to return.
`project`	string	Project ID for this request.

Responses

200Successful response

Body

Name Data Type Description

BackendService


                        BackendService

object

Represents a Backend Service resource.

A backend service contains configuration values for Google Cloud Platform load balancing services.

For more information, read Backend Services.

(== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Properties


                        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.


                        sessionAffinity

string
Allowed values:
- CLIENT_IP
- CLIENT_IP_PORT_PROTO
- CLIENT_IP_PROTO
- GENERATED_COOKIE
- HEADER_FIELD
- HTTP_COOKIE
- NONE

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. You can use GENERATED_COOKIE 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, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.


                        selfLink

string

[Output Only] Server-defined URL for the resource.


                        securityPolicy

string

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


                        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.


                        protocol

string
Allowed values:
- HTTP
- HTTP2
- HTTPS
- SSL
- TCP
- UDP

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.


                        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).


                        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).


                        outlierDetection

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:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.


                        OutlierDetection

object

Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.

Properties

`successRateStdevFactor`	integer	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 * success_rate_stdev_factor). 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.
`successRateRequestVolume`	integer	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.
`successRateMinimumHosts`	integer	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.
`maxEjectionPercent`	integer	Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.
`interval`	Duration	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.
`enforcingSuccessRate`	integer	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.
`enforcingConsecutiveGatewayFailure`	integer	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.
`enforcingConsecutiveErrors`	integer	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.
`consecutiveGatewayFailure`	integer	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.
`consecutiveErrors`	integer	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.
`baseEjectionTime`	Duration	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.


                        name

string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

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.


                        localityLbPolicy

string
Allowed values:
- INVALID_LB_POLICY
- LEAST_REQUEST
- MAGLEV
- ORIGINAL_DESTINATION
- RANDOM
- RING_HASH
- ROUND_ROBIN

The load balancing algorithm used within the scope of the locality. The possible values are:

ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.
LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.
RANDOM: The load balancer selects a random healthy host.
ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.
MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824

This field is applicable to either:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect.


                        loadBalancingScheme

string
Allowed values:
- EXTERNAL
- INTERNAL
- INTERNAL_MANAGED
- INTERNAL_SELF_MANAGED
- INVALID_LOAD_BALANCING_SCHEME

Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer.


                        kind

string
Default value: compute#backendService

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

id

string

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

iap BackendServiceIAP


                        BackendServiceIAP

object

Identity-Aware Proxy

Properties

`oauth2ClientSecretSha256`	string	[Output Only] SHA256 hash value for the field oauth2_client_secret above.
`oauth2ClientSecret`	string
`oauth2ClientId`	string
`enabled`	boolean


                        healthChecks

array [string]

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.


                        fingerprint

byte

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.


                        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.


                        description

string

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


                        customRequestHeaders

array [string]

Headers that the HTTP/S load balancer should add to proxied requests.


                        creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.


                        consistentHash

ConsistentHashLoadBalancerSettings

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 localityLbPolicy is set to MAGLEV or RING_HASH.

This field is applicable to either:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.


                        ConsistentHashLoadBalancerSettings

object

This message defines settings for a consistent hash style load balancer.

Properties

`minimumRingSize`	string	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.
`httpHeaderName`	string	The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
`httpCookie`	ConsistentHashLoadBalancerSettingsHttpCookie	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 sessionAffinity is set to HTTP_COOKIE.

connectionDraining ConnectionDraining


                        ConnectionDraining

object

Message containing connection draining configuration.

Properties


                        drainingTimeoutSec

integer

The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600].


                        circuitBreakers

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:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.


                        CircuitBreakers

object

Settings controlling the volume of connections to a backend service.

Properties

`maxRetries`	integer	The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1.
`maxRequestsPerConnection`	integer	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.
`maxRequests`	integer	The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
`maxPendingRequests`	integer	The maximum number of pending requests allowed to the backend service. If not specified, there is no limit.
`maxConnections`	integer	The maximum number of connections to the backend service. If not specified, there is no limit.


                        cdnPolicy

BackendServiceCdnPolicy

Cloud CDN configuration for this BackendService.


                        BackendServiceCdnPolicy

object

Message containing Cloud CDN configuration for a backend service.

Properties

`signedUrlKeyNames`	array [string]	[Output Only] Names of the keys for signing request URLs.
`signedUrlCacheMaxAgeSec`	string	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 "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
`cacheKeyPolicy`	CacheKeyPolicy	The CacheKeyPolicy for this CdnPolicy.


                        backends

array [Backend]

The list of backends that serve this BackendService.


                        Backend

object

Message containing information of one individual backend.

Properties

`maxUtilization`	float	Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION. This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance.
`maxRatePerInstance`	float	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 balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint. Not available if the backend's balancingMode is CONNECTION.
`maxRatePerEndpoint`	float	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 balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance. Not available if the backend's balancingMode is CONNECTION.
`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.
`maxConnectionsPerInstance`	integer	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 balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.
`maxConnectionsPerEndpoint`	integer	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 balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.
`maxConnections`	integer	Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION.
`group`	string	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 loadBalancingScheme. When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
`description`	string	An optional description of this resource. Provide this property when you create the resource.
`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.
`balancingMode`	string Allowed values: - `CONNECTION` - `RATE` - `UTILIZATION`	Specifies the balancing mode for the backend. When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG). If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle. You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP. If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters. If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS). You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint. If the load balancing mode is UTILIZATION, the load is spread based on the CPU utilization of instances in an instance group. You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.


                        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).

PATCH

/{project}/global/backendServices/{backendService}

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.

Request

Path

Name	Data Type	Description
`backendService`	string	Name of the BackendService resource to patch.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Body

Name Data Type Description

BackendService


                        BackendService

object

Represents a Backend Service resource.

A backend service contains configuration values for Google Cloud Platform load balancing services.

For more information, read Backend Services.

(== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Properties


                        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.


                        sessionAffinity

string
Allowed values:
- CLIENT_IP
- CLIENT_IP_PORT_PROTO
- CLIENT_IP_PROTO
- GENERATED_COOKIE
- HEADER_FIELD
- HTTP_COOKIE
- NONE

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. You can use GENERATED_COOKIE 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, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.


                        selfLink

string

[Output Only] Server-defined URL for the resource.


                        securityPolicy

string

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


                        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.


                        protocol

string
Allowed values:
- HTTP
- HTTP2
- HTTPS
- SSL
- TCP
- UDP

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.


                        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).


                        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).


                        outlierDetection

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:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.


                        OutlierDetection

object

Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.

Properties

`successRateStdevFactor`	integer	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 * success_rate_stdev_factor). 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.
`successRateRequestVolume`	integer	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.
`successRateMinimumHosts`	integer	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.
`maxEjectionPercent`	integer	Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.
`interval`	Duration	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.
`enforcingSuccessRate`	integer	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.
`enforcingConsecutiveGatewayFailure`	integer	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.
`enforcingConsecutiveErrors`	integer	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.
`consecutiveGatewayFailure`	integer	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.
`consecutiveErrors`	integer	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.
`baseEjectionTime`	Duration	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.


                        name

string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

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.


                        localityLbPolicy

string
Allowed values:
- INVALID_LB_POLICY
- LEAST_REQUEST
- MAGLEV
- ORIGINAL_DESTINATION
- RANDOM
- RING_HASH
- ROUND_ROBIN

The load balancing algorithm used within the scope of the locality. The possible values are:

ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.
LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.
RANDOM: The load balancer selects a random healthy host.
ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.
MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824

This field is applicable to either:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect.


                        loadBalancingScheme

string
Allowed values:
- EXTERNAL
- INTERNAL
- INTERNAL_MANAGED
- INTERNAL_SELF_MANAGED
- INVALID_LOAD_BALANCING_SCHEME

Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer.


                        kind

string
Default value: compute#backendService

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

id

string

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

iap BackendServiceIAP


                        BackendServiceIAP

object

Identity-Aware Proxy

Properties

`oauth2ClientSecretSha256`	string	[Output Only] SHA256 hash value for the field oauth2_client_secret above.
`oauth2ClientSecret`	string
`oauth2ClientId`	string
`enabled`	boolean


                        healthChecks

array [string]

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.


                        fingerprint

byte

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.


                        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.


                        description

string

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


                        customRequestHeaders

array [string]

Headers that the HTTP/S load balancer should add to proxied requests.


                        creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.


                        consistentHash

ConsistentHashLoadBalancerSettings

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 localityLbPolicy is set to MAGLEV or RING_HASH.

This field is applicable to either:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.


                        ConsistentHashLoadBalancerSettings

object

This message defines settings for a consistent hash style load balancer.

Properties

`minimumRingSize`	string	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.
`httpHeaderName`	string	The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
`httpCookie`	ConsistentHashLoadBalancerSettingsHttpCookie	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 sessionAffinity is set to HTTP_COOKIE.

connectionDraining ConnectionDraining


                        ConnectionDraining

object

Message containing connection draining configuration.

Properties


                        drainingTimeoutSec

integer

The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600].


                        circuitBreakers

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:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.


                        CircuitBreakers

object

Settings controlling the volume of connections to a backend service.

Properties

`maxRetries`	integer	The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1.
`maxRequestsPerConnection`	integer	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.
`maxRequests`	integer	The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
`maxPendingRequests`	integer	The maximum number of pending requests allowed to the backend service. If not specified, there is no limit.
`maxConnections`	integer	The maximum number of connections to the backend service. If not specified, there is no limit.


                        cdnPolicy

BackendServiceCdnPolicy

Cloud CDN configuration for this BackendService.


                        BackendServiceCdnPolicy

object

Message containing Cloud CDN configuration for a backend service.

Properties

`signedUrlKeyNames`	array [string]	[Output Only] Names of the keys for signing request URLs.
`signedUrlCacheMaxAgeSec`	string	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 "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
`cacheKeyPolicy`	CacheKeyPolicy	The CacheKeyPolicy for this CdnPolicy.


                        backends

array [Backend]

The list of backends that serve this BackendService.


                        Backend

object

Message containing information of one individual backend.

Properties

`maxUtilization`	float	Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION. This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance.
`maxRatePerInstance`	float	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 balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint. Not available if the backend's balancingMode is CONNECTION.
`maxRatePerEndpoint`	float	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 balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance. Not available if the backend's balancingMode is CONNECTION.
`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.
`maxConnectionsPerInstance`	integer	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 balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.
`maxConnectionsPerEndpoint`	integer	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 balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.
`maxConnections`	integer	Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION.
`group`	string	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 loadBalancingScheme. When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
`description`	string	An optional description of this resource. Provide this property when you create the resource.
`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.
`balancingMode`	string Allowed values: - `CONNECTION` - `RATE` - `UTILIZATION`	Specifies the balancing mode for the backend. When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG). If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle. You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP. If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters. If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS). You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint. If the load balancing mode is UTILIZATION, the load is spread based on the CPU utilization of instances in an instance group. You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.


                        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).

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

PUT

/{project}/global/backendServices/{backendService}

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.

Request

Path

Name	Data Type	Description
`backendService`	string	Name of the BackendService resource to update.
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Body

Name Data Type Description

BackendService


                        BackendService

object

Represents a Backend Service resource.

A backend service contains configuration values for Google Cloud Platform load balancing services.

For more information, read Backend Services.

(== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Properties


                        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.


                        sessionAffinity

string
Allowed values:
- CLIENT_IP
- CLIENT_IP_PORT_PROTO
- CLIENT_IP_PROTO
- GENERATED_COOKIE
- HEADER_FIELD
- HTTP_COOKIE
- NONE

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. You can use GENERATED_COOKIE 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, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.


                        selfLink

string

[Output Only] Server-defined URL for the resource.


                        securityPolicy

string

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


                        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.


                        protocol

string
Allowed values:
- HTTP
- HTTP2
- HTTPS
- SSL
- TCP
- UDP

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.


                        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).


                        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).


                        outlierDetection

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:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.


                        OutlierDetection

object

Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.

Properties

`successRateStdevFactor`	integer	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 * success_rate_stdev_factor). 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.
`successRateRequestVolume`	integer	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.
`successRateMinimumHosts`	integer	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.
`maxEjectionPercent`	integer	Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.
`interval`	Duration	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.
`enforcingSuccessRate`	integer	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.
`enforcingConsecutiveGatewayFailure`	integer	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.
`enforcingConsecutiveErrors`	integer	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.
`consecutiveGatewayFailure`	integer	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.
`consecutiveErrors`	integer	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.
`baseEjectionTime`	Duration	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.


                        name

string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

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.


                        localityLbPolicy

string
Allowed values:
- INVALID_LB_POLICY
- LEAST_REQUEST
- MAGLEV
- ORIGINAL_DESTINATION
- RANDOM
- RING_HASH
- ROUND_ROBIN

The load balancing algorithm used within the scope of the locality. The possible values are:

ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.
LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.
RANDOM: The load balancer selects a random healthy host.
ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.
MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824

This field is applicable to either:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect.


                        loadBalancingScheme

string
Allowed values:
- EXTERNAL
- INTERNAL
- INTERNAL_MANAGED
- INTERNAL_SELF_MANAGED
- INVALID_LOAD_BALANCING_SCHEME

Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer.


                        kind

string
Default value: compute#backendService

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

id

string

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

iap BackendServiceIAP


                        BackendServiceIAP

object

Identity-Aware Proxy

Properties

`oauth2ClientSecretSha256`	string	[Output Only] SHA256 hash value for the field oauth2_client_secret above.
`oauth2ClientSecret`	string
`oauth2ClientId`	string
`enabled`	boolean


                        healthChecks

array [string]

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.


                        fingerprint

byte

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.


                        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.


                        description

string

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


                        customRequestHeaders

array [string]

Headers that the HTTP/S load balancer should add to proxied requests.


                        creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.


                        consistentHash

ConsistentHashLoadBalancerSettings

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 localityLbPolicy is set to MAGLEV or RING_HASH.

This field is applicable to either:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.


                        ConsistentHashLoadBalancerSettings

object

This message defines settings for a consistent hash style load balancer.

Properties

`minimumRingSize`	string	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.
`httpHeaderName`	string	The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
`httpCookie`	ConsistentHashLoadBalancerSettingsHttpCookie	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 sessionAffinity is set to HTTP_COOKIE.

connectionDraining ConnectionDraining


                        ConnectionDraining

object

Message containing connection draining configuration.

Properties


                        drainingTimeoutSec

integer

The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600].


                        circuitBreakers

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:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.


                        CircuitBreakers

object

Settings controlling the volume of connections to a backend service.

Properties

`maxRetries`	integer	The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1.
`maxRequestsPerConnection`	integer	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.
`maxRequests`	integer	The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
`maxPendingRequests`	integer	The maximum number of pending requests allowed to the backend service. If not specified, there is no limit.
`maxConnections`	integer	The maximum number of connections to the backend service. If not specified, there is no limit.


                        cdnPolicy

BackendServiceCdnPolicy

Cloud CDN configuration for this BackendService.


                        BackendServiceCdnPolicy

object

Message containing Cloud CDN configuration for a backend service.

Properties

`signedUrlKeyNames`	array [string]	[Output Only] Names of the keys for signing request URLs.
`signedUrlCacheMaxAgeSec`	string	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 "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
`cacheKeyPolicy`	CacheKeyPolicy	The CacheKeyPolicy for this CdnPolicy.


                        backends

array [Backend]

The list of backends that serve this BackendService.


                        Backend

object

Message containing information of one individual backend.

Properties

`maxUtilization`	float	Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION. This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance.
`maxRatePerInstance`	float	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 balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint. Not available if the backend's balancingMode is CONNECTION.
`maxRatePerEndpoint`	float	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 balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance. Not available if the backend's balancingMode is CONNECTION.
`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.
`maxConnectionsPerInstance`	integer	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 balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.
`maxConnectionsPerEndpoint`	integer	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 balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.
`maxConnections`	integer	Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION.
`group`	string	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 loadBalancingScheme. When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
`description`	string	An optional description of this resource. Provide this property when you create the resource.
`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.
`balancingMode`	string Allowed values: - `CONNECTION` - `RATE` - `UTILIZATION`	Specifies the balancing mode for the backend. When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG). If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle. You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP. If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters. If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS). You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint. If the load balancing mode is UTILIZATION, the load is spread based on the CPU utilization of instances in an instance group. You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.


                        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).

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

GET

/{project}/global/backendServices

Retrieves the list of BackendService resources available to the specified project.

Request

Path

Name	Data Type	Description
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`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.
`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.
`maxResults`	integer Default value: `500` Minimum: 0	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)
`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).

Responses

200Successful response

Body

Name Data Type Description

BackendServiceList


                        BackendServiceList

object

Contains a list of BackendService resources.

Properties

warning


                        selfLink

string

[Output Only] Server-defined URL for this 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.


                        kind

string
Default value: compute#backendServiceList

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


                        items

array [BackendService]

A list of BackendService resources.


                        BackendService

object

Represents a Backend Service resource.

A backend service contains configuration values for Google Cloud Platform load balancing services.

For more information, read Backend Services.

(== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Properties

`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.
`sessionAffinity`	string Allowed values: - `CLIENT_IP` - `CLIENT_IP_PORT_PROTO` - `CLIENT_IP_PROTO` - `GENERATED_COOKIE` - `HEADER_FIELD` - `HTTP_COOKIE` - `NONE`	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. You can use GENERATED_COOKIE 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, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`securityPolicy`	string	[Output Only] The resource URL for the security policy associated with this backend service.
`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.
`protocol`	string Allowed values: - `HTTP` - `HTTP2` - `HTTPS` - `SSL` - `TCP` - `UDP`	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.
`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).
`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).
`outlierDetection`	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: A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
`name`	string Pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`	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.
`localityLbPolicy`	string Allowed values: - `INVALID_LB_POLICY` - `LEAST_REQUEST` - `MAGLEV` - `ORIGINAL_DESTINATION` - `RANDOM` - `RING_HASH` - `ROUND_ROBIN`	The load balancing algorithm used within the scope of the locality. The possible values are: ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. RANDOM: The load balancer selects a random healthy host. ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 This field is applicable to either: A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect.
`loadBalancingScheme`	string Allowed values: - `EXTERNAL` - `INTERNAL` - `INTERNAL_MANAGED` - `INTERNAL_SELF_MANAGED` - `INVALID_LOAD_BALANCING_SCHEME`	Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer.
`kind`	string Default value: `compute#backendService`	[Output Only] Type of resource. Always compute#backendService for backend services.
`id`	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`iap`	BackendServiceIAP
`healthChecks`	array [string]	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.
`fingerprint`	byte	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.
`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.
`description`	string	An optional description of this resource. Provide this property when you create the resource.
`customRequestHeaders`	array [string]	Headers that the HTTP/S load balancer should add to proxied requests.
`creationTimestamp`	string	[Output Only] Creation timestamp in RFC3339 text format.
`consistentHash`	ConsistentHashLoadBalancerSettings	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 localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
`connectionDraining`	ConnectionDraining
`circuitBreakers`	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: A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
`cdnPolicy`	BackendServiceCdnPolicy	Cloud CDN configuration for this BackendService.
`backends`	array [Backend]	The list of backends that serve this BackendService.
`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).

id

string

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

POST

/{project}/global/backendServices

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.

Request

Path

Name	Data Type	Description
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`requestId`	string	An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Body

Name Data Type Description

BackendService


                        BackendService

object

Represents a Backend Service resource.

A backend service contains configuration values for Google Cloud Platform load balancing services.

For more information, read Backend Services.

(== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Properties


                        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.


                        sessionAffinity

string
Allowed values:
- CLIENT_IP
- CLIENT_IP_PORT_PROTO
- CLIENT_IP_PROTO
- GENERATED_COOKIE
- HEADER_FIELD
- HTTP_COOKIE
- NONE

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. You can use GENERATED_COOKIE 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, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.


                        selfLink

string

[Output Only] Server-defined URL for the resource.


                        securityPolicy

string

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


                        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.


                        protocol

string
Allowed values:
- HTTP
- HTTP2
- HTTPS
- SSL
- TCP
- UDP

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.


                        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).


                        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).


                        outlierDetection

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:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.


                        OutlierDetection

object

Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.

Properties

`successRateStdevFactor`	integer	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 * success_rate_stdev_factor). 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.
`successRateRequestVolume`	integer	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.
`successRateMinimumHosts`	integer	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.
`maxEjectionPercent`	integer	Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.
`interval`	Duration	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.
`enforcingSuccessRate`	integer	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.
`enforcingConsecutiveGatewayFailure`	integer	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.
`enforcingConsecutiveErrors`	integer	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.
`consecutiveGatewayFailure`	integer	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.
`consecutiveErrors`	integer	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.
`baseEjectionTime`	Duration	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.


                        name

string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

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.


                        localityLbPolicy

string
Allowed values:
- INVALID_LB_POLICY
- LEAST_REQUEST
- MAGLEV
- ORIGINAL_DESTINATION
- RANDOM
- RING_HASH
- ROUND_ROBIN

The load balancing algorithm used within the scope of the locality. The possible values are:

ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.
LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.
RANDOM: The load balancer selects a random healthy host.
ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.
MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824

This field is applicable to either:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect.


                        loadBalancingScheme

string
Allowed values:
- EXTERNAL
- INTERNAL
- INTERNAL_MANAGED
- INTERNAL_SELF_MANAGED
- INVALID_LOAD_BALANCING_SCHEME

Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer.


                        kind

string
Default value: compute#backendService

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

id

string

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

iap BackendServiceIAP


                        BackendServiceIAP

object

Identity-Aware Proxy

Properties

`oauth2ClientSecretSha256`	string	[Output Only] SHA256 hash value for the field oauth2_client_secret above.
`oauth2ClientSecret`	string
`oauth2ClientId`	string
`enabled`	boolean


                        healthChecks

array [string]

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.


                        fingerprint

byte

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.


                        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.


                        description

string

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


                        customRequestHeaders

array [string]

Headers that the HTTP/S load balancer should add to proxied requests.


                        creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.


                        consistentHash

ConsistentHashLoadBalancerSettings

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 localityLbPolicy is set to MAGLEV or RING_HASH.

This field is applicable to either:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.


                        ConsistentHashLoadBalancerSettings

object

This message defines settings for a consistent hash style load balancer.

Properties

`minimumRingSize`	string	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.
`httpHeaderName`	string	The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
`httpCookie`	ConsistentHashLoadBalancerSettingsHttpCookie	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 sessionAffinity is set to HTTP_COOKIE.

connectionDraining ConnectionDraining


                        ConnectionDraining

object

Message containing connection draining configuration.

Properties


                        drainingTimeoutSec

integer

The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600].


                        circuitBreakers

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:

A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.


                        CircuitBreakers

object

Settings controlling the volume of connections to a backend service.

Properties

`maxRetries`	integer	The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1.
`maxRequestsPerConnection`	integer	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.
`maxRequests`	integer	The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
`maxPendingRequests`	integer	The maximum number of pending requests allowed to the backend service. If not specified, there is no limit.
`maxConnections`	integer	The maximum number of connections to the backend service. If not specified, there is no limit.


                        cdnPolicy

BackendServiceCdnPolicy

Cloud CDN configuration for this BackendService.


                        BackendServiceCdnPolicy

object

Message containing Cloud CDN configuration for a backend service.

Properties

`signedUrlKeyNames`	array [string]	[Output Only] Names of the keys for signing request URLs.
`signedUrlCacheMaxAgeSec`	string	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 "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
`cacheKeyPolicy`	CacheKeyPolicy	The CacheKeyPolicy for this CdnPolicy.


                        backends

array [Backend]

The list of backends that serve this BackendService.


                        Backend

object

Message containing information of one individual backend.

Properties

`maxUtilization`	float	Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION. This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance.
`maxRatePerInstance`	float	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 balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint. Not available if the backend's balancingMode is CONNECTION.
`maxRatePerEndpoint`	float	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 balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance. Not available if the backend's balancingMode is CONNECTION.
`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.
`maxConnectionsPerInstance`	integer	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 balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.
`maxConnectionsPerEndpoint`	integer	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 balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.
`maxConnections`	integer	Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION.
`group`	string	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 loadBalancingScheme. When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
`description`	string	An optional description of this resource. Provide this property when you create the resource.
`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.
`balancingMode`	string Allowed values: - `CONNECTION` - `RATE` - `UTILIZATION`	Specifies the balancing mode for the backend. When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG). If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle. You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP. If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters. If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS). You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint. If the load balancing mode is UTILIZATION, the load is spread based on the CPU utilization of instances in an instance group. You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.


                        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).

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For global operations, use the globalOperations resource.
For regional operations, use the regionOperations resource.
For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Properties

`zone`	string	[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`warnings`	array [object]	[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`user`	string	[Output Only] User who requested the operation, for example: user@example.com.
`targetLink`	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	string	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`statusMessage`	string	[Output Only] An optional textual description of the current status of the operation.
`status`	string Allowed values: - `DONE` - `PENDING` - `RUNNING`	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
`startTime`	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`selfLink`	string	[Output Only] Server-defined URL for the resource.
`region`	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`progress`	integer	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`operationType`	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
`name`	string	[Output Only] Name of the operation.
`kind`	string Default value: `compute#operation`	[Output Only] Type of the resource. Always compute#operation for Operation resources.
`insertTime`	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`id`	string	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
`httpErrorStatusCode`	integer	[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
`httpErrorMessage`	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
`error`
`endTime`	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`description`	string	[Output Only] A textual description of the operation, which is set when the operation is created.
`creationTimestamp`	string	[Deprecated] This field is deprecated.
`clientOperationId`	string	[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

GET

/{project}/aggregated/diskTypes

Retrieves an aggregated list of disk types.

Request

Path

Name	Data Type	Description
`project`	string	Project ID for this request.

Query

Name	Data Type	Description
`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.
`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.
`maxResults`	integer Default value: `500` Minimum: 0	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)
`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).

Responses

200Successful response