2026-02-21
▼ ▲ compute.regionHealthAggregationPolicies.insert
Parameters :
requestId
Type : string
Location : query
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.
Required : Yes
Type : string
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])?))
region
Type : string
Location : path
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Create a HealthAggregationPolicy in the specified project in the given region using the parameters that are included in the request.
Scopes :
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies
HTTP Method : POST
Parameter Order :
Path : projects/{project}/regions/{region}/healthAggregationPolicies
▼ ▲ compute.regionHealthAggregationPolicies.patch
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Parameters :
healthAggregationPolicy
Required : Yes
Location : path
Description : Name of the HealthAggregationPolicy to update. The name must be 1-63 characters long, and comply with RFC1035.
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).
Type : string
Location : query
region
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
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])?))
Location : path
Description : Project ID for this request.
Type : string
Required : Yes
Parameter Order :
Description : Updates the specified regional HealthAggregationPolicy resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
HTTP Method : PATCH
Scopes :
▼ ▲ compute.regionHealthAggregationPolicies.delete
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
HTTP Method : DELETE
Scopes :
Description : Deletes the specified HealthAggregationPolicy in the given region.
Parameters :
healthAggregationPolicy
Description : Name of the HealthAggregationPolicy resource to delete.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
region
Type : string
Location : path
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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).
Type : string
Location : query
project
Description : Project ID for this request.
Type : string
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])?))
Parameter Order :
▼ ▲ compute.regionHealthAggregationPolicies.get
Parameter Order :
HTTP Method : GET
Description : Returns the specified HealthAggregationPolicy resource in the given region.
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Scopes :
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Parameters :
region
Type : string
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
healthAggregationPolicy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the HealthAggregationPolicy resource to return.
Type : string
Location : path
project
Required : Yes
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])?))
Location : path
Description : Project ID for this request.
▼ ▲ compute.regionHealthAggregationPolicies.testIamPermissions
HTTP Method : POST
Parameter Order :
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Scopes :
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions
Parameters :
region
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Required : Yes
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])?))
Type : string
Location : path
Required : Yes
resource
Description : Name or id of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
▼ ▲ compute.regionHealthAggregationPolicies.aggregatedList
HTTP Method : GET
Flat Path : projects/{project}/aggregated/healthAggregationPolicies
Parameters :
pageToken
Location : query
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.
Type : string
returnPartialSuccess
Location : query
Type : boolean
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.
serviceProjectNumber
Location : query
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Format : int64
Type : string
filter
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. 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 onresource 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 GoogleRE2 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
project
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 : Name of the project scoping this request.
Type : string
Required : Yes
maxResults
Location : query
Format : uint32
Default : 500
Minimum : 0
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`)
Type : integer
orderBy
Type : string
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
includeAllScopes
Type : boolean
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Path : projects/{project}/aggregated/healthAggregationPolicies
Parameter Order : project
Description : Retrieves the list of all HealthAggregationPolicy resources, regional and global, available to the specified project. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Scopes :
▼ ▲ compute.regionHealthAggregationPolicies.list
Description : Lists the HealthAggregationPolicies for a project in the given region.
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies
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
region
Required : Yes
Type : string
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
filter
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. 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 onresource 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 GoogleRE2 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
returnPartialSuccess
Location : query
Type : boolean
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.
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.
maxResults
Format : uint32
Location : query
Type : integer
Minimum : 0
Default : 500
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`)
project
Required : Yes
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])?))
Location : path
Path : projects/{project}/regions/{region}/healthAggregationPolicies
HTTP Method : GET
▼ ▲ compute.reservationSubBlocks.list
Parameters :
parentName
Type : string
Required : Yes
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Location : path
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks ⟶ projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks
Flat Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks ⟶ projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks
▼ ▲ compute.reservationSubBlocks.reportFaulty
Parameters :
parentName
Location : path
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Required : Yes
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Type : string
Flat Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty ⟶ projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty ⟶ projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
▼ ▲ compute.reservationSubBlocks.performMaintenance
Parameters :
parentName
Required : Yes
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Location : path
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Type : string
Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance ⟶ projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance
Flat Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance ⟶ projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/performMaintenance
▼ ▲ compute.reservationSubBlocks.get
Parameters :
parentName
Location : path
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Type : string
Required : Yes
Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock} ⟶ projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}
Flat Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock} ⟶ projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}
▼ ▲ compute.reservationSubBlocks.setIamPolicy
Path : projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy ⟶ projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/setIamPolicy
Flat Path : projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy ⟶ projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/setIamPolicy
▼ ▲ compute.reservationSubBlocks.getIamPolicy
Flat Path : projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy ⟶ projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/getIamPolicy
Path : projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy ⟶ projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/getIamPolicy
▼ ▲ compute.reservationSubBlocks.testIamPermissions
Path : projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions ⟶ projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/testIamPermissions
Flat Path : projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions ⟶ projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/testIamPermissions