- HTTP request
- Path parameters
- Query parameters
- Request body
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
HTTP request
PATCH https://compute.googleapis.com/compute/v1/projects/{project}/global/urlMaps/{urlMap}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
project |
Project ID for this request. |
url |
Name of the UrlMap resource to patch. |
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, "hostRules": [ { "description": string, "hosts": [ string ], "pathMatcher": string } ], "pathMatchers": [ { "name": string, "description": string, "defaultService": string, "defaultRouteAction": { "weightedBackendServices": [ { "backendService": string, "weight": integer, "headerAction": { "requestHeadersToRemove": [ string ], "requestHeadersToAdd": [ { "headerName": string, "headerValue": string, "replace": boolean } ], "responseHeadersToRemove": [ string ], "responseHeadersToAdd": [ { "headerName": string, "headerValue": string, "replace": boolean } ] } } ], "urlRewrite": { "pathPrefixRewrite": string, "hostRewrite": string, "pathTemplateRewrite": string }, "timeout": { "seconds": string, "nanos": integer }, "retryPolicy": { "retryConditions": [ string ], "numRetries": integer, "perTryTimeout": { "seconds": string, "nanos": integer } }, "requestMirrorPolicy": { "backendService": string }, "corsPolicy": { "allowOrigins": [ string ], "allowOriginRegexes": [ string ], "allowMethods": [ string ], "allowHeaders": [ string ], "exposeHeaders": [ string ], "maxAge": integer, "allowCredentials": boolean, "disabled": boolean }, "faultInjectionPolicy": { "delay": { "fixedDelay": { "seconds": string, "nanos": integer }, "percentage": number }, "abort": { "httpStatus": integer, "percentage": number } }, "maxStreamDuration": { "seconds": string, "nanos": integer } }, "defaultUrlRedirect": { "hostRedirect": string, "pathRedirect": string, "prefixRedirect": string, "redirectResponseCode": enum, "httpsRedirect": boolean, "stripQuery": boolean }, "pathRules": [ { "service": string, "routeAction": { "weightedBackendServices": [ { "backendService": string, "weight": integer, "headerAction": { "requestHeadersToRemove": [ string ], "requestHeadersToAdd": [ { "headerName": string, "headerValue": string, "replace": boolean } ], "responseHeadersToRemove": [ string ], "responseHeadersToAdd": [ { "headerName": string, "headerValue": string, "replace": boolean } ] } } ], "urlRewrite": { "pathPrefixRewrite": string, "hostRewrite": string, "pathTemplateRewrite": string }, "timeout": { "seconds": string, "nanos": integer }, "retryPolicy": { "retryConditions": [ string ], "numRetries": integer, "perTryTimeout": { "seconds": string, "nanos": integer } }, "requestMirrorPolicy": { "backendService": string }, "corsPolicy": { "allowOrigins": [ string ], "allowOriginRegexes": [ string ], "allowMethods": [ string ], "allowHeaders": [ string ], "exposeHeaders": [ string ], "maxAge": integer, "allowCredentials": boolean, "disabled": boolean }, "faultInjectionPolicy": { "delay": { "fixedDelay": { "seconds": string, "nanos": integer }, "percentage": number }, "abort": { "httpStatus": integer, "percentage": number } }, "maxStreamDuration": { "seconds": string, "nanos": integer } }, "urlRedirect": { "hostRedirect": string, "pathRedirect": string, "prefixRedirect": string, "redirectResponseCode": enum, "httpsRedirect": boolean, "stripQuery": boolean }, "paths": [ string ], "customErrorResponsePolicy": { "errorResponseRules": [ { "matchResponseCodes": [ string ], "path": string, "overrideResponseCode": integer } ], "errorService": string } } ], "routeRules": [ { "priority": integer, "description": string, "matchRules": [ { "prefixMatch": string, "fullPathMatch": string, "regexMatch": string, "ignoreCase": boolean, "headerMatches": [ { "headerName": string, "exactMatch": string, "regexMatch": string, "rangeMatch": { "rangeStart": string, "rangeEnd": string }, "presentMatch": boolean, "prefixMatch": string, "suffixMatch": string, "invertMatch": boolean } ], "queryParameterMatches": [ { "name": string, "presentMatch": boolean, "exactMatch": string, "regexMatch": string } ], "metadataFilters": [ { "filterMatchCriteria": enum, "filterLabels": [ { "name": string, "value": string } ] } ], "pathTemplateMatch": string } ], "service": string, "routeAction": { "weightedBackendServices": [ { "backendService": string, "weight": integer, "headerAction": { "requestHeadersToRemove": [ string ], "requestHeadersToAdd": [ { "headerName": string, "headerValue": string, "replace": boolean } ], "responseHeadersToRemove": [ string ], "responseHeadersToAdd": [ { "headerName": string, "headerValue": string, "replace": boolean } ] } } ], "urlRewrite": { "pathPrefixRewrite": string, "hostRewrite": string, "pathTemplateRewrite": string }, "timeout": { "seconds": string, "nanos": integer }, "retryPolicy": { "retryConditions": [ string ], "numRetries": integer, "perTryTimeout": { "seconds": string, "nanos": integer } }, "requestMirrorPolicy": { "backendService": string }, "corsPolicy": { "allowOrigins": [ string ], "allowOriginRegexes": [ string ], "allowMethods": [ string ], "allowHeaders": [ string ], "exposeHeaders": [ string ], "maxAge": integer, "allowCredentials": boolean, "disabled": boolean }, "faultInjectionPolicy": { "delay": { "fixedDelay": { "seconds": string, "nanos": integer }, "percentage": number }, "abort": { "httpStatus": integer, "percentage": number } }, "maxStreamDuration": { "seconds": string, "nanos": integer } }, "urlRedirect": { "hostRedirect": string, "pathRedirect": string, "prefixRedirect": string, "redirectResponseCode": enum, "httpsRedirect": boolean, "stripQuery": boolean }, "headerAction": { "requestHeadersToRemove": [ string ], "requestHeadersToAdd": [ { "headerName": string, "headerValue": string, "replace": boolean } ], "responseHeadersToRemove": [ string ], "responseHeadersToAdd": [ { "headerName": string, "headerValue": string, "replace": boolean } ] }, "customErrorResponsePolicy": { "errorResponseRules": [ { "matchResponseCodes": [ string ], "path": string, "overrideResponseCode": integer } ], "errorService": string } } ], "headerAction": { "requestHeadersToRemove": [ string ], "requestHeadersToAdd": [ { "headerName": string, "headerValue": string, "replace": boolean } ], "responseHeadersToRemove": [ string ], "responseHeadersToAdd": [ { "headerName": string, "headerValue": string, "replace": boolean } ] }, "defaultCustomErrorResponsePolicy": { "errorResponseRules": [ { "matchResponseCodes": [ string ], "path": string, "overrideResponseCode": integer } ], "errorService": string } } ], "tests": [ { "description": string, "host": string, "path": string, "headers": [ { "name": string, "value": string } ], "service": string, "expectedOutputUrl": string, "expectedRedirectResponseCode": integer } ], "defaultService": string, "defaultRouteAction": { "weightedBackendServices": [ { "backendService": string, "weight": integer, "headerAction": { "requestHeadersToRemove": [ string ], "requestHeadersToAdd": [ { "headerName": string, "headerValue": string, "replace": boolean } ], "responseHeadersToRemove": [ string ], "responseHeadersToAdd": [ { "headerName": string, "headerValue": string, "replace": boolean } ] } } ], "urlRewrite": { "pathPrefixRewrite": string, "hostRewrite": string, "pathTemplateRewrite": string }, "timeout": { "seconds": string, "nanos": integer }, "retryPolicy": { "retryConditions": [ string ], "numRetries": integer, "perTryTimeout": { "seconds": string, "nanos": integer } }, "requestMirrorPolicy": { "backendService": string }, "corsPolicy": { "allowOrigins": [ string ], "allowOriginRegexes": [ string ], "allowMethods": [ string ], "allowHeaders": [ string ], "exposeHeaders": [ string ], "maxAge": integer, "allowCredentials": boolean, "disabled": boolean }, "faultInjectionPolicy": { "delay": { "fixedDelay": { "seconds": string, "nanos": integer }, "percentage": number }, "abort": { "httpStatus": integer, "percentage": number } }, "maxStreamDuration": { "seconds": string, "nanos": integer } }, "defaultUrlRedirect": { "hostRedirect": string, "pathRedirect": string, "prefixRedirect": string, "redirectResponseCode": enum, "httpsRedirect": boolean, "stripQuery": boolean }, "headerAction": { "requestHeadersToRemove": [ string ], "requestHeadersToAdd": [ { "headerName": string, "headerValue": string, "replace": boolean } ], "responseHeadersToRemove": [ string ], "responseHeadersToAdd": [ { "headerName": string, "headerValue": string, "replace": boolean } ] }, "defaultCustomErrorResponsePolicy": { "errorResponseRules": [ { "matchResponseCodes": [ string ], "path": string, "overrideResponseCode": integer } ], "errorService": string }, "fingerprint": string, "region": string } |
| Fields | |
|---|---|
kind |
[Output Only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is 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 description of this resource. Provide this property when you create the resource. |
self |
[Output Only] Server-defined URL for the resource. |
host |
The list of host rules to use against the URL. |
host |
An optional description of this resource. Provide this property when you create the resource. |
host |
The list of host patterns to match. They must be valid hostnames with optional port numbers in the format
|
host |
The name of the |
path |
The list of named |
path |
The name to which this |
path |
An optional description of this resource. Provide this property when you create the resource. |
path |
The full or partial URL to the
defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend.Only one of Authorization requires one or more of the following Google IAM permissions on the specified resource defaultService:
Authorization requires one or more of the following IAM permissions on the specified resource
|
path |
Only one of URL maps for classic Application Load Balancers only support the |
path |
A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this |
path |
The full or partial URL to the default Authorization requires the following IAM permission on the specified resource
|
path |
Specifies the fraction of traffic sent to a backend service, computed as The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000. |
path |
Specifies changes to request and response headers that need to take effect for the selected
Not supported when the URL map is bound to a target gRPC proxy that has |
path |
A list of header names for headers that need to be removed from the request before forwarding the request to the |
path |
Headers to add to a matching request before forwarding the request to the |
path |
The name of the header. |
path |
The value of the header to add. |
path |
If The default value is |
path |
A list of header names for headers that need to be removed from the response before sending the response back to the client. |
path |
Headers to add the response before sending the response back to the client. |
path |
The name of the header. |
path |
The value of the header to add. |
path |
If The default value is |
path |
The spec to modify the URL of the request, before forwarding the request to the matched service. Not supported when the URL map is bound to a target gRPC proxy that has the |
path |
Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by The value must be from 1 to 1024 characters. |
path |
Before forwarding the request to the selected service, the request's host header is replaced with contents of The value must be from 1 to 255 characters. |
path |
If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding pathTemplateMatch must be specified. Any template variables must exist in the pathTemplateMatch field.
For example, a pathTemplateMatch of At least one non-empty Only one of |
path |
Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as end-of-stream) up until the response has been processed. Timeout includes all retries. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has |
path |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
path |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
path |
Specifies the retry policy associated with this route. |
path |
Specifies one or more conditions when this retry policy applies. Valid values are:
Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
|
path |
Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. |
path |
Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in the Not supported when the URL map is bound to a target gRPC proxy that has the |
path |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
path |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
path |
Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with Not supported when the URL map is bound to a target gRPC proxy that has the |
path |
The full or partial URL to the The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. Authorization requires the following IAM permission on the specified resource
|
path |
The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. |
path |
Specifies the list of origins that is allowed to do CORS requests. An origin is allowed if it matches either an item in |
path |
Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax . An origin is allowed if it matches either an item in Regular expressions can only be used when the loadBalancingScheme is set to |
path |
Specifies the content for the |
path |
Specifies the content for the |
path |
Specifies the content for the |
path |
Specifies how long results of a preflight request can be cached in seconds. This field translates to the |
path |
In response to a preflight request, setting this to Default is |
path |
If |
path |
The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. |
path |
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. |
path |
Specifies the value of the fixed delay interval. |
path |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
path |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
path |
The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive. |
path |
The specification for how client requests are aborted as part of fault injection. |
path |
The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director. |
path |
The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive. |
path |
Specifies the maximum duration (timeout) for streams on the selected route. Unlike the If not specified, this field uses the maximum This field is only allowed if the Url map is used with backend services with |
path |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
path |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
path |
When none of the specified Only one of Not supported when the URL map is bound to a target gRPC proxy. |
path |
The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. |
path |
The path that is used in the redirect response instead of the one that was supplied in the request.
The value must be from 1 to 1024 characters. |
path |
The prefix that replaces the
The value must be from 1 to 1024 characters. |
path |
The HTTP Status code to use for this RedirectAction. Supported values are:
|
path |
If set to This must only be set for URL maps used in The default is set to |
path |
If set to The default is set to |
path |
The list of path rules. Use this list instead of For example: a Within a given |
path |
The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If Only one of Authorization requires one or more of the following IAM permissions on the specified resource
|
path |
In response to a matching Only one of URL maps for classic Application Load Balancers only support the |
path |
A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this |
path |
The full or partial URL to the default Authorization requires the following IAM permission on the specified resource
|
path |
Specifies the fraction of traffic sent to a backend service, computed as The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000. |
path |
Specifies changes to request and response headers that need to take effect for the selected
Not supported when the URL map is bound to a target gRPC proxy that has |
path |
A list of header names for headers that need to be removed from the request before forwarding the request to the |
path |
Headers to add to a matching request before forwarding the request to the |
path |
The name of the header. |
path |
The value of the header to add. |
path |
If The default value is |
path |
A list of header names for headers that need to be removed from the response before sending the response back to the client. |
path |
Headers to add the response before sending the response back to the client. |
path |
The name of the header. |
path |
The value of the header to add. |
path |
If The default value is |
path |
The spec to modify the URL of the request, before forwarding the request to the matched service. Not supported when the URL map is bound to a target gRPC proxy that has the |
path |
Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by The value must be from 1 to 1024 characters. |
path |
Before forwarding the request to the selected service, the request's host header is replaced with contents of The value must be from 1 to 255 characters. |
path |
If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding pathTemplateMatch must be specified. Any template variables must exist in the pathTemplateMatch field.
For example, a pathTemplateMatch of At least one non-empty Only one of |
path |
Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as end-of-stream) up until the response has been processed. Timeout includes all retries. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has |
path |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
path |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
path |
Specifies the retry policy associated with this route. |
path |
Specifies one or more conditions when this retry policy applies. Valid values are:
Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
|
path |
Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. |
path |
Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in the Not supported when the URL map is bound to a target gRPC proxy that has the |
path |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
path |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
path |
Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with Not supported when the URL map is bound to a target gRPC proxy that has the |
path |
The full or partial URL to the The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. Authorization requires the following IAM permission on the specified resource
|
path |
The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. |
path |
Specifies the list of origins that is allowed to do CORS requests. An origin is allowed if it matches either an item in |
path |
Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax . An origin is allowed if it matches either an item in Regular expressions can only be used when the loadBalancingScheme is set to |
path |
Specifies the content for the |
path |
Specifies the content for the |
path |
Specifies the content for the |
path |
Specifies how long results of a preflight request can be cached in seconds. This field translates to the |
path |
In response to a preflight request, setting this to Default is |
path |
If |
path |
The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. |
path |
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. |
path |
Specifies the value of the fixed delay interval. |
path |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
path |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
path |
The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive. |
path |
The specification for how client requests are aborted as part of fault injection. |
path |
The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director. |
path |
The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive. |
path |
Specifies the maximum duration (timeout) for streams on the selected route. Unlike the If not specified, this field uses the maximum This field is only allowed if the Url map is used with backend services with |
path |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
path |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
path |
When a path pattern is matched, the request is redirected to a URL specified by Only one of Not supported when the URL map is bound to a target gRPC proxy. |
path |
The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. |
path |
The path that is used in the redirect response instead of the one that was supplied in the request.
The value must be from 1 to 1024 characters. |
path |
The prefix that replaces the
The value must be from 1 to 1024 characters. |
path |
The HTTP Status code to use for this RedirectAction. Supported values are:
|
path |
If set to This must only be set for URL maps used in The default is set to |
path |
If set to The default is set to |
path |
The list of path patterns to match. Each must start with |
path |
If a policy for an error code is not configured for the For example, consider a UrlMap with the following configuration:
If the request is for
|
path |
Specifies rules for returning error responses. In a given policy, if you specify rules for both a range of error codes as well as rules for specific error codes then rules with specific error codes have a higher priority. For example, assume that you configure a rule for |
path |
Valid values include:
Values must be unique within matchResponseCodes and across all |
path |
The full path to a file within
If the file is not available in The value must be from |
path |
The HTTP status code returned with the response containing the custom error content. If |
path |
The full or partial URL to the
If If
Authorization requires one or more of the following IAM permissions on the specified resource
|
path |
The list of HTTP route rules. Use this list instead of Within a given |
path |
For You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules. |
path |
The short description conveying the intent of this The description can have a maximum length of 1024 characters. |
path |
The list of criteria for matching attributes of a request to this |
path |
For satisfying the The value must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. |
path |
For satisfying the
Only one of prefixMatch, fullPathMatch or regexMatch must be specified. |
path |
For satisfying the Only one of Regular expressions can only be used when the loadBalancingScheme is set to |
path |
Specifies that The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to a target gRPC proxy. |
path |
Specifies a list of header match criteria, all of which must match corresponding headers in the request. |
path |
The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". When the URL map is bound to a target gRPC proxy that has the |
path |
The value should exactly match contents of Only one of |
path |
The value of the header must match the regular expression specified in For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of Regular expressions can only be used when the loadBalancingScheme is set to |
path |
The header value must be an integer and its value must be in the range specified in For example for a range [-5, 0]
Only one of
|
path |
The start of the range (inclusive) in signed long integer format. |
path |
The end of the range (exclusive) in signed long integer format. |
path |
A header with the contents of Only one of |
path |
The value of the header must start with the contents of Only one of |
path |
The value of the header must end with the contents of Only one of |
path |
If set to The default setting is |
path |
Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to a target gRPC proxy. |
path |
The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails. |
path |
Specifies that the Only one of |
path |
The Only one of |
path |
The Only one of Regular expressions can only be used when the loadBalancingScheme is set to |
path |
Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies. For each
Not supported when the URL map is bound to a target gRPC proxy that has |
path |
Specifies how individual filter label matches within the list of Supported values are:
|
path |
The list of label value pairs that must match labels in the provided metadata based on This list must not be empty and can have at the most 64 entries. |
path |
Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long. |
path |
The value of the label must match the specified value. value can have a maximum length of 1024 characters. |
path |
If specified, the route is a pattern match expression that must match the :path header once the query string is removed. A pattern match allows you to match
Precisely one of |
path |
The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If Only one of Authorization requires the following IAM permission on the specified resource
|
path |
In response to a matching Only one of URL maps for classic Application Load Balancers only support the |
path |
A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this |
path |
The full or partial URL to the default Authorization requires the following IAM permission on the specified resource
|
path |
Specifies the fraction of traffic sent to a backend service, computed as The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000. |
path |
Specifies changes to request and response headers that need to take effect for the selected
Not supported when the URL map is bound to a target gRPC proxy that has |
path |
A list of header names for headers that need to be removed from the request before forwarding the request to the |
path |
Headers to add to a matching request before forwarding the request to the |
path |
The name of the header. |
path |
The value of the header to add. |
path |
If The default value is |
path |
A list of header names for headers that need to be removed from the response before sending the response back to the client. |
path |
Headers to add the response before sending the response back to the client. |
path |
The name of the header. |
path |
The value of the header to add. |
path |
If The default value is |
path |
The spec to modify the URL of the request, before forwarding the request to the matched service. Not supported when the URL map is bound to a target gRPC proxy that has the |
path |
Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by The value must be from 1 to 1024 characters. |
path |
Before forwarding the request to the selected service, the request's host header is replaced with contents of The value must be from 1 to 255 characters. |
path |
If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding pathTemplateMatch must be specified. Any template variables must exist in the pathTemplateMatch field.
For example, a pathTemplateMatch of At least one non-empty Only one of |
path |
Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as end-of-stream) up until the response has been processed. Timeout includes all retries. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has |
path |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
path |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
path |
Specifies the retry policy associated with this route. |
path |
Specifies one or more conditions when this retry policy applies. Valid values are:
Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
|
path |
Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. |
path |
Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in the Not supported when the URL map is bound to a target gRPC proxy that has the |
path |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
path |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
path |
Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with Not supported when the URL map is bound to a target gRPC proxy that has the |
path |
The full or partial URL to the The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. Authorization requires the following IAM permission on the specified resource
|
path |
The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. |
path |
Specifies the list of origins that is allowed to do CORS requests. An origin is allowed if it matches either an item in |
path |
Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax . An origin is allowed if it matches either an item in Regular expressions can only be used when the loadBalancingScheme is set to |
path |
Specifies the content for the |
path |
Specifies the content for the |
path |
Specifies the content for the |
path |
Specifies how long results of a preflight request can be cached in seconds. This field translates to the |
path |
In response to a preflight request, setting this to Default is |
path |
If |
path |
The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. |
path |
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. |
path |
Specifies the value of the fixed delay interval. |
path |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
path |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
path |
The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive. |
path |
The specification for how client requests are aborted as part of fault injection. |
path |
The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director. |
path |
The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive. |
path |
Specifies the maximum duration (timeout) for streams on the selected route. Unlike the If not specified, this field uses the maximum This field is only allowed if the Url map is used with backend services with |
path |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
path |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
path |
When this rule is matched, the request is redirected to a URL specified by Only one of Not supported when the URL map is bound to a target gRPC proxy. |
path |
The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. |
path |
The path that is used in the redirect response instead of the one that was supplied in the request.
The value must be from 1 to 1024 characters. |
path |
The prefix that replaces the
The value must be from 1 to 1024 characters. |
path |
The HTTP Status code to use for this RedirectAction. Supported values are:
|
path |
If set to This must only be set for URL maps used in The default is set to |
path |
If set to The default is set to |
path |
Specifies changes to request and response headers that need to take effect for the selected The
Not supported when the URL map is bound to a target gRPC proxy that has |
path |
A list of header names for headers that need to be removed from the request before forwarding the request to the |
path |
Headers to add to a matching request before forwarding the request to the |
path |
The name of the header. |
path |
The value of the header to add. |
path |
If The default value is |
path |
A list of header names for headers that need to be removed from the response before sending the response back to the client. |
path |
Headers to add the response before sending the response back to the client. |
path |
The name of the header. |
path |
The value of the header to add. |
path |
If The default value is |
path |
If a policy for an error code is not configured for the For example, consider a UrlMap with the following configuration:
If the request is for When used in conjunction with
|
path |
Specifies rules for returning error responses. In a given policy, if you specify rules for both a range of error codes as well as rules for specific error codes then rules with specific error codes have a higher priority. For example, assume that you configure a rule for |
path |
Valid values include:
Values must be unique within matchResponseCodes and across all |
path |
The full path to a file within
If the file is not available in The value must be from |
path |
The HTTP status code returned with the response containing the custom error content. If |
path |
The full or partial URL to the
If If
Authorization requires one or more of the following IAM permissions on the specified resource
|
path |
Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching
Not supported when the URL map is bound to a target gRPC proxy that has |
path |
A list of header names for headers that need to be removed from the request before forwarding the request to the |
path |
Headers to add to a matching request before forwarding the request to the |
path |
The name of the header. |
path |
The value of the header to add. |
path |
If The default value is |
path |
A list of header names for headers that need to be removed from the response before sending the response back to the client. |
path |
Headers to add the response before sending the response back to the client. |
path |
The name of the header. |
path |
The value of the header to add. |
path |
If The default value is |
path |
This policy takes effect at the For example, consider a UrlMap with the following configuration:
If the request is for When used in conjunction with
|
path |
Specifies rules for returning error responses. In a given policy, if you specify rules for both a range of error codes as well as rules for specific error codes then rules with specific error codes have a higher priority. For example, assume that you configure a rule for |
path |
Valid values include:
Values must be unique within matchResponseCodes and across all |
path |
The full path to a file within
If the file is not available in The value must be from |
path |
The HTTP status code returned with the response containing the custom error content. If |
path |
The full or partial URL to the
If If
Authorization requires one or more of the following IAM permissions on the specified resource
|
tests[] |
The list of expected URL mapping tests. Request to update the Not supported when the URL map is bound to a target gRPC proxy that has |
tests[]. |
Description of this test case. |
tests[]. |
Host portion of the URL. If |
tests[]. |
Path portion of the URL. |
tests[]. |
HTTP headers for this request. If |
tests[]. |
Header name. |
tests[]. |
Header value. |
tests[]. |
Expected The |
tests[]. |
The expected output URL evaluated by the load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when For rules with
|
tests[]. |
For rules with
|
default |
The full or partial URL of the Only one of
Authorization requires one or more of the following IAM permissions on the specified resource
|
default |
Only one of URL maps for classic Application Load Balancers only support the
|
default |
A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this |
default |
The full or partial URL to the default Authorization requires the following IAM permission on the specified resource
|
default |
Specifies the fraction of traffic sent to a backend service, computed as The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000. |
default |
Specifies changes to request and response headers that need to take effect for the selected
Not supported when the URL map is bound to a target gRPC proxy that has |
default |
A list of header names for headers that need to be removed from the request before forwarding the request to the |
default |
Headers to add to a matching request before forwarding the request to the |
default |
The name of the header. |
default |
The value of the header to add. |
default |
If The default value is |
default |
A list of header names for headers that need to be removed from the response before sending the response back to the client. |
default |
Headers to add the response before sending the response back to the client. |
default |
The name of the header. |
default |
The value of the header to add. |
default |
If The default value is |
default |
The spec to modify the URL of the request, before forwarding the request to the matched service. Not supported when the URL map is bound to a target gRPC proxy that has the |
default |
Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by The value must be from 1 to 1024 characters. |
default |
Before forwarding the request to the selected service, the request's host header is replaced with contents of The value must be from 1 to 255 characters. |
default |
If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding pathTemplateMatch must be specified. Any template variables must exist in the pathTemplateMatch field.
For example, a pathTemplateMatch of At least one non-empty Only one of |
default |
Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as end-of-stream) up until the response has been processed. Timeout includes all retries. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has |
default |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
default |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
default |
Specifies the retry policy associated with this route. |
default |
Specifies one or more conditions when this retry policy applies. Valid values are:
Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.
|
default |
Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. |
default |
Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in the Not supported when the URL map is bound to a target gRPC proxy that has the |
default |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
default |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
default |
Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with Not supported when the URL map is bound to a target gRPC proxy that has the |
default |
The full or partial URL to the The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. Authorization requires the following IAM permission on the specified resource
|
default |
The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. |
default |
Specifies the list of origins that is allowed to do CORS requests. An origin is allowed if it matches either an item in |
default |
Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax . An origin is allowed if it matches either an item in Regular expressions can only be used when the loadBalancingScheme is set to |
default |
Specifies the content for the |
default |
Specifies the content for the |
default |
Specifies the content for the |
default |
Specifies how long results of a preflight request can be cached in seconds. This field translates to the |
default |
In response to a preflight request, setting this to Default is |
default |
If |
default |
The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. |
default |
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. |
default |
Specifies the value of the fixed delay interval. |
default |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
default |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
default |
The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive. |
default |
The specification for how client requests are aborted as part of fault injection. |
default |
The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director. |
default |
The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive. |
default |
Specifies the maximum duration (timeout) for streams on the selected route. Unlike the If not specified, this field uses the maximum This field is only allowed if the Url map is used with backend services with |
default |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
default |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
default |
When none of the specified Only one of Not supported when the URL map is bound to a target gRPC proxy. |
default |
The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. |
default |
The path that is used in the redirect response instead of the one that was supplied in the request.
The value must be from 1 to 1024 characters. |
default |
The prefix that replaces the
The value must be from 1 to 1024 characters. |
default |
The HTTP Status code to use for this RedirectAction. Supported values are:
|
default |
If set to This must only be set for URL maps used in The default is set to |
default |
If set to The default is set to |
header |
Specifies changes to request and response headers that need to take effect for the selected The
Not supported when the URL map is bound to a target gRPC proxy that has |
header |
A list of header names for headers that need to be removed from the request before forwarding the request to the |
header |
Headers to add to a matching request before forwarding the request to the |
header |
The name of the header. |
header |
The value of the header to add. |
header |
If The default value is |
header |
A list of header names for headers that need to be removed from the response before sending the response back to the client. |
header |
Headers to add the response before sending the response back to the client. |
header |
The name of the header. |
header |
The value of the header to add. |
header |
If The default value is |
default |
This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration:
If a request for When used in conjunction with
|
default |
Specifies rules for returning error responses. In a given policy, if you specify rules for both a range of error codes as well as rules for specific error codes then rules with specific error codes have a higher priority. For example, assume that you configure a rule for |
default |
Valid values include:
Values must be unique within matchResponseCodes and across all |
default |
The full path to a file within
If the file is not available in The value must be from |
default |
The HTTP status code returned with the response containing the custom error content. If |
default |
The full or partial URL to the
If If
Authorization requires one or more of the following IAM permissions on the specified resource
|
fingerprint |
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a To see the latest fingerprint, make a A base64-encoded string. |
region |
[Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
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
globalOperationsresource. - For regional operations, use the
regionOperationsresource. - For zonal operations, use the
zoneOperationsresource.
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/computehttps://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.urlMaps.getcompute.urlMaps.update
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.