Skip to main content

url_maps

Creates, updates, deletes, gets or lists a url_maps resource.

Overview​

Nameurl_maps
TypeResource
Idgoogle.compute.url_maps

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
idstring (uint64)[Output Only] The unique identifier for the resource. This identifier is defined by the server.
namestringName of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. (pattern: a-z?)
creationTimestampstring[Output Only] Creation timestamp in RFC3339 text format.
defaultCustomErrorResponsePolicyobjectdefaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. 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: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers. (id: CustomErrorResponsePolicy)
defaultRouteActionobjectdefaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. (id: HttpRouteAction)
defaultServicestringThe full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
defaultUrlRedirectobjectWhen none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy. (id: HttpRedirectAction)
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
fingerprintstring (byte)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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap.
headerActionobjectSpecifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. (id: HttpHeaderAction)
hostRulesarrayThe list of host rules to use against the URL.
kindstring[Output Only] Type of the resource. Always compute#urlMaps for url maps. (default: compute#urlMap)
pathMatchersarrayThe list of named PathMatchers to use against the URL.
regionstring[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.
selfLinkstring[Output Only] Server-defined URL for the resource.
testsarrayThe list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectproject, region, urlMapReturns the specified UrlMap resource.
listselectproject, regionfilter, maxResults, orderBy, pageToken, returnPartialSuccessRetrieves the list of UrlMap resources available to the specified project in the specified region.
insertinsertproject, regionrequestIdCreates a UrlMap resource in the specified project using the data included in the request.
patchupdateproject, region, urlMaprequestIdPatches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
updatereplaceproject, region, urlMaprequestIdUpdates the specified UrlMap resource with the data included in the request.
deletedeleteproject, region, urlMaprequestIdDeletes the specified UrlMap resource.
validateexecproject, region, urlMapRuns static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.
invalidate_cacheexecproject, urlMaprequestIdInitiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
projectstring
regionstring
urlMapstring
filterstring
maxResultsinteger (uint32)
orderBystring
pageTokenstring
requestIdstring
returnPartialSuccessboolean

SELECT examples​

Returns the specified UrlMap resource.

SELECT
id,
name,
creationTimestamp,
defaultCustomErrorResponsePolicy,
defaultRouteAction,
defaultService,
defaultUrlRedirect,
description,
fingerprint,
headerAction,
hostRules,
kind,
pathMatchers,
region,
selfLink,
tests
FROM google.compute.url_maps
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND urlMap = '{{ urlMap }}' -- required;

INSERT examples​

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

INSERT INTO google.compute.url_maps (
data__kind,
data__id,
data__creationTimestamp,
data__name,
data__description,
data__selfLink,
data__hostRules,
data__pathMatchers,
data__tests,
data__defaultService,
data__defaultRouteAction,
data__defaultUrlRedirect,
data__headerAction,
data__defaultCustomErrorResponsePolicy,
data__fingerprint,
data__region,
project,
region,
requestId
)
SELECT 
'{{ kind }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ description }}',
'{{ selfLink }}',
'{{ hostRules }}',
'{{ pathMatchers }}',
'{{ tests }}',
'{{ defaultService }}',
'{{ defaultRouteAction }}',
'{{ defaultUrlRedirect }}',
'{{ headerAction }}',
'{{ defaultCustomErrorResponsePolicy }}',
'{{ fingerprint }}',
'{{ region }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

UPDATE examples​

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

UPDATE google.compute.url_maps
SET 
data__kind = '{{ kind }}',
data__id = '{{ id }}',
data__creationTimestamp = '{{ creationTimestamp }}',
data__name = '{{ name }}',
data__description = '{{ description }}',
data__selfLink = '{{ selfLink }}',
data__hostRules = '{{ hostRules }}',
data__pathMatchers = '{{ pathMatchers }}',
data__tests = '{{ tests }}',
data__defaultService = '{{ defaultService }}',
data__defaultRouteAction = '{{ defaultRouteAction }}',
data__defaultUrlRedirect = '{{ defaultUrlRedirect }}',
data__headerAction = '{{ headerAction }}',
data__defaultCustomErrorResponsePolicy = '{{ defaultCustomErrorResponsePolicy }}',
data__fingerprint = '{{ fingerprint }}',
data__region = '{{ region }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND urlMap = '{{ urlMap }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

REPLACE examples​

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

REPLACE google.compute.url_maps
SET 
data__kind = '{{ kind }}',
data__id = '{{ id }}',
data__creationTimestamp = '{{ creationTimestamp }}',
data__name = '{{ name }}',
data__description = '{{ description }}',
data__selfLink = '{{ selfLink }}',
data__hostRules = '{{ hostRules }}',
data__pathMatchers = '{{ pathMatchers }}',
data__tests = '{{ tests }}',
data__defaultService = '{{ defaultService }}',
data__defaultRouteAction = '{{ defaultRouteAction }}',
data__defaultUrlRedirect = '{{ defaultUrlRedirect }}',
data__headerAction = '{{ headerAction }}',
data__defaultCustomErrorResponsePolicy = '{{ defaultCustomErrorResponsePolicy }}',
data__fingerprint = '{{ fingerprint }}',
data__region = '{{ region }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND urlMap = '{{ urlMap }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples​

Deletes the specified UrlMap resource.

DELETE FROM google.compute.url_maps
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND urlMap = '{{ urlMap }}' --required
AND requestId = '{{ requestId }}';

Lifecycle Methods​

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

EXEC google.compute.url_maps.validate 
@project='{{ project }}' --required, 
@region='{{ region }}' --required, 
@urlMap='{{ urlMap }}' --required 
@@json=
'{
"resource": "{{ resource }}"
}';