- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Updates the specified BackendBucket resource with the data included in the request.
HTTP request
PUT https://compute.googleapis.com/compute/beta/projects/{project}/global/backendBuckets/{backendBucket}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
backend |
Name of the BackendBucket resource to update. |
Query parameters
Parameters | |
---|---|
request |
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 ( |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "selfLink": string, "bucketName": string, "enableCdn": boolean, "cdnPolicy": { "signedUrlKeyNames": [ string ], "signedUrlCacheMaxAgeSec": string, "requestCoalescing": boolean, "cacheMode": enum, "defaultTtl": integer, "maxTtl": integer, "clientTtl": integer, "negativeCaching": boolean, "negativeCachingPolicy": [ { "code": integer, "ttl": integer } ], "bypassCacheOnRequestHeaders": [ { "headerName": string } ], "serveWhileStale": integer, "cacheKeyPolicy": { "queryStringWhitelist": [ string ], "includeHttpHeaders": [ string ] } }, "customResponseHeaders": [ string ], "edgeSecurityPolicy": string, "compressionMode": enum, "loadBalancingScheme": enum, "usedBy": [ { "reference": string } ] } |
Fields | |
---|---|
kind |
Type of the resource. |
id |
[Output Only] Unique identifier for the resource; defined by the server. |
creation |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression |
description |
An optional textual description of the resource; provided by the client when the resource is created. |
self |
[Output Only] Server-defined URL for the resource. |
bucket |
Cloud Storage bucket name. |
enable |
If true, enable Cloud CDN for this |
cdn |
Cloud CDN configuration for this |
cdn |
[Output Only] Names of the keys for signing request URLs. |
cdn |
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 |
cdn |
If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin. |
cdn |
Specifies the cache setting for all responses from this backend. The possible values are: If no value is provided for |
cdn |
Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to |
cdn |
Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. |
cdn |
Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of clientTtl and defaultTtl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, clientTtl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the clientTtl and defaultTtl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year). |
cdn |
Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negativeCachingPolicy. |
cdn |
Sets a cache TTL for the specified HTTP status code. negativeCaching must be enabled to configure negativeCachingPolicy. Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negativeCachingPolicy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists. |
cdn |
The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once. |
cdn |
The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. |
cdn |
Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings. |
cdn |
The header field name to match on when bypassing cache. Values are case-insensitive. |
cdn |
Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. |
cdn |
The CacheKeyPolicy for this CdnPolicy. |
cdn |
Names of query string parameters to include in cache keys. Default parameters are always included. '&' and '=' will be percent encoded and not treated as delimiters. |
cdn |
Allows HTTP request headers (by name) to be used in the cache key. |
custom |
Headers that the Application Load Balancer should add to proxied responses. |
edge |
[Output Only] The resource URL for the edge security policy associated with this backend bucket. |
compression |
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. |
load |
The value can only be INTERNAL_MANAGED for cross-region internal layer 7 load balancer. If loadBalancingScheme is not specified, the backend bucket can be used by classic global external load balancers, or global application external load balancers, or both. |
used |
[Output Only] backendBuckets.list of resources referencing that backend bucket. |
used |
[Output Only] Server-defined URL for UrlMaps referencing that BackendBucket. |
Response body
Represents an Operation resource.
Google Compute Engine has three Operation resources:
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
zoneOperations
resource.
For more information, read Global, Regional, and Zonal Resources.
Note that completed Operation resources have a limited retention period.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "zone": string, "clientOperationId": string, "operationType": string, "targetLink": string, "targetId": string, "status": enum, "statusMessage": string, "user": string, "progress": integer, "insertTime": string, "startTime": string, "endTime": string, "error": { "errors": [ { "code": string, "location": string, "message": string, "errorDetails": [ { "errorInfo": { "reason": string, "domain": string, "metadatas": { string: string, ... } }, "quotaInfo": { "metricName": string, "limitName": string, "dimensions": { string: string, ... }, "limit": number, "futureLimit": number, "rolloutStatus": enum }, "help": { "links": [ { "description": string, "url": string } ] }, "localizedMessage": { "locale": string, "message": string } } ] } ] }, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "httpErrorStatusCode": integer, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "operationGroupId": string, // Union field |
Fields | |
---|---|
kind |
[Output Only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the operation. This identifier is defined by the server. |
creation |
[Deprecated] This field is deprecated. |
name |
[Output Only] Name of the operation. |
zone |
[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
client |
[Output Only] The value of |
operation |
[Output Only] The type of operation, such as |
target |
[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from. |
target |
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
status |
[Output Only] The status of the operation, which can be one of the following: |
status |
[Output Only] An optional textual description of the current status of the operation. |
user |
[Output Only] User who requested the operation, for example: |
progress |
[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. |
insert |
[Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
start |
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
end |
[Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
error |
[Output Only] If errors are generated during processing of the operation, this field will be populated. |
error. |
[Output Only] The array of errors encountered while processing this operation. |
error. |
[Output Only] The error type identifier for this error. |
error. |
[Output Only] Indicates the field in the request that caused the error. This property is optional. |
error. |
[Output Only] An optional, human-readable error message. |
error. |
[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. |
error. |
|
error. |
The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of |
error. |
The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". |
error. |
Additional structured details about this error. Keys must match /[a-z][a-zA-Z0-9-_]+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request. |
error. |
|
error. |
The Compute Engine quota metric name. |
error. |
The name of the quota limit. |
error. |
The map holding related quota dimensions. |
error. |
Current effective quota limit. The limit's unit depends on the quota type or metric. |
error. |
Future quota limit being rolled out. The limit's unit depends on the quota type or metric. |
error. |
Rollout status of the future quota limit. |
error. |
|
error. |
URL(s) pointing to additional information on handling the current error. |
error. |
Describes what the link offers. |
error. |
The URL of the link. |
error. |
|
error. |
The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" |
error. |
The localized error message in the above locale. |
warnings[] |
[Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
warnings[]. |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warnings[]. |
[Output Only] A human-readable description of the warning code. |
warnings[]. |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warnings[]. |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be |
warnings[]. |
[Output Only] A warning data value corresponding to the key. |
http |
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a |
http |
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as |
self |
[Output Only] Server-defined URL for the resource. |
region |
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
description |
[Output Only] A textual description of the operation, which is set when the operation is created. |
operation |
[Output Only] An ID that represents a group of operations, such as when a group of operations results from a |
Union field metadata . [Output Only] Service-specific metadata attached to this operation. metadata can be only one of the following: |
|
set |
[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. |
set |
[Output Only] The client operation id. |
set |
[Output Only] Status information per location (location name is key). Example key: zones/us-central1-a |
set |
[Output Only] Status of the action, which can be one of the following: |
set |
[Output Only] If state is |
set |
The status code, which should be an enum value of |
set |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the |
set |
A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing fields of an arbitrary type. An additional field |
instances |
|
instances |
Status information per location (location name is key). Example key: zones/us-central1-a |
instances |
[Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. |
instances |
[Output Only] Count of VMs originally planned to be created. |
instances |
[Output Only] Count of VMs successfully created so far. |
instances |
[Output Only] Count of VMs that started creating but encountered an error. |
instances |
[Output Only] Count of VMs that got deleted during rollback. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.backendBuckets.update
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.