2025-08-06
▼ ▲ compute.regionHealthAggregationPolicies.aggregatedList
Path : projects/{project}/aggregated/healthAggregationPolicies
Flat Path : projects/{project}/aggregated/healthAggregationPolicies
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
includeAllScopes
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.
Location : query
Type : boolean
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 : Name of the project scoping 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
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
serviceProjectNumber
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
Type : string
Format : int64
Parameter Order : project
Scopes :
Description : Retrieves the list of all HealthAggregationPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
▼ ▲ compute.reservationSubBlocks.reportFaulty
Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
Flat Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
HTTP Method : POST
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
Required : Yes
Type : string
project
Description : Project ID for this request.
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
reservationSubBlock
Description : The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.
Location : path
Required : Yes
Type : string
zone
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes :
Description : Allows customers to report a faulty subBlock.
▼ ▲ compute.haControllers.get
Path : projects/{project}/regions/{region}/haControllers/{haController}
Flat Path : projects/{project}/regions/{region}/haControllers/{haController}
HTTP Method : GET
Parameters :
haController
Description : Name of the HaController resource to return.
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
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
Parameter Order :
Scopes :
Description : Returns all the details of a specific HaController.
▼ ▲ compute.haControllers.insert
Path : projects/{project}/regions/{region}/haControllers
Flat Path : projects/{project}/regions/{region}/haControllers
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.
Location : query
Type : string
Parameter Order :
Scopes :
Description : Creates HaController in the specified project.
▼ ▲ compute.haControllers.patch
Path : projects/{project}/regions/{region}/haControllers/{haController}
Flat Path : projects/{project}/regions/{region}/haControllers/{haController}
HTTP Method : PATCH
Parameters :
haController
Description : ID of the HaController resource to update.
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
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.
Location : query
Type : string
updateMask
Description : update_mask indicates fields to be updated as part of this request.
Location : query
Type : string
Format : google-fieldmask
Parameter Order :
Scopes :
Description : Updates HaController in the specified project.
▼ ▲ compute.haControllers.delete
Path : projects/{project}/regions/{region}/haControllers/{haController}
Flat Path : projects/{project}/regions/{region}/haControllers/{haController}
HTTP Method : DELETE
Parameters :
haController
Description : Name of the HaController resource to delete.
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
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.
Location : query
Type : string
Parameter Order :
Scopes :
Description : Deletes an HaController in the specified project.
▼ ▲ compute.haControllers.list
Path : projects/{project}/regions/{region}/haControllers
Flat Path : projects/{project}/regions/{region}/haControllers
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
Parameter Order :
Scopes :
Description : Lists all HaControllers in the specified project in the specified region.
▼ ▲ compute.regionHealthAggregationPolicies.aggregatedList
Path : projects/{project}/aggregated/healthAggregationPolicies
Flat Path : projects/{project}/aggregated/healthAggregationPolicies
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
includeAllScopes
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.
Location : query
Type : boolean
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 : Name of the project scoping 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
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
serviceProjectNumber
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
Type : string
Format : int64
Parameter Order : project
Scopes :
Description : Retrieves the list of all HealthAggregationPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
▼ ▲ compute.reservationSubBlocks.reportFaulty
Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
Flat Path : projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
HTTP Method : POST
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
Required : Yes
Type : string
project
Description : Project ID for this request.
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
reservationSubBlock
Description : The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.
Location : path
Required : Yes
Type : string
zone
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes :
Description : Allows customers to report a faulty subBlock.
▼ ▲ compute.haControllers.get
Path : projects/{project}/regions/{region}/haControllers/{haController}
Flat Path : projects/{project}/regions/{region}/haControllers/{haController}
HTTP Method : GET
Parameters :
haController
Description : Name of the HaController resource to return.
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
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
Parameter Order :
Scopes :
Description : Returns all the details of a specific HaController.
▼ ▲ compute.haControllers.insert
Path : projects/{project}/regions/{region}/haControllers
Flat Path : projects/{project}/regions/{region}/haControllers
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.
Location : query
Type : string
Parameter Order :
Scopes :
Description : Creates HaController in the specified project.
▼ ▲ compute.haControllers.patch
Path : projects/{project}/regions/{region}/haControllers/{haController}
Flat Path : projects/{project}/regions/{region}/haControllers/{haController}
HTTP Method : PATCH
Parameters :
haController
Description : ID of the HaController resource to update.
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
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.
Location : query
Type : string
updateMask
Description : update_mask indicates fields to be updated as part of this request.
Location : query
Type : string
Format : google-fieldmask
Parameter Order :
Scopes :
Description : Updates HaController in the specified project.
▼ ▲ compute.haControllers.delete
Path : projects/{project}/regions/{region}/haControllers/{haController}
Flat Path : projects/{project}/regions/{region}/haControllers/{haController}
HTTP Method : DELETE
Parameters :
haController
Description : Name of the HaController resource to delete.
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
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.
Location : query
Type : string
Parameter Order :
Scopes :
Description : Deletes an HaController in the specified project.
▼ ▲ compute.haControllers.list
Path : projects/{project}/regions/{region}/haControllers
Flat Path : projects/{project}/regions/{region}/haControllers
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
Parameter Order :
Scopes :
Description : Lists all HaControllers in the specified project in the specified region.