- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
Updates the specified UrlMap resource with the data included in the request.
HTTP request
PUT https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/urlMaps/{resourceId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
region |
Name of the region scoping this request. |
resourceId |
Name of the UrlMap resource to update. |
Query parameters
Parameters | |
---|---|
requestId |
begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. |
Request body
The request body contains data with the following structure:
JSON representation | |
---|---|
{ "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": , "defaultUrlRedirect": , "pathRules": [ ], "routeRules": [ ], "headerAction": } ], "tests": [ { "description": string, "host": string, "path": string, "service": string } ], "defaultService": string, "defaultRouteAction": { "weightedBackendServices": [ ], "urlRewrite": , "timeout": , "retryPolicy": , "requestMirrorPolicy": , "corsPolicy": , "faultInjectionPolicy": }, "defaultUrlRedirect": { "hostRedirect": string, "pathRedirect": string, "prefixRedirect": string, "redirectResponseCode": enum, "httpsRedirect": boolean, "stripQuery": boolean }, "headerAction": { "requestHeadersToRemove": [ string ], "requestHeadersToAdd": [ ], "responseHeadersToRemove": [ string ], "responseHeadersToAdd": [ ] }, "fingerprint": string, "region": string, "kind": string } |
Fields | |
---|---|
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[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. |
selfLink |
[Output Only] Server-defined URL for the resource. |
hostRules[] |
The list of HostRules to use against the URL. |
hostRules[].description |
An optional description of this resource. Provide this property when you create the resource. |
hostRules[].hosts[] |
The list of host patterns to match. They must be valid hostnames, except |
hostRules[].pathMatcher |
The name of the PathMatcher to use to match the path portion of the URL if the |
pathMatchers[] |
The list of named PathMatchers to use against the URL. |
pathMatchers[].name |
The name to which this PathMatcher is referred by the HostRule. |
pathMatchers[].description |
An optional description of this resource. Provide this property when you create the resource. |
pathMatchers[].defaultService |
The full or partial URL to the BackendService resource. This will be used if none of the
defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendService s. Conversely, if defaultRouteAction specifies any weightedBackendService s, defaultService must not be specified. Only one of Authorization requires one or more of the following Google IAM permissions on the specified resource defaultService:
Authorization requires the following Google IAM permission on the specified resource
|
pathMatchers[].defaultRouteAction |
Only one of |
pathMatchers[].defaultRouteAction.weightedBackendServices[] |
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 Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this |
pathMatchers[].defaultRouteAction.weightedBackendServices[].backendService |
The full or partial URL to the default BackendService resource. Before forwarding the request to Authorization requires the following Google IAM permission on the specified resource
|
pathMatchers[].defaultRouteAction.weightedBackendServices[].weight |
Specifies the fraction of traffic sent to backendService, computed as The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a The value must be between 0 and 1000 |
pathMatchers[].defaultRouteAction.weightedBackendServices[].headerAction |
Specifies changes to request and response headers that need to take effect for the selected
|
pathMatchers[].defaultRouteAction.weightedBackendServices[].headerAction.requestHeadersToRemove[] |
A list of header names for headers that need to be removed from the request prior to forwarding the request to the |
pathMatchers[].defaultRouteAction.weightedBackendServices[].headerAction.requestHeadersToAdd[] |
Headers to add to a matching request prior to forwarding the request to the |
pathMatchers[].defaultRouteAction.weightedBackendServices[].headerAction.requestHeadersToAdd[].headerName |
The name of the header. |
pathMatchers[].defaultRouteAction.weightedBackendServices[].headerAction.requestHeadersToAdd[].headerValue |
The value of the header to add. |
pathMatchers[].defaultRouteAction.weightedBackendServices[].headerAction.requestHeadersToAdd[].replace |
If false, The default value is false. |
pathMatchers[].defaultRouteAction.weightedBackendServices[].headerAction.responseHeadersToRemove[] |
A list of header names for headers that need to be removed from the response prior to sending the response back to the client. |
pathMatchers[].defaultRouteAction.weightedBackendServices[].headerAction.responseHeadersToAdd[] |
Headers to add the response prior to sending the response back to the client. |
pathMatchers[].defaultRouteAction.weightedBackendServices[].headerAction.responseHeadersToAdd[].headerName |
The name of the header. |
pathMatchers[].defaultRouteAction.weightedBackendServices[].headerAction.responseHeadersToAdd[].headerValue |
The value of the header to add. |
pathMatchers[].defaultRouteAction.weightedBackendServices[].headerAction.responseHeadersToAdd[].replace |
If false, The default value is false. |
pathMatchers[].defaultRouteAction.urlRewrite |
The spec to modify the URL of the request, prior to forwarding the request to the matched service |
pathMatchers[].defaultRouteAction.urlRewrite.pathPrefixRewrite |
Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by The value must be between 1 and 1024 characters. |
pathMatchers[].defaultRouteAction.urlRewrite.hostRewrite |
Prior to forwarding the request to the selected service, the request's host header is replaced with contents of The value must be between 1 and 255 characters. |
pathMatchers[].defaultRouteAction.timeout |
Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. |
pathMatchers[].defaultRouteAction.timeout.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
pathMatchers[].defaultRouteAction.timeout.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
pathMatchers[].defaultRouteAction.retryPolicy |
Specifies the retry policy associated with this route. |
pathMatchers[].defaultRouteAction.retryPolicy.retryConditions[] |
Specfies one or more conditions when this retry rule applies. Valid values are:
|
pathMatchers[].defaultRouteAction.retryPolicy.numRetries |
Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. |
pathMatchers[].defaultRouteAction.retryPolicy.perTryTimeout |
Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. |
pathMatchers[].defaultRouteAction.retryPolicy.perTryTimeout.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
pathMatchers[].defaultRouteAction.retryPolicy.perTryTimeout.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
pathMatchers[].defaultRouteAction.requestMirrorPolicy |
Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with |
pathMatchers[].defaultRouteAction.requestMirrorPolicy.backendService |
The full or partial URL to the BackendService resource being mirrored to. Authorization requires the following Google IAM permission on the specified resource
|
pathMatchers[].defaultRouteAction.corsPolicy |
The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing |
pathMatchers[].defaultRouteAction.corsPolicy.allowOrigins[] |
Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either |
pathMatchers[].defaultRouteAction.corsPolicy.allowOriginRegexes[] |
Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either |
pathMatchers[].defaultRouteAction.corsPolicy.allowMethods[] |
Specifies the content for the |
pathMatchers[].defaultRouteAction.corsPolicy.allowHeaders[] |
Specifies the content for the |
pathMatchers[].defaultRouteAction.corsPolicy.exposeHeaders[] |
Specifies the content for the |
pathMatchers[].defaultRouteAction.corsPolicy.maxAge |
Specifies how long the results of a preflight request can be cached. This translates to the content for the |
pathMatchers[].defaultRouteAction.corsPolicy.allowCredentials |
In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Default is false. |
pathMatchers[].defaultRouteAction.corsPolicy.disabled |
If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. |
pathMatchers[].defaultRouteAction.faultInjectionPolicy |
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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.
|
pathMatchers[].defaultRouteAction.faultInjectionPolicy.delay |
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. |
pathMatchers[].defaultRouteAction.faultInjectionPolicy.delay.fixedDelay |
Specifies the value of the fixed delay interval. |
pathMatchers[].defaultRouteAction.faultInjectionPolicy.delay.fixedDelay.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
pathMatchers[].defaultRouteAction.faultInjectionPolicy.delay.fixedDelay.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
pathMatchers[].defaultRouteAction.faultInjectionPolicy.delay.percentage |
The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive. |
pathMatchers[].defaultRouteAction.faultInjectionPolicy.abort |
The specification for how client requests are aborted as part of fault injection. |
pathMatchers[].defaultRouteAction.faultInjectionPolicy.abort.httpStatus |
The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. |
pathMatchers[].defaultRouteAction.faultInjectionPolicy.abort.percentage |
The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive. |
pathMatchers[].defaultUrlRedirect |
When when none of the specified If |
pathMatchers[].defaultUrlRedirect.hostRedirect |
The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters. |
pathMatchers[].defaultUrlRedirect.pathRedirect |
The path that will be used in the redirect response instead of the one that was supplied in the request. Only one of The value must be between 1 and 1024 characters. |
pathMatchers[].defaultUrlRedirect.prefixRedirect |
The prefix that replaces the |
pathMatchers[].defaultUrlRedirect.redirectResponseCode |
The HTTP Status code to use for this RedirectAction. Supported values are:
|
pathMatchers[].defaultUrlRedirect.httpsRedirect |
If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for The default is set to false. |
pathMatchers[].defaultUrlRedirect.stripQuery |
If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. |
pathMatchers[].pathRules[] |
The list of path rules. Use this list instead of For example: a Within a given |
pathMatchers[].pathRules[].service |
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 Google IAM permissions on the specified resource
|
pathMatchers[].pathRules[].routeAction |
In response to a matching Only one of |
pathMatchers[].pathRules[].routeAction.weightedBackendServices[] |
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 Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this |
pathMatchers[].pathRules[].routeAction.weightedBackendServices[].backendService |
The full or partial URL to the default BackendService resource. Before forwarding the request to Authorization requires the following Google IAM permission on the specified resource
|
pathMatchers[].pathRules[].routeAction.weightedBackendServices[].weight |
Specifies the fraction of traffic sent to backendService, computed as The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a The value must be between 0 and 1000 |
pathMatchers[].pathRules[].routeAction.weightedBackendServices[].headerAction |
Specifies changes to request and response headers that need to take effect for the selected
|
pathMatchers[].pathRules[].routeAction.weightedBackendServices[].headerAction.requestHeadersToRemove[] |
A list of header names for headers that need to be removed from the request prior to forwarding the request to the |
pathMatchers[].pathRules[].routeAction.weightedBackendServices[].headerAction.requestHeadersToAdd[] |
Headers to add to a matching request prior to forwarding the request to the |
pathMatchers[].pathRules[].routeAction.weightedBackendServices[].headerAction.requestHeadersToAdd[].headerName |
The name of the header. |
pathMatchers[].pathRules[].routeAction.weightedBackendServices[].headerAction.requestHeadersToAdd[].headerValue |
The value of the header to add. |
pathMatchers[].pathRules[].routeAction.weightedBackendServices[].headerAction.requestHeadersToAdd[].replace |
If false, The default value is false. |
pathMatchers[].pathRules[].routeAction.weightedBackendServices[].headerAction.responseHeadersToRemove[] |
A list of header names for headers that need to be removed from the response prior to sending the response back to the client. |
pathMatchers[].pathRules[].routeAction.weightedBackendServices[].headerAction.responseHeadersToAdd[] |
Headers to add the response prior to sending the response back to the client. |
pathMatchers[].pathRules[].routeAction.weightedBackendServices[].headerAction.responseHeadersToAdd[].headerName |
The name of the header. |
pathMatchers[].pathRules[].routeAction.weightedBackendServices[].headerAction.responseHeadersToAdd[].headerValue |
The value of the header to add. |
pathMatchers[].pathRules[].routeAction.weightedBackendServices[].headerAction.responseHeadersToAdd[].replace |
If false, The default value is false. |
pathMatchers[].pathRules[].routeAction.urlRewrite |
The spec to modify the URL of the request, prior to forwarding the request to the matched service |
pathMatchers[].pathRules[].routeAction.urlRewrite.pathPrefixRewrite |
Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by The value must be between 1 and 1024 characters. |
pathMatchers[].pathRules[].routeAction.urlRewrite.hostRewrite |
Prior to forwarding the request to the selected service, the request's host header is replaced with contents of The value must be between 1 and 255 characters. |
pathMatchers[].pathRules[].routeAction.timeout |
Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. |
pathMatchers[].pathRules[].routeAction.timeout.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
pathMatchers[].pathRules[].routeAction.timeout.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
pathMatchers[].pathRules[].routeAction.retryPolicy |
Specifies the retry policy associated with this route. |
pathMatchers[].pathRules[].routeAction.retryPolicy.retryConditions[] |
Specfies one or more conditions when this retry rule applies. Valid values are:
|
pathMatchers[].pathRules[].routeAction.retryPolicy.numRetries |
Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. |
pathMatchers[].pathRules[].routeAction.retryPolicy.perTryTimeout |
Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. |
pathMatchers[].pathRules[].routeAction.retryPolicy.perTryTimeout.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
pathMatchers[].pathRules[].routeAction.retryPolicy.perTryTimeout.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
pathMatchers[].pathRules[].routeAction.requestMirrorPolicy |
Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with |
pathMatchers[].pathRules[].routeAction.requestMirrorPolicy.backendService |
The full or partial URL to the BackendService resource being mirrored to. Authorization requires the following Google IAM permission on the specified resource
|
pathMatchers[].pathRules[].routeAction.corsPolicy |
The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing |
pathMatchers[].pathRules[].routeAction.corsPolicy.allowOrigins[] |
Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either |
pathMatchers[].pathRules[].routeAction.corsPolicy.allowOriginRegexes[] |
Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either |
pathMatchers[].pathRules[].routeAction.corsPolicy.allowMethods[] |
Specifies the content for the |
pathMatchers[].pathRules[].routeAction.corsPolicy.allowHeaders[] |
Specifies the content for the |
pathMatchers[].pathRules[].routeAction.corsPolicy.exposeHeaders[] |
Specifies the content for the |
pathMatchers[].pathRules[].routeAction.corsPolicy.maxAge |
Specifies how long the results of a preflight request can be cached. This translates to the content for the |
pathMatchers[].pathRules[].routeAction.corsPolicy.allowCredentials |
In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Default is false. |
pathMatchers[].pathRules[].routeAction.corsPolicy.disabled |
If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. |
pathMatchers[].pathRules[].routeAction.faultInjectionPolicy |
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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.
|
pathMatchers[].pathRules[].routeAction.faultInjectionPolicy.delay |
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. |
pathMatchers[].pathRules[].routeAction.faultInjectionPolicy.delay.fixedDelay |
Specifies the value of the fixed delay interval. |
pathMatchers[].pathRules[].routeAction.faultInjectionPolicy.delay.fixedDelay.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
pathMatchers[].pathRules[].routeAction.faultInjectionPolicy.delay.fixedDelay.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
pathMatchers[].pathRules[].routeAction.faultInjectionPolicy.delay.percentage |
The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive. |
pathMatchers[].pathRules[].routeAction.faultInjectionPolicy.abort |
The specification for how client requests are aborted as part of fault injection. |
pathMatchers[].pathRules[].routeAction.faultInjectionPolicy.abort.httpStatus |
The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. |
pathMatchers[].pathRules[].routeAction.faultInjectionPolicy.abort.percentage |
The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive. |
pathMatchers[].pathRules[].urlRedirect |
When a path pattern is matched, the request is redirected to a URL specified by If |
pathMatchers[].pathRules[].urlRedirect.hostRedirect |
The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters. |
pathMatchers[].pathRules[].urlRedirect.pathRedirect |
The path that will be used in the redirect response instead of the one that was supplied in the request. Only one of The value must be between 1 and 1024 characters. |
pathMatchers[].pathRules[].urlRedirect.prefixRedirect |
The prefix that replaces the |
pathMatchers[].pathRules[].urlRedirect.redirectResponseCode |
The HTTP Status code to use for this RedirectAction. Supported values are:
|
pathMatchers[].pathRules[].urlRedirect.httpsRedirect |
If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for The default is set to false. |
pathMatchers[].pathRules[].urlRedirect.stripQuery |
If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. |
pathMatchers[].pathRules[].paths[] |
The list of path patterns to match. Each must start with |
pathMatchers[].routeRules[] |
The list of ordered HTTP route rules. Use this list instead of Within a given
|
pathMatchers[].routeRules[].priority |
For You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number between 0 and 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. |
pathMatchers[].routeRules[].description |
The short description conveying the intent of this The description can have a maximum length of 1024 characters. |
pathMatchers[].routeRules[].matchRules[] |
|
pathMatchers[].routeRules[].matchRules[].prefixMatch |
For satifying the The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. |
pathMatchers[].routeRules[].matchRules[].fullPathMatch |
For satifying the
Only one of prefixMatch, fullPathMatch or regexMatch must be specified. |
pathMatchers[].routeRules[].matchRules[].regexMatch |
For satifying the Only one of prefixMatch, fullPathMatch or regexMatch must be specified. |
pathMatchers[].routeRules[].matchRules[].ignoreCase |
Specifies that The default value is false. caseSensitive must not be used with regexMatch. |
pathMatchers[].routeRules[].matchRules[].headerMatches[] |
Specifies a list of header match criteria, all of which must match corresponding headers in the request. |
pathMatchers[].routeRules[].matchRules[].headerMatches[].headerName |
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". |
pathMatchers[].routeRules[].matchRules[].headerMatches[].exactMatch |
The value should exactly match contents of Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. |
pathMatchers[].routeRules[].matchRules[].headerMatches[].regexMatch |
The value of the header must match the regualar 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 exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. |
pathMatchers[].routeRules[].matchRules[].headerMatches[].rangeMatch |
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 exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. |
pathMatchers[].routeRules[].matchRules[].headerMatches[].rangeMatch.rangeStart |
The start of the range (inclusive) in signed long integer format. |
pathMatchers[].routeRules[].matchRules[].headerMatches[].rangeMatch.rangeEnd |
The end of the range (exclusive) in signed long integer format. |
pathMatchers[].routeRules[].matchRules[].headerMatches[].presentMatch |
A header with the contents of Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. |
pathMatchers[].routeRules[].matchRules[].headerMatches[].prefixMatch |
The value of the header must start with the contents of Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. |
pathMatchers[].routeRules[].matchRules[].headerMatches[].suffixMatch |
The value of the header must end with the contents of Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. |
pathMatchers[].routeRules[].matchRules[].headerMatches[].invertMatch |
If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. The default setting is false. |
pathMatchers[].routeRules[].matchRules[].queryParameterMatches[] |
Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. |
pathMatchers[].routeRules[].matchRules[].queryParameterMatches[].name |
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. |
pathMatchers[].routeRules[].matchRules[].queryParameterMatches[].presentMatch |
Specifies that the Only one of presentMatch, exactMatch and regexMatch must be set. |
pathMatchers[].routeRules[].matchRules[].queryParameterMatches[].exactMatch |
The Only one of presentMatch, exactMatch and regexMatch must be set. |
pathMatchers[].routeRules[].matchRules[].queryParameterMatches[].regexMatch |
The Only one of presentMatch, exactMatch and regexMatch must be set. |
pathMatchers[].routeRules[].matchRules[].metadataFilters[] |
Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each
|
pathMatchers[].routeRules[].matchRules[].metadataFilters[].filterMatchCriteria |
Specifies how individual Supported values are:
|
pathMatchers[].routeRules[].matchRules[].metadataFilters[].filterLabels[] |
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. |
pathMatchers[].routeRules[].matchRules[].metadataFilters[].filterLabels[].name |
Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long. |
pathMatchers[].routeRules[].matchRules[].metadataFilters[].filterLabels[].value |
The value of the label must match the specified value. value can have a maximum length of 1024 characters. |
pathMatchers[].routeRules[].service |
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 Google IAM permission on the specified resource
|
pathMatchers[].routeRules[].routeAction |
In response to a matching Only one of |
pathMatchers[].routeRules[].routeAction.weightedBackendServices[] |
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 Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this |
pathMatchers[].routeRules[].routeAction.weightedBackendServices[].backendService |
The full or partial URL to the default BackendService resource. Before forwarding the request to Authorization requires the following Google IAM permission on the specified resource
|
pathMatchers[].routeRules[].routeAction.weightedBackendServices[].weight |
Specifies the fraction of traffic sent to backendService, computed as The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a The value must be between 0 and 1000 |
pathMatchers[].routeRules[].routeAction.weightedBackendServices[].headerAction |
Specifies changes to request and response headers that need to take effect for the selected
|
pathMatchers[].routeRules[].routeAction.weightedBackendServices[].headerAction.requestHeadersToRemove[] |
A list of header names for headers that need to be removed from the request prior to forwarding the request to the |
pathMatchers[].routeRules[].routeAction.weightedBackendServices[].headerAction.requestHeadersToAdd[] |
Headers to add to a matching request prior to forwarding the request to the |
pathMatchers[].routeRules[].routeAction.weightedBackendServices[].headerAction.requestHeadersToAdd[].headerName |
The name of the header. |
pathMatchers[].routeRules[].routeAction.weightedBackendServices[].headerAction.requestHeadersToAdd[].headerValue |
The value of the header to add. |
pathMatchers[].routeRules[].routeAction.weightedBackendServices[].headerAction.requestHeadersToAdd[].replace |
If false, The default value is false. |
pathMatchers[].routeRules[].routeAction.weightedBackendServices[].headerAction.responseHeadersToRemove[] |
A list of header names for headers that need to be removed from the response prior to sending the response back to the client. |
pathMatchers[].routeRules[].routeAction.weightedBackendServices[].headerAction.responseHeadersToAdd[] |
Headers to add the response prior to sending the response back to the client. |
pathMatchers[].routeRules[].routeAction.weightedBackendServices[].headerAction.responseHeadersToAdd[].headerName |
The name of the header. |
pathMatchers[].routeRules[].routeAction.weightedBackendServices[].headerAction.responseHeadersToAdd[].headerValue |
The value of the header to add. |
pathMatchers[].routeRules[].routeAction.weightedBackendServices[].headerAction.responseHeadersToAdd[].replace |
If false, The default value is false. |
pathMatchers[].routeRules[].routeAction.urlRewrite |
The spec to modify the URL of the request, prior to forwarding the request to the matched service |
pathMatchers[].routeRules[].routeAction.urlRewrite.pathPrefixRewrite |
Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by The value must be between 1 and 1024 characters. |
pathMatchers[].routeRules[].routeAction.urlRewrite.hostRewrite |
Prior to forwarding the request to the selected service, the request's host header is replaced with contents of The value must be between 1 and 255 characters. |
pathMatchers[].routeRules[].routeAction.timeout |
Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. |
pathMatchers[].routeRules[].routeAction.timeout.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
pathMatchers[].routeRules[].routeAction.timeout.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
pathMatchers[].routeRules[].routeAction.retryPolicy |
Specifies the retry policy associated with this route. |
pathMatchers[].routeRules[].routeAction.retryPolicy.retryConditions[] |
Specfies one or more conditions when this retry rule applies. Valid values are:
|
pathMatchers[].routeRules[].routeAction.retryPolicy.numRetries |
Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. |
pathMatchers[].routeRules[].routeAction.retryPolicy.perTryTimeout |
Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. |
pathMatchers[].routeRules[].routeAction.retryPolicy.perTryTimeout.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
pathMatchers[].routeRules[].routeAction.retryPolicy.perTryTimeout.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
pathMatchers[].routeRules[].routeAction.requestMirrorPolicy |
Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with |
pathMatchers[].routeRules[].routeAction.requestMirrorPolicy.backendService |
The full or partial URL to the BackendService resource being mirrored to. Authorization requires the following Google IAM permission on the specified resource
|
pathMatchers[].routeRules[].routeAction.corsPolicy |
The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing |
pathMatchers[].routeRules[].routeAction.corsPolicy.allowOrigins[] |
Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either |
pathMatchers[].routeRules[].routeAction.corsPolicy.allowOriginRegexes[] |
Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either |
pathMatchers[].routeRules[].routeAction.corsPolicy.allowMethods[] |
Specifies the content for the |
pathMatchers[].routeRules[].routeAction.corsPolicy.allowHeaders[] |
Specifies the content for the |
pathMatchers[].routeRules[].routeAction.corsPolicy.exposeHeaders[] |
Specifies the content for the |
pathMatchers[].routeRules[].routeAction.corsPolicy.maxAge |
Specifies how long the results of a preflight request can be cached. This translates to the content for the |
pathMatchers[].routeRules[].routeAction.corsPolicy.allowCredentials |
In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Default is false. |
pathMatchers[].routeRules[].routeAction.corsPolicy.disabled |
If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. |
pathMatchers[].routeRules[].routeAction.faultInjectionPolicy |
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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.
|
pathMatchers[].routeRules[].routeAction.faultInjectionPolicy.delay |
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. |
pathMatchers[].routeRules[].routeAction.faultInjectionPolicy.delay.fixedDelay |
Specifies the value of the fixed delay interval. |
pathMatchers[].routeRules[].routeAction.faultInjectionPolicy.delay.fixedDelay.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
pathMatchers[].routeRules[].routeAction.faultInjectionPolicy.delay.fixedDelay.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
pathMatchers[].routeRules[].routeAction.faultInjectionPolicy.delay.percentage |
The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive. |
pathMatchers[].routeRules[].routeAction.faultInjectionPolicy.abort |
The specification for how client requests are aborted as part of fault injection. |
pathMatchers[].routeRules[].routeAction.faultInjectionPolicy.abort.httpStatus |
The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. |
pathMatchers[].routeRules[].routeAction.faultInjectionPolicy.abort.percentage |
The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive. |
pathMatchers[].routeRules[].urlRedirect |
When this rule is matched, the request is redirected to a URL specified by If |
pathMatchers[].routeRules[].urlRedirect.hostRedirect |
The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters. |
pathMatchers[].routeRules[].urlRedirect.pathRedirect |
The path that will be used in the redirect response instead of the one that was supplied in the request. Only one of The value must be between 1 and 1024 characters. |
pathMatchers[].routeRules[].urlRedirect.prefixRedirect |
The prefix that replaces the |
pathMatchers[].routeRules[].urlRedirect.redirectResponseCode |
The HTTP Status code to use for this RedirectAction. Supported values are:
|
pathMatchers[].routeRules[].urlRedirect.httpsRedirect |
If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for The default is set to false. |
pathMatchers[].routeRules[].urlRedirect.stripQuery |
If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. |
pathMatchers[].routeRules[].headerAction |
Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction |
pathMatchers[].routeRules[].headerAction.requestHeadersToRemove[] |
A list of header names for headers that need to be removed from the request prior to forwarding the request to the |
pathMatchers[].routeRules[].headerAction.requestHeadersToAdd[] |
Headers to add to a matching request prior to forwarding the request to the |
pathMatchers[].routeRules[].headerAction.requestHeadersToAdd[].headerName |
The name of the header. |
pathMatchers[].routeRules[].headerAction.requestHeadersToAdd[].headerValue |
The value of the header to add. |
pathMatchers[].routeRules[].headerAction.requestHeadersToAdd[].replace |
If false, The default value is false. |
pathMatchers[].routeRules[].headerAction.responseHeadersToRemove[] |
A list of header names for headers that need to be removed from the response prior to sending the response back to the client. |
pathMatchers[].routeRules[].headerAction.responseHeadersToAdd[] |
Headers to add the response prior to sending the response back to the client. |
pathMatchers[].routeRules[].headerAction.responseHeadersToAdd[].headerName |
The name of the header. |
pathMatchers[].routeRules[].headerAction.responseHeadersToAdd[].headerValue |
The value of the header to add. |
pathMatchers[].routeRules[].headerAction.responseHeadersToAdd[].replace |
If false, The default value is false. |
pathMatchers[].headerAction |
Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching |
pathMatchers[].headerAction.requestHeadersToRemove[] |
A list of header names for headers that need to be removed from the request prior to forwarding the request to the |
pathMatchers[].headerAction.requestHeadersToAdd[] |
Headers to add to a matching request prior to forwarding the request to the |
pathMatchers[].headerAction.requestHeadersToAdd[].headerName |
The name of the header. |
pathMatchers[].headerAction.requestHeadersToAdd[].headerValue |
The value of the header to add. |
pathMatchers[].headerAction.requestHeadersToAdd[].replace |
If false, The default value is false. |
pathMatchers[].headerAction.responseHeadersToRemove[] |
A list of header names for headers that need to be removed from the response prior to sending the response back to the client. |
pathMatchers[].headerAction.responseHeadersToAdd[] |
Headers to add the response prior to sending the response back to the client. |
pathMatchers[].headerAction.responseHeadersToAdd[].headerName |
The name of the header. |
pathMatchers[].headerAction.responseHeadersToAdd[].headerValue |
The value of the header to add. |
pathMatchers[].headerAction.responseHeadersToAdd[].replace |
If false, The default value is false. |
tests[] |
The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. |
tests[].description |
Description of this test case. |
tests[].host |
Host portion of the URL. |
tests[].path |
Path portion of the URL. |
tests[].service |
Expected BackendService resource the given URL should be mapped to. |
defaultService |
The full or partial URL of the Only one of Authorization requires the following Google IAM permission on the specified resource
|
defaultRouteAction |
Only one of |
defaultRouteAction.weightedBackendServices[] |
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 Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this |
defaultRouteAction.weightedBackendServices[].backendService |
The full or partial URL to the default BackendService resource. Before forwarding the request to Authorization requires the following Google IAM permission on the specified resource
|
defaultRouteAction.weightedBackendServices[].weight |
Specifies the fraction of traffic sent to backendService, computed as The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a The value must be between 0 and 1000 |
defaultRouteAction.weightedBackendServices[].headerAction |
Specifies changes to request and response headers that need to take effect for the selected
|
defaultRouteAction.weightedBackendServices[].headerAction.requestHeadersToRemove[] |
A list of header names for headers that need to be removed from the request prior to forwarding the request to the |
defaultRouteAction.weightedBackendServices[].headerAction.requestHeadersToAdd[] |
Headers to add to a matching request prior to forwarding the request to the |
defaultRouteAction.weightedBackendServices[].headerAction.requestHeadersToAdd[].headerName |
The name of the header. |
defaultRouteAction.weightedBackendServices[].headerAction.requestHeadersToAdd[].headerValue |
The value of the header to add. |
defaultRouteAction.weightedBackendServices[].headerAction.requestHeadersToAdd[].replace |
If false, The default value is false. |
defaultRouteAction.weightedBackendServices[].headerAction.responseHeadersToRemove[] |
A list of header names for headers that need to be removed from the response prior to sending the response back to the client. |
defaultRouteAction.weightedBackendServices[].headerAction.responseHeadersToAdd[] |
Headers to add the response prior to sending the response back to the client. |
defaultRouteAction.weightedBackendServices[].headerAction.responseHeadersToAdd[].headerName |
The name of the header. |
defaultRouteAction.weightedBackendServices[].headerAction.responseHeadersToAdd[].headerValue |
The value of the header to add. |
defaultRouteAction.weightedBackendServices[].headerAction.responseHeadersToAdd[].replace |
If false, The default value is false. |
defaultRouteAction.urlRewrite |
The spec to modify the URL of the request, prior to forwarding the request to the matched service |
defaultRouteAction.urlRewrite.pathPrefixRewrite |
Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by The value must be between 1 and 1024 characters. |
defaultRouteAction.urlRewrite.hostRewrite |
Prior to forwarding the request to the selected service, the request's host header is replaced with contents of The value must be between 1 and 255 characters. |
defaultRouteAction.timeout |
Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. |
defaultRouteAction.timeout.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
defaultRouteAction.timeout.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
defaultRouteAction.retryPolicy |
Specifies the retry policy associated with this route. |
defaultRouteAction.retryPolicy.retryConditions[] |
Specfies one or more conditions when this retry rule applies. Valid values are:
|
defaultRouteAction.retryPolicy.numRetries |
Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. |
defaultRouteAction.retryPolicy.perTryTimeout |
Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. |
defaultRouteAction.retryPolicy.perTryTimeout.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
defaultRouteAction.retryPolicy.perTryTimeout.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
defaultRouteAction.requestMirrorPolicy |
Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with |
defaultRouteAction.requestMirrorPolicy.backendService |
The full or partial URL to the BackendService resource being mirrored to. Authorization requires the following Google IAM permission on the specified resource
|
defaultRouteAction.corsPolicy |
The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing |
defaultRouteAction.corsPolicy.allowOrigins[] |
Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either |
defaultRouteAction.corsPolicy.allowOriginRegexes[] |
Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either |
defaultRouteAction.corsPolicy.allowMethods[] |
Specifies the content for the |
defaultRouteAction.corsPolicy.allowHeaders[] |
Specifies the content for the |
defaultRouteAction.corsPolicy.exposeHeaders[] |
Specifies the content for the |
defaultRouteAction.corsPolicy.maxAge |
Specifies how long the results of a preflight request can be cached. This translates to the content for the |
defaultRouteAction.corsPolicy.allowCredentials |
In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Default is false. |
defaultRouteAction.corsPolicy.disabled |
If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. |
defaultRouteAction.faultInjectionPolicy |
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 Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.
|
defaultRouteAction.faultInjectionPolicy.delay |
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. |
defaultRouteAction.faultInjectionPolicy.delay.fixedDelay |
Specifies the value of the fixed delay interval. |
defaultRouteAction.faultInjectionPolicy.delay.fixedDelay.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
defaultRouteAction.faultInjectionPolicy.delay.fixedDelay.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
defaultRouteAction.faultInjectionPolicy.delay.percentage |
The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive. |
defaultRouteAction.faultInjectionPolicy.abort |
The specification for how client requests are aborted as part of fault injection. |
defaultRouteAction.faultInjectionPolicy.abort.httpStatus |
The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. |
defaultRouteAction.faultInjectionPolicy.abort.percentage |
The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive. |
defaultUrlRedirect |
When none of the specified If |
defaultUrlRedirect.hostRedirect |
The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters. |
defaultUrlRedirect.pathRedirect |
The path that will be used in the redirect response instead of the one that was supplied in the request. Only one of The value must be between 1 and 1024 characters. |
defaultUrlRedirect.prefixRedirect |
The prefix that replaces the |
defaultUrlRedirect.redirectResponseCode |
The HTTP Status code to use for this RedirectAction. Supported values are:
|
defaultUrlRedirect.httpsRedirect |
If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for The default is set to false. |
defaultUrlRedirect.stripQuery |
If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. |
headerAction |
Specifies changes to request and response headers that need to take effect for the selected The |
headerAction.requestHeadersToRemove[] |
A list of header names for headers that need to be removed from the request prior to forwarding the request to the |
headerAction.requestHeadersToAdd[] |
Headers to add to a matching request prior to forwarding the request to the |
headerAction.requestHeadersToAdd[].headerName |
The name of the header. |
headerAction.requestHeadersToAdd[].headerValue |
The value of the header to add. |
headerAction.requestHeadersToAdd[].replace |
If false, The default value is false. |
headerAction.responseHeadersToRemove[] |
A list of header names for headers that need to be removed from the response prior to sending the response back to the client. |
headerAction.responseHeadersToAdd[] |
Headers to add the response prior to sending the response back to the client. |
headerAction.responseHeadersToAdd[].headerName |
The name of the header. |
headerAction.responseHeadersToAdd[].headerValue |
The value of the header to add. |
headerAction.responseHeadersToAdd[].replace |
If false, The default value is false. |
fingerprint |
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a 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. |
kind |
[Output Only] Type of the resource. Always |
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "creationTimestamp": string, "name": string, "zone": string, "clientOperationId": string, "operationType": string, "targetLink": string, "targetId": string, "status": enum, "statusMessage": string, "user": string, "progress": number, "insertTime": string, "startTime": string, "endTime": string, "error": { "errors": [ { "code": string, "location": string, "message": string } ] }, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "httpErrorStatusCode": number, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "kind": string } |
Fields | |
---|---|
id |
[Output Only] The unique identifier for the operation. This identifier is defined by the server. |
creationTimestamp |
[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. |
clientOperationId |
[Output Only] The value of |
operationType |
[Output Only] The type of operation, such as |
targetLink |
[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 |
[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: |
statusMessage |
[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. |
insertTime |
[Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
startTime |
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
endTime |
[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.errors[] |
[Output Only] The array of errors encountered while processing this operation. |
error.errors[].code |
[Output Only] The error type identifier for this error. |
error.errors[].location |
[Output Only] Indicates the field in the request that caused the error. This property is optional. |
error.errors[].message |
[Output Only] An optional, human-readable error message. |
warnings[] |
[Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
warnings[].code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warnings[].message |
[Output Only] A human-readable description of the warning code. |
warnings[].data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warnings[].data[].key |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be |
warnings[].data[].value |
[Output Only] A warning data value corresponding to the key. |
httpErrorStatusCode |
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a |
httpErrorMessage |
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as |
selfLink |
[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. |
kind |
[Output Only] Type of the resource. Always |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:
compute.regionUrlMaps.update