List
|
|||||
|
|
Retrieves the list of UrlMap resources available to the specified project
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and manage your Google Compute Engine resources
- View your Google Compute Engine resources
Input
This building block consumes 5 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Project ID for this request |
filter |
STRING |
A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) |
maxResults |
INTEGER |
The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) |
orderBy |
STRING |
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported |
pageToken |
STRING |
Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results |
= Parameter name
= Format
project STRING Required Project ID for this request |
filter STRING A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) |
maxResults INTEGER The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) |
orderBy STRING Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported |
pageToken STRING Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results |
Output
This building block provides 32 output parameters
Name | Format | Description |
---|---|---|
id |
STRING |
[Output Only] Unique identifier for the resource; defined by the server |
items[] |
OBJECT |
A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path |
items[].creationTimestamp |
STRING |
[Output Only] Creation timestamp in RFC3339 text format |
items[].defaultService |
STRING |
The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If 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 weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set |
items[].description |
STRING |
An optional description of this resource. Provide this property when you create the resource |
items[].fingerprint |
BINARY |
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 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 |
items[].hostRules[] |
OBJECT |
UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService |
items[].hostRules[].description |
STRING |
An optional description of this resource. Provide this property when you create the resource |
items[].hostRules[].hosts[] |
STRING |
|
items[].hostRules[].pathMatcher |
STRING |
The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion |
items[].id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
items[].kind |
STRING |
[Output Only] Type of the resource. Always compute#urlMaps for url maps |
items[].name |
STRING |
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 |
items[].pathMatchers[] |
OBJECT |
A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used |
items[].pathMatchers[].defaultService |
STRING |
The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource:
|
items[].pathMatchers[].description |
STRING |
An optional description of this resource. Provide this property when you create the resource |
items[].pathMatchers[].name |
STRING |
The name to which this PathMatcher is referred by the HostRule |
items[].selfLink |
STRING |
[Output Only] Server-defined URL for the resource |
items[].tests[] |
OBJECT |
Message for the expected URL mappings |
items[].tests[].description |
STRING |
Description of this test case |
items[].tests[].host |
STRING |
Host portion of the URL |
items[].tests[].path |
STRING |
Path portion of the URL |
items[].tests[].service |
STRING |
Expected BackendService resource the given URL should be mapped to |
kind |
STRING |
Type of resource |
nextPageToken |
STRING |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results |
selfLink |
STRING |
[Output Only] Server-defined URL for this resource |
warning |
OBJECT |
[Output Only] Informational warning message |
warning.code |
ENUMERATION |
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warning.data[] |
OBJECT |
|
warning.data[].key |
STRING |
[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 scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding) |
warning.data[].value |
STRING |
[Output Only] A warning data value corresponding to the key |
warning.message |
STRING |
[Output Only] A human-readable description of the warning code |
= Parameter name
= Format
id STRING [Output Only] Unique identifier for the resource; defined by the server |
items[] OBJECT A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path |
items[].creationTimestamp STRING [Output Only] Creation timestamp in RFC3339 text format |
items[].defaultService STRING The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If 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 weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set |
items[].description STRING An optional description of this resource. Provide this property when you create the resource |
items[].fingerprint BINARY 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 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 |
items[].hostRules[] OBJECT UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService |
items[].hostRules[].description STRING An optional description of this resource. Provide this property when you create the resource |
items[].hostRules[].hosts[] STRING |
items[].hostRules[].pathMatcher STRING The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion |
items[].id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
items[].kind STRING [Output Only] Type of the resource. Always compute#urlMaps for url maps |
items[].name STRING 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 |
items[].pathMatchers[] OBJECT A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used |
items[].pathMatchers[].defaultService STRING The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource:
|
items[].pathMatchers[].description STRING An optional description of this resource. Provide this property when you create the resource |
items[].pathMatchers[].name STRING The name to which this PathMatcher is referred by the HostRule |
items[].selfLink STRING [Output Only] Server-defined URL for the resource |
items[].tests[] OBJECT Message for the expected URL mappings |
items[].tests[].description STRING Description of this test case |
items[].tests[].host STRING Host portion of the URL |
items[].tests[].path STRING Path portion of the URL |
items[].tests[].service STRING Expected BackendService resource the given URL should be mapped to |
kind STRING Type of resource |
nextPageToken STRING [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results |
selfLink STRING [Output Only] Server-defined URL for this resource |
warning OBJECT [Output Only] Informational warning message |
warning.code ENUMERATION [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warning.data[] OBJECT |
warning.data[].key STRING [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 scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding) |
warning.data[].value STRING [Output Only] A warning data value corresponding to the key |
warning.message STRING [Output Only] A human-readable description of the warning code |