2026-02-20
▼ ▲ compute.reservationSubBlocks.get
Parameters :
parentName
Required : Yes
Type : string
Location : path
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock} ⟶ projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock} ⟶ projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}
▼ ▲ compute.reservationSubBlocks.performMaintenance
Parameters :
parentName
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Type : string
Required : Yes
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Location : path
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance ⟶ projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/performMaintenance ⟶ projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance
▼ ▲ compute.reservationSubBlocks.list
Parameters :
parentName
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Required : Yes
Location : path
Type : string
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks ⟶ projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks ⟶ projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks
▼ ▲ compute.reservationSubBlocks.reportFaulty
Parameters :
parentName
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Location : path
Type : string
Required : Yes
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/reportFaulty ⟶ projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty ⟶ projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
▼ ▲ compute.reservationSubBlocks.getIamPolicy
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/getIamPolicy ⟶ projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy
Path : projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/getIamPolicy ⟶ projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy
▼ ▲ compute.reservationSubBlocks.setIamPolicy
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/setIamPolicy ⟶ projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy
Path : projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/setIamPolicy ⟶ projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy
▼ ▲ compute.reservationSubBlocks.testIamPermissions
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/testIamPermissions ⟶ projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions
Path : projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/testIamPermissions ⟶ projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions
▼ ▲ compute.regionHealthAggregationPolicies.testIamPermissions
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions
Scopes :
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions
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])?))
Type : string
Location : path
Required : Yes
resource
Type : string
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.
region
Description : The name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
▼ ▲ compute.regionHealthAggregationPolicies.insert
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies
HTTP Method : POST
Parameters :
requestId
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).
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
region
Description : Name of the region scoping this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Path : projects/{project}/regions/{region}/healthAggregationPolicies
Parameter Order :
Scopes :
Description : Create a HealthAggregationPolicy in the specified project in the given region using the parameters that are included in the request.
▼ ▲ compute.regionHealthAggregationPolicies.get
HTTP Method : GET
Description : Returns the specified HealthAggregationPolicy resource in the given region.
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Required : Yes
Description : Name of the region scoping this request.
healthAggregationPolicy
Type : string
Location : path
Required : Yes
Description : Name of the HealthAggregationPolicy resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Parameter Order :
Scopes :
▼ ▲ compute.regionHealthAggregationPolicies.list
Description : Lists the HealthAggregationPolicies for a project in the given region.
Scopes :
Path : projects/{project}/regions/{region}/healthAggregationPolicies
Parameters :
region
Description : Name of the region scoping this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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
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
Default : 500
Location : query
Type : integer
Format : uint32
filter
Type : string
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. 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.
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])?))
Required : Yes
Location : path
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.
Type : boolean
Location : query
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
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies
Parameter Order :
HTTP Method : GET
▼ ▲ compute.regionHealthAggregationPolicies.patch
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Scopes :
Parameter Order :
HTTP Method : PATCH
Parameters :
healthAggregationPolicy
Required : Yes
Type : string
Location : path
Description : Name of the HealthAggregationPolicy to update. The name must be 1-63 characters long, and comply with RFC1035.
project
Required : Yes
Description : Project ID for this request.
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])?))
Type : string
region
Location : path
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
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.
▼ ▲ compute.regionHealthAggregationPolicies.aggregatedList
HTTP Method : GET
Scopes :
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`.
Parameters :
project
Description : Name of the project scoping this request.
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])?))
Type : string
orderBy
Location : query
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.
returnPartialSuccess
Location : query
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.
Type : boolean
filter
Type : string
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. 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.
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
maxResults
Minimum : 0
Location : query
Format : uint32
Default : 500
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`)
serviceProjectNumber
Location : query
Type : string
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
includeAllScopes
Location : query
Type : boolean
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.
Flat Path : projects/{project}/aggregated/healthAggregationPolicies
Parameter Order : project
Path : projects/{project}/aggregated/healthAggregationPolicies
▼ ▲ compute.regionHealthAggregationPolicies.delete
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Scopes :
HTTP Method : DELETE
Parameter Order :
Description : Deletes the specified HealthAggregationPolicy in the given region.
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Parameters :
healthAggregationPolicy
Required : Yes
Description : Name of the HealthAggregationPolicy resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
requestId
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).
Type : string
project
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
Location : path
Description : Project ID for this request.
region
Description : Name of the region scoping this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
▼ ▲ compute.regionHealthAggregationPolicies.testIamPermissions
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions
Scopes :
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions
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])?))
Type : string
Location : path
Required : Yes
resource
Type : string
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.
region
Description : The name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
▼ ▲ compute.regionHealthAggregationPolicies.insert
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies
HTTP Method : POST
Parameters :
requestId
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).
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
region
Description : Name of the region scoping this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Path : projects/{project}/regions/{region}/healthAggregationPolicies
Parameter Order :
Scopes :
Description : Create a HealthAggregationPolicy in the specified project in the given region using the parameters that are included in the request.
▼ ▲ compute.regionHealthAggregationPolicies.get
HTTP Method : GET
Description : Returns the specified HealthAggregationPolicy resource in the given region.
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Required : Yes
Description : Name of the region scoping this request.
healthAggregationPolicy
Type : string
Location : path
Required : Yes
Description : Name of the HealthAggregationPolicy resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Parameter Order :
Scopes :
▼ ▲ compute.regionHealthAggregationPolicies.list
Description : Lists the HealthAggregationPolicies for a project in the given region.
Scopes :
Path : projects/{project}/regions/{region}/healthAggregationPolicies
Parameters :
region
Description : Name of the region scoping this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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
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
Default : 500
Location : query
Type : integer
Format : uint32
filter
Type : string
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. 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.
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])?))
Required : Yes
Location : path
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.
Type : boolean
Location : query
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
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies
Parameter Order :
HTTP Method : GET
▼ ▲ compute.regionHealthAggregationPolicies.patch
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Scopes :
Parameter Order :
HTTP Method : PATCH
Parameters :
healthAggregationPolicy
Required : Yes
Type : string
Location : path
Description : Name of the HealthAggregationPolicy to update. The name must be 1-63 characters long, and comply with RFC1035.
project
Required : Yes
Description : Project ID for this request.
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])?))
Type : string
region
Location : path
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
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.
▼ ▲ compute.regionHealthAggregationPolicies.aggregatedList
HTTP Method : GET
Scopes :
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`.
Parameters :
project
Description : Name of the project scoping this request.
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])?))
Type : string
orderBy
Location : query
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.
returnPartialSuccess
Location : query
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.
Type : boolean
filter
Type : string
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. 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.
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
maxResults
Minimum : 0
Location : query
Format : uint32
Default : 500
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`)
serviceProjectNumber
Location : query
Type : string
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
includeAllScopes
Location : query
Type : boolean
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.
Flat Path : projects/{project}/aggregated/healthAggregationPolicies
Parameter Order : project
Path : projects/{project}/aggregated/healthAggregationPolicies
▼ ▲ compute.regionHealthAggregationPolicies.delete
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Scopes :
HTTP Method : DELETE
Parameter Order :
Description : Deletes the specified HealthAggregationPolicy in the given region.
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Parameters :
healthAggregationPolicy
Required : Yes
Description : Name of the HealthAggregationPolicy resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
requestId
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).
Type : string
project
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
Location : path
Description : Project ID for this request.
region
Description : Name of the region scoping this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
▼ ▲ compute.reservationSubBlocks.get
Parameters :
parentName
Required : Yes
Type : string
Location : path
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Flat Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock} ⟶ projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}
Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock} ⟶ projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}
▼ ▲ compute.reservationSubBlocks.performMaintenance
Parameters :
parentName
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Type : string
Required : Yes
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Location : path
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.list
Parameters :
parentName
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Required : Yes
Location : path
Type : string
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Flat Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks ⟶ projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks
Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks ⟶ projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks
▼ ▲ compute.reservationSubBlocks.reportFaulty
Parameters :
parentName
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Location : path
Type : string
Required : Yes
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
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.testIamPermissions
Flat Path : projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions ⟶ projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/testIamPermissions
Path : projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions ⟶ projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/testIamPermissions
▼ ▲ compute.reservationSubBlocks.getIamPolicy
Path : projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy ⟶ projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/getIamPolicy
Flat Path : projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy ⟶ projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/getIamPolicy
▼ ▲ compute.reservationSubBlocks.setIamPolicy
Flat Path : projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy ⟶ projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/setIamPolicy
Path : projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy ⟶ projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/setIamPolicy