2024-03-24
▼ ▲ compute.instances.patchPartnerMetadata
Path: projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata
Flat Path: projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata
HTTP Method: POST
Parameters:
instance
Description: Name of the instance scoping this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
project
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])?))
Location: path
Required: Yes
Type: string
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
zone
Description: The name of the zone for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Patches partner metadata of the specified instance.
▼ ▲ compute.instances.getPartnerMetadata
Path: projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata
Flat Path: projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata
HTTP Method: GET
Parameters:
instance
Description: Name of the instance scoping this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
namespaces
Description: Comma separated partner metadata namespaces.
Location: query
Type: string
project
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])?))
Location: path
Required: Yes
Type: string
zone
Description: The name of the zone for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Gets partner metadata of the specified instance and namespaces.
▼ ▲ compute.routers.updateRoutePolicy
Path: projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy
Flat Path: projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy
HTTP Method: POST
Parameters:
project
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])?))
Location: path
Required: Yes
Type: string
region
Description: Name of the region for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Required: Yes
Type: string
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
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
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Updates or creates new Route Policy
▼ ▲ compute.routers.deleteRoutePolicy
Path: projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy
Flat Path: projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy
HTTP Method: POST
Parameters:
policy
Description: The Policy name for this request. Name must conform to RFC1035
Location: query
Type: string
project
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])?))
Location: path
Required: Yes
Type: string
region
Description: Name of the region for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Required: Yes
Type: string
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
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
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Deletes Route Policy
▼ ▲ compute.routers.getRoutePolicy
Path: projects/{project}/regions/{region}/routers/{router}/getRoutePolicy
Flat Path: projects/{project}/regions/{region}/routers/{router}/getRoutePolicy
HTTP Method: GET
Parameters:
policy
Description: The Policy name for this request. Name must conform to RFC1035
Location: query
Type: string
project
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])?))
Location: path
Required: Yes
Type: string
region
Description: Name of the region for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Required: Yes
Type: string
router
Description: Name of the Router resource to query for the route policy. The name should conform to RFC1035.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Returns specified Route Policy
▼ ▲ compute.routers.listRoutePolicies
Path: projects/{project}/regions/{region}/routers/{router}/listRoutePolicies
Flat Path: projects/{project}/regions/{region}/routers/{router}/listRoutePolicies
HTTP Method: GET
Parameters:
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. These two types of filter expressions cannot be mixed in one request. 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 `:*` 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`. You cannot combine constraints on multiple fields using regular expressions.
Location: query
Type: string
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`)
Default: 500
Minimum: 0
Location: query
Type: integer
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
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
project
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])?))
Location: path
Required: Yes
Type: string
region
Description: Name of the region for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Required: Yes
Type: string
returnPartialSuccess
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Location: query
Type: boolean
router
Description: Name or id of the resource for this request. Name should conform to RFC1035.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Retrieves a list of router route policy subresources available to the specified project.
▼ ▲ compute.routers.listBgpRoutes
Path: projects/{project}/regions/{region}/routers/{router}/listBgpRoutes
Flat Path: projects/{project}/regions/{region}/routers/{router}/listBgpRoutes
HTTP Method: GET
Parameters:
addressFamily
Description: (Required) limit results to this address family (either IPv4 or IPv6)
Default: UNSPECIFIED_IP_VERSION
Location: query
Type: string
Enum Descriptions:
Enum:
destinationPrefix
Description: Limit results to destinations that are subnets of this CIDR range
Location: query
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. These two types of filter expressions cannot be mixed in one request. 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 `:*` 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`. You cannot combine constraints on multiple fields using regular expressions.
Location: query
Type: string
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`)
Default: 500
Minimum: 0
Location: query
Type: integer
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
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
peer
Description: (Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.
Location: query
Type: string
policyApplied
Description: When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.
Default: true
Location: query
Type: boolean
project
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])?))
Location: path
Required: Yes
Type: string
region
Description: Name of the region for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Required: Yes
Type: string
returnPartialSuccess
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Location: query
Type: boolean
routeType
Description: (Required) limit results to this type of route (either LEARNED or ADVERTISED)
Default: UNSPECIFIED_ROUTE_TYPE
Location: query
Type: string
Enum Descriptions:
Enum:
router
Description: Name or id of the resource for this request. Name should conform to RFC1035.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Retrieves a list of router bgp routes available to the specified project.
▼ ▲ compute.instances.list
Parameters:
view
Description: View of the instance.
Location: query
Type: string
Enum Descriptions:
Enum:
▼ ▲ compute.instances.get
Parameters:
view
Description: View of the instance.
Location: query
Type: string
Enum Descriptions:
Enum:
▼ ▲ compute.instanceTemplates.list
Parameters:
view
Description: View of the instance template.
Location: query
Type: string
Enum Descriptions:
Enum:
▼ ▲ compute.instanceTemplates.get
Parameters:
view
Description: View of the instance template.
Location: query
Type: string
Enum Descriptions:
Enum:
▼ ▲ compute.regionInstanceTemplates.list
Parameters:
view
Description: View of the instance template.
Location: query
Type: string
Enum Descriptions:
Enum:
▼ ▲ compute.regionInstanceTemplates.get
Parameters:
view
Description: View of the instance template.
Location: query
Type: string
Enum Descriptions:
Enum: