2023-05-19
▼ ▲ compute.regionInstantSnapshots.list
Parameters:
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
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`.
Type: string
Location: query
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
maxResults
Location: query
Format: uint32
Type: integer
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`)
region
Required: Yes
Location: path
Description: The name of the region for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
project
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
Required: Yes
HTTP Method: GET
Flat Path: projects/{project}/regions/{region}/instantSnapshots
Path: projects/{project}/regions/{region}/instantSnapshots
Parameter Order:
Scopes:
Description: Retrieves the list of InstantSnapshot resources contained within the specified region.
▼ ▲ compute.regionInstantSnapshots.get
Path: projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}
HTTP Method: GET
Scopes:
Flat Path: projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}
Description: Returns the specified InstantSnapshot resource in the specified region.
Parameter Order:
Parameters:
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
region
Type: string
Location: path
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: The name of the region for this request.
instantSnapshot
Type: string
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Description: Name of the InstantSnapshot resource to return.
▼ ▲ compute.regionInstantSnapshots.export
Parameters:
region
Description: The name of the zone for this request.
Type: string
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
requestId
Location: query
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).
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])?))
Type: string
Description: Project ID for this request.
Required: Yes
instantSnapshot
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Location: path
Description: Name of the instant snapshot to export.
Path: projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}/export
Parameter Order:
Flat Path: projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}/export
HTTP Method: POST
Scopes:
Description: Export the changed blocks between two instant snapshots to a customer's bucket in the user specified format.
▼ ▲ compute.regionInstantSnapshots.setIamPolicy
Path: projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
Flat Path: projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy
HTTP Method: POST
Parameters:
project
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
Required: Yes
region
Required: Yes
Location: path
Type: string
Description: The name of the region for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
resource
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.
Required: Yes
Type: string
Scopes:
Parameter Order:
▼ ▲ compute.regionInstantSnapshots.getIamPolicy
Scopes:
Parameter Order:
Flat Path: projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy
HTTP Method: GET
Description: Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Path: projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy
Parameters:
resource
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type: string
Description: Name or id of the resource for this request.
Location: path
region
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Description: The name of the region for this request.
Type: string
optionsRequestedPolicyVersion
Description: Requested IAM Policy version.
Location: query
Format: int32
Type: integer
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
▼ ▲ compute.regionInstantSnapshots.testIamPermissions
HTTP Method: POST
Scopes:
Description: Returns permissions that a caller has on the specified resource.
Path: projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions
Parameter Order:
Parameters:
project
Type: string
Description: Project ID for this request.
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])?))
Location: path
region
Location: path
Description: The name of the region for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Required: Yes
resource
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.
Location: path
Required: Yes
Type: string
Flat Path: projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions
▼ ▲ compute.regionInstantSnapshots.insert
Path: projects/{project}/regions/{region}/instantSnapshots
Description: Creates an instant snapshot in the specified region.
HTTP Method: POST
Flat Path: projects/{project}/regions/{region}/instantSnapshots
Parameter Order:
Scopes:
Parameters:
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.
region
Required: Yes
Description: Name of the region for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Type: string
requestId
Location: query
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).
▼ ▲ compute.regionInstantSnapshots.setLabels
Path: projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels
Parameters:
resource
Type: string
Location: path
Required: Yes
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Required: Yes
Location: path
Type: string
Description: The region for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Type: string
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])?))
Required: Yes
requestId
Location: query
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).
Scopes:
Description: Sets the labels on a instantSnapshot in the given region. To learn more about labels, read the Labeling Resources documentation.
Flat Path: projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels
HTTP Method: POST
Parameter Order:
▼ ▲ compute.regionInstantSnapshots.delete
Parameter Order:
Scopes:
HTTP Method: DELETE
Parameters:
project
Description: Project ID for this request.
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
instantSnapshot
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 of the InstantSnapshot resource to delete.
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
region
Location: path
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: The name of the region for this request.
Type: string
Flat Path: projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}
Description: Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots.
Path: projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}
▼ ▲ compute.instantSnapshots.setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
HTTP Method: POST
Parameter Order:
Path: projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy
Flat Path: projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy
Scopes:
Parameters:
project
Location: path
Description: Project ID for this request.
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])?))
resource
Description: Name or id of the resource for this request.
Type: string
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
zone
Type: string
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description: The name of the zone for this request.
Location: path
▼ ▲ compute.instantSnapshots.getIamPolicy
Parameter Order:
HTTP Method: GET
Scopes:
Flat Path: projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy
Path: projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy
Parameters:
optionsRequestedPolicyVersion
Description: Requested IAM Policy version.
Format: int32
Location: query
Type: integer
zone
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Location: path
Description: The name of the zone for this request.
Required: Yes
resource
Location: path
Required: Yes
Type: string
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Description: Project ID for this request.
Location: path
Required: Yes
Description: Gets the access control policy for a resource. May be empty if no such policy or resource exists.
▼ ▲ compute.instantSnapshots.insert
Description: Creates an instant snapshot in the specified zone.
Scopes:
Parameters:
zone
Required: Yes
Location: path
Type: string
Description: Name of the zone for this request.
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).
Location: query
Type: string
project
Location: path
Type: string
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
Path: projects/{project}/zones/{zone}/instantSnapshots
Flat Path: projects/{project}/zones/{zone}/instantSnapshots
Parameter Order:
HTTP Method: POST
▼ ▲ compute.instantSnapshots.aggregatedList
Path: projects/{project}/aggregated/instantSnapshots
Parameter Order: project
HTTP Method: GET
Description: Retrieves an aggregated list of instantSnapshots.
Scopes:
Flat Path: projects/{project}/aggregated/instantSnapshots
Parameters:
maxResults
Format: uint32
Default: 500
Location: query
Type: integer
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`)
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.
includeAllScopes
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.
Type: boolean
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
returnPartialSuccess
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Type: boolean
Location: query
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
Location: path
Description: Project ID for this request.
Type: string
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])?))
▼ ▲ compute.instantSnapshots.setLabels
Parameter Order:
Flat Path: projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels
Scopes:
Description: Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation.
HTTP Method: POST
Path: projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels
Parameters:
resource
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Type: string
Location: path
zone
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
Required: Yes
Description: The name of the zone for this request.
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.
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
▼ ▲ compute.instantSnapshots.export
Parameter Order:
Flat Path: projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}/export
Description: Export the changed blocks between two instant snapshots to a customer's bucket in the user specified format.
Parameters:
instantSnapshot
Required: Yes
Location: path
Description: Name of the instant snapshot to export.
Type: string
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
zone
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required: Yes
Location: path
Description: The name of the zone for 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])?))
Description: Project ID for this request.
Location: path
Required: Yes
Type: string
Path: projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}/export
Scopes:
HTTP Method: POST
▼ ▲ compute.instantSnapshots.delete
Parameters:
project
Required: Yes
Description: Project ID for this request.
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])?))
zone
Location: path
Required: Yes
Description: The name of the zone for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
instantSnapshot
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 of the InstantSnapshot resource to delete.
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
Description: Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots.
HTTP Method: DELETE
Path: projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}
Flat Path: projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}
Scopes:
Parameter Order:
▼ ▲ compute.instantSnapshots.get
Path: projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}
HTTP Method: GET
Flat Path: projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}
Parameter Order:
Description: Returns the specified InstantSnapshot resource in the specified zone.
Parameters:
zone
Description: The name of the zone for this request.
Type: string
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location: path
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])?))
Required: Yes
Type: string
Description: Project ID for this request.
instantSnapshot
Type: string
Location: path
Description: Name of the InstantSnapshot resource to return.
Required: Yes
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Scopes:
▼ ▲ compute.instantSnapshots.list
Path: projects/{project}/zones/{zone}/instantSnapshots
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`.
Type: string
Location: query
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.
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
Type: string
Location: path
Description: Project ID for this request.
zone
Description: The name of the zone for this request.
Location: path
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Required: Yes
returnPartialSuccess
Type: boolean
Location: query
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
maxResults
Default: 500
Format: uint32
Minimum: 0
Location: query
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`)
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
Parameter Order:
Scopes:
Flat Path: projects/{project}/zones/{zone}/instantSnapshots
Description: Retrieves the list of InstantSnapshot resources contained within the specified zone.
HTTP Method: GET
▼ ▲ compute.instantSnapshots.testIamPermissions
Description: Returns permissions that a caller has on the specified resource.
HTTP Method: POST
Scopes:
Parameter Order:
Flat Path: projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions
Parameters:
resource
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required: Yes
Location: path
Type: string
project
Description: Project ID for this request.
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
zone
Description: The name of the zone for this request.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type: string
Required: Yes
Location: path
Path: projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions