2023-09-07
▼ ▲ compute.backendServices.listUsable
Flat Path: projects/{project}/global/backendServices/listUsable
Description: Retrieves an aggregated list of all usable backend services in the specified project.
Parameters:
pageToken
Type: string
Description: Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Location: query
maxResults
Description: 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`)
Minimum: 0
Format: uint32
Default: 500
Type: integer
Location: query
returnPartialSuccess
Type: boolean
Location: query
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
orderBy
Type: string
Location: query
Description: 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.
filter
Location: query
Type: string
Description: A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
project
Type: string
Location: path
Required: Yes
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Scopes:
Path: projects/{project}/global/backendServices/listUsable
HTTP Method: GET
Parameter Order: project
▼ ▲ compute.routers.deleteRoutePolicy
Description: Deletes Route Policy
Parameters:
region
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Required: Yes
Description: Name of the region for this request.
policy
Type: string
Description: The Policy name for this request. Name must conform to RFC1035
Location: query
requestId
Location: query
Type: string
Description: 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 ( 00000000-0000-0000-0000-000000000000).
project
Description: Project ID for this request.
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Location: path
router
Description: Name of the Router resource where Route Policy is defined.
Required: Yes
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Parameter Order:
Flat Path: projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy
HTTP Method: POST
Path: projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy
Scopes:
▼ ▲ compute.routers.updateRoutePolicy
Parameters:
requestId
Description: 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 ( 00000000-0000-0000-0000-000000000000).
Location: query
Type: string
region
Location: path
Description: Name of the region for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Type: string
router
Description: Name of the Router resource where Route Policy is defined.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Type: string
Required: Yes
project
Required: Yes
Location: path
Type: string
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Path: projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy
Scopes:
Description: Updates or creates new Route Policy
Flat Path: projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy
Parameter Order:
HTTP Method: POST
▼ ▲ compute.routers.listRoutePolicies
Scopes:
Parameter Order:
HTTP Method: GET
Description: Retrieves a list of router route policy subresources available to the specified project.
Path: projects/{project}/regions/{region}/routers/{router}/listRoutePolicies
Parameters:
orderBy
Description: 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.
Location: query
Type: string
project
Required: Yes
Location: path
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description: Project ID for this request.
Type: string
filter
Location: query
Description: A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
Type: string
maxResults
Type: integer
Description: 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`)
Format: uint32
Location: query
Minimum: 0
Default: 500
router
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Description: Name or id of the resource for this request. Name should conform to RFC1035.
Required: Yes
Location: path
returnPartialSuccess
Type: boolean
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Location: query
pageToken
Description: Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Location: query
Type: string
region
Required: Yes
Location: path
Description: Name of the region for this request.
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Flat Path: projects/{project}/regions/{region}/routers/{router}/listRoutePolicies
▼ ▲ compute.routers.listBgpRoutes
Parameters:
destinationPrefix
Location: query
Description: Limit results to destinations that are subnets of this CIDR range
Type: string
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Location: path
Description: Project ID for this request.
Required: Yes
routeType
Type: string
Enum Descriptions:
Location: query
Default: UNSPECIFIED_ROUTE_TYPE
Enum:
Description: (Required) limit results to this type of route (either LEARNED or ADVERTISED)
router
Required: Yes
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description: Name or id of the resource for this request. Name should conform to RFC1035.
Type: string
filter
Description: A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
Location: query
Type: string
peer
Location: query
Type: string
Description: (Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.
maxResults
Description: 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`)
Minimum: 0
Type: integer
Default: 500
Location: query
Format: uint32
orderBy
Description: 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.
Location: query
Type: string
addressFamily
Type: string
Description: (Required) limit results to this address family (either IPv4 or IPv6)
Enum:
Location: query
Enum Descriptions:
Default: UNSPECIFIED_IP_VERSION
returnPartialSuccess
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Type: boolean
Location: query
pageToken
Type: string
Description: Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Location: query
policyApplied
Description: When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.
Default: true
Type: boolean
Location: query
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Description: Name of the region for this request.
Required: Yes
Type: string
Scopes:
HTTP Method: GET
Description: Retrieves a list of router bgp routes available to the specified project.
Flat Path: projects/{project}/regions/{region}/routers/{router}/listBgpRoutes
Parameter Order:
Path: projects/{project}/regions/{region}/routers/{router}/listBgpRoutes
▼ ▲ compute.routers.getRoutePolicy
Parameters:
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Type: string
Description: Project ID for this request.
Location: path
router
Type: string
Location: path
Required: Yes
Description: Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.
policy
Location: query
Description: The Policy name for this request. Name must conform to RFC1035
Type: string
region
Location: path
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: Name of the region for this request.
Required: Yes
Path: projects/{project}/regions/{region}/routers/{router}/getRoutePolicy
Flat Path: projects/{project}/regions/{region}/routers/{router}/getRoutePolicy
Parameter Order:
Scopes:
HTTP Method: GET
Description: Returns specified Route Policy
▼ ▲ compute.regionNetworkFirewallPolicies.addAssociation
Parameters:
associatedPolicyToBeReplaced
Location: query
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Description: Name of the firewall policy associated with the target network to swap association with. This field is mutually exclusive with 'replace_existing_association'.
▼ ▲ compute.resourcePolicies.getNetworkCapacityConstraints
Description: Returns the network capacity constraints for the specified placement policies.
Parameters:
resourcePolicies
Description: Partial or full URL of the resource policies for which to retrieve the network capacity constraints.
Type: string
Repeated: Yes
Location: query
region
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Location: path
Description: Name of the region for this request.
Required: Yes
project
Location: path
Required: Yes
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Description: Project ID for this request.
Flat Path: projects/{project}/regions/{region}/resourcePolicies/getNetworkCapacityConstraints
Path: projects/{project}/regions/{region}/resourcePolicies/getNetworkCapacityConstraints
Parameter Order:
Scopes:
HTTP Method: POST