2023-08-21
▼ ▲ compute.instanceSettings.get
HTTP Method: GET
Scopes:
Description: Get Instance settings.
Parameters:
zone
Description: Name of the zone for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Location: path
Type: string
project
Description: Project ID for this request.
Type: string
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])?))
Parameter Order:
Path: projects/{project}/zones/{zone}/instanceSettings
Flat Path: projects/{project}/zones/{zone}/instanceSettings
▼ ▲ compute.instanceSettings.patch
Flat Path: projects/{project}/zones/{zone}/instanceSettings
Parameters:
zone
Required: Yes
Location: path
Description: The zone scoping this request. It should conform to 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
updateMask
Location: query
Type: string
Description: update_mask indicates fields to be updated as part of this request.
Format: google-fieldmask
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])?))
Description: Project ID for this request.
Type: string
Required: Yes
Location: path
Parameter Order:
Path: projects/{project}/zones/{zone}/instanceSettings
Scopes:
HTTP Method: PATCH
Description: Patch Instance settings
▼ ▲ compute.futureReservations.get
Path: projects/{project}/zones/{zone}/futureReservations/{futureReservation}
HTTP Method: GET
Flat Path: projects/{project}/zones/{zone}/futureReservations/{futureReservation}
Parameter Order:
Parameters:
futureReservation
Type: string
Location: path
Description: Name of the future reservation to retrieve. Name should conform to RFC1035.
Required: Yes
project
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Description: Project ID for this request.
Location: path
Type: string
zone
Required: Yes
Description: Name of the zone for this request. Name should conform to RFC1035.
Location: path
Type: string
Scopes:
Description: Retrieves information about the specified future reservation.
▼ ▲ compute.futureReservations.delete
HTTP Method: DELETE
Flat Path: projects/{project}/zones/{zone}/futureReservations/{futureReservation}
Parameters:
futureReservation
Required: Yes
Description: Name of the future reservation to retrieve. Name should conform to RFC1035.
Location: path
Type: string
zone
Required: Yes
Description: Name of the zone for this request. Name should conform to RFC1035.
Type: string
Location: path
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
Location: path
Description: Project ID for this request.
Type: string
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required: Yes
Parameter Order:
Path: projects/{project}/zones/{zone}/futureReservations/{futureReservation}
Scopes:
Description: Deletes the specified future reservation.
▼ ▲ compute.futureReservations.list
Flat Path: projects/{project}/zones/{zone}/futureReservations
HTTP Method: GET
Parameters:
maxResults
Description: The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Minimum: 0
Format: uint32
Default: 500
Location: query
Type: integer
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.
pageToken
Type: string
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.
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.
Type: string
Location: query
zone
Required: Yes
Description: Name of the zone for this request. Name should conform to RFC1035.
Location: path
Type: string
filter
Description: A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
Location: query
Type: string
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
Path: projects/{project}/zones/{zone}/futureReservations
Parameter Order:
Scopes:
Description: A list of all the future reservations that have been configured for the specified project in specified zone.
▼ ▲ compute.futureReservations.update
Parameter Order:
Parameters:
futureReservation
Type: string
Required: Yes
Location: path
Description: Name of the reservation to update. Name should conform to RFC1035.
requestId
Type: string
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
paths
Type: string
Location: query
Repeated: Yes
project
Location: path
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])?))
Description: Project ID for this request.
Required: Yes
updateMask
Location: query
Description: update_mask indicates fields to be updated as part of this request.
Type: string
Format: google-fieldmask
zone
Description: Name of the zone for this request. Name should conform to RFC1035.
Required: Yes
Location: path
Type: string
Path: projects/{project}/zones/{zone}/futureReservations/{futureReservation}
Description: Updates the specified future reservation.
Flat Path: projects/{project}/zones/{zone}/futureReservations/{futureReservation}
HTTP Method: PATCH
Scopes:
▼ ▲ compute.futureReservations.insert
Flat Path: projects/{project}/zones/{zone}/futureReservations
Path: projects/{project}/zones/{zone}/futureReservations
Description: Creates a new Future Reservation.
HTTP Method: POST
Parameters:
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
Type: string
project
Required: Yes
Location: path
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
zone
Required: Yes
Description: Name of the zone for this request. Name should conform to RFC1035.
Location: path
Type: string
Parameter Order:
Scopes:
▼ ▲ compute.futureReservations.cancel
Parameter Order:
HTTP Method: POST
Description: Cancel the specified future reservation.
Flat Path: projects/{project}/zones/{zone}/futureReservations/{futureReservation}/cancel
Path: projects/{project}/zones/{zone}/futureReservations/{futureReservation}/cancel
Scopes:
Parameters:
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Location: query
Type: string
futureReservation
Type: string
Description: Name of the future reservation to retrieve. Name should conform to RFC1035.
Location: path
Required: Yes
zone
Required: Yes
Description: Name of the zone for this request. Name should conform to RFC1035.
Location: path
Type: string
project
Location: path
Required: Yes
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type: string
Description: Project ID for this request.
▼ ▲ compute.futureReservations.aggregatedList
Path: projects/{project}/aggregated/futureReservations
HTTP Method: GET
Description: Retrieves an aggregated list of future reservations.
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. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
Location: query
Type: string
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.
project
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])?))
Description: Project ID for this request.
returnPartialSuccess
Location: query
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Type: boolean
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.
Type: string
Location: query
maxResults
Location: query
Minimum: 0
Default: 500
Format: uint32
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
pageToken
Location: query
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.
Scopes:
Flat Path: projects/{project}/aggregated/futureReservations
Parameter Order: project