Compute Engine API (compute:v1)

2024-02-22

18 new methods

Additions

    Methods
  • compute.instantSnapshots.list

      Path : projects/{project}/zones/{zone}/instantSnapshots

      Flat Path : projects/{project}/zones/{zone}/instantSnapshots

      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

        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

        zone

          Description : The name of the zone for this request.

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • project
    • zone
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Retrieves the list of InstantSnapshot resources contained within the specified zone.

  • compute.instantSnapshots.get

      Path : projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}

      Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}

      HTTP Method : GET

      Parameters :

        instantSnapshot

          Description : Name of the InstantSnapshot 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

        zone

          Description : The name of the zone for this request.

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • project
    • zone
    • instantSnapshot
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Returns the specified InstantSnapshot resource in the specified zone.

  • compute.instantSnapshots.insert

      Path : projects/{project}/zones/{zone}/instantSnapshots

      Flat Path : projects/{project}/zones/{zone}/instantSnapshots

      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

        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

        zone

          Description : Name of the zone for this request.

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • project
    • zone
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description : Creates an instant snapshot in the specified zone.

  • compute.instantSnapshots.setLabels

      Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels

      Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels

      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

        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

        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}

          Location : path

          Required : Yes

          Type : string

        zone

          Description : The name of the zone for this request.

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • project
    • zone
    • resource
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description : Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation.

  • compute.instantSnapshots.delete

      Path : projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}

      Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}

      HTTP Method : DELETE

      Parameters :

        instantSnapshot

          Description : Name of the InstantSnapshot resource to delete.

          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

        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

        zone

          Description : The name of the zone for this request.

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • project
    • zone
    • instantSnapshot
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • 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.

  • compute.instantSnapshots.getIamPolicy

      Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy

      Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy

      HTTP Method : GET

      Parameters :

        optionsRequestedPolicyVersion

          Description : Requested IAM Policy version.

          Location : query

          Type : integer

          Format : int32

        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

        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}

          Location : path

          Required : Yes

          Type : string

        zone

          Description : The name of the zone for this request.

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • project
    • zone
    • resource
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.

  • compute.instantSnapshots.setIamPolicy

      Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy

      Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy

      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

        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}

          Location : path

          Required : Yes

          Type : string

        zone

          Description : The name of the zone for this request.

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • project
    • zone
    • resource
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description : Sets the access control policy on the specified resource. Replaces any existing policy.

  • compute.instantSnapshots.testIamPermissions

      Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions

      Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions

      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

        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}

          Location : path

          Required : Yes

          Type : string

        zone

          Description : The name of the zone for this request.

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • project
    • zone
    • resource
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Returns permissions that a caller has on the specified resource.

  • compute.instantSnapshots.aggregatedList

      Path : projects/{project}/aggregated/instantSnapshots

      Flat Path : projects/{project}/aggregated/instantSnapshots

      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 : 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

        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 :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.

  • compute.regionInstantSnapshots.list

      Path : projects/{project}/regions/{region}/instantSnapshots

      Flat Path : projects/{project}/regions/{region}/instantSnapshots

      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 : The 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 :

    • project
    • region
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Retrieves the list of InstantSnapshot resources contained within the specified region.

  • compute.regionInstantSnapshots.get

      Path : projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}

      Flat Path : projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}

      HTTP Method : GET

      Parameters :

        instantSnapshot

          Description : Name of the InstantSnapshot 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 : The 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 :

    • project
    • region
    • instantSnapshot
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Returns the specified InstantSnapshot resource in the specified region.

  • compute.regionInstantSnapshots.insert

      Path : projects/{project}/regions/{region}/instantSnapshots

      Flat Path : projects/{project}/regions/{region}/instantSnapshots

      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. 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

      Parameter Order :

    • project
    • region
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description : Creates an instant snapshot in the specified region.

  • compute.regionInstantSnapshots.setLabels

      Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels

      Flat Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels

      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 : 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. 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

        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}

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • project
    • region
    • resource
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description : Sets the labels on a instantSnapshot in the given region. To learn more about labels, read the Labeling Resources documentation.

  • compute.regionInstantSnapshots.delete

      Path : projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}

      Flat Path : projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}

      HTTP Method : DELETE

      Parameters :

        instantSnapshot

          Description : Name of the InstantSnapshot resource to delete.

          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 : The 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. 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

      Parameter Order :

    • project
    • region
    • instantSnapshot
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • 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.

  • compute.regionInstantSnapshots.getIamPolicy

      Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy

      Flat Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy

      HTTP Method : GET

      Parameters :

        optionsRequestedPolicyVersion

          Description : Requested IAM Policy version.

          Location : query

          Type : integer

          Format : int32

        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 : The name of the region for this request.

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Location : path

          Required : Yes

          Type : string

        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}

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • project
    • region
    • resource
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.

  • compute.regionInstantSnapshots.setIamPolicy

      Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy

      Flat Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy

      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 : The name of the region for this request.

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Location : path

          Required : Yes

          Type : string

        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}

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • project
    • region
    • resource
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description : Sets the access control policy on the specified resource. Replaces any existing policy.

  • compute.regionInstantSnapshots.testIamPermissions

      Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions

      Flat Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions

      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 : The name of the region for this request.

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Location : path

          Required : Yes

          Type : string

        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}

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • project
    • region
    • resource
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Returns permissions that a caller has on the specified resource.

  • compute.projects.setCloudArmorTier

      Path : projects/{project}/setCloudArmorTier

      Flat Path : projects/{project}/setCloudArmorTier

      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

        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

      Parameter Order : project

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description : Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the billing account of the project must be subscribed to Cloud Armor Enterprise. See Subscribing to Cloud Armor Enterprise for more information.