Compute Engine API (compute:beta)

2025-10-24

8 new methods | 3 updated methods

Additions

    Methods
  • compute.instanceGroupManagers.getAvailableAcceleratorTopologies

      HTTP Method : GET

      Parameter Order :

    • project
    • zone
    • resourceId
    • Parameters :

        zone

          Required : Yes

          Description : Required. The name of thezone where the managed instance group is located. Name should conform to RFC1035.

          Type : string

          Location : path

        resourceId

          Description : Required. The name of the managed instance group. It should conform to RFC1035.

          Location : path

          Required : Yes

          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 : Required. Project ID for this request.

          Required : Yes

          Location : path

          Type : string

      Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{resourceId}/getAvailableAcceleratorTopologies

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Returns information about available accelerator topologies for a given MIG.

      Path : projects/{project}/zones/{zone}/instanceGroupManagers/{resourceId}/getAvailableAcceleratorTopologies

  • compute.zoneVmExtensionPolicies.list

      HTTP Method : GET

      Description : Lists all VM extension policies within a specific zone for a project.

      Parameters :

        returnPartialSuccess

          Location : query

          Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

          Type : boolean

        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.

        filter

          Location : query

          Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

          Type : string

        zone

          Required : Yes

          Type : string

          Location : path

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

          Description : Name of the zone for this request.

        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

        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`)

          Format : uint32

          Minimum : 0

          Type : integer

          Location : query

          Default : 500

        project

          Location : path

          Required : Yes

          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

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

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

      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
  • compute.zoneVmExtensionPolicies.delete

      Parameter Order :

    • project
    • zone
    • vmExtensionPolicy
    • Parameters :

        zone

          Type : string

          Required : Yes

          Description : Name of the zone for this request.

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

          Location : path

        project

          Description : Project ID for this request.

          Location : path

          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])?))

        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

        vmExtensionPolicy

          Required : Yes

          Description : Name of the zone VM extension policy to delete.

          Location : path

          Type : string

      Description : Deletes a specified zone VM extension policy.

      Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}

      HTTP Method : DELETE

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}

  • compute.zoneVmExtensionPolicies.get

      HTTP Method : GET

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}

      Description : Retrieves details of a specific zone VM extension policy.

      Parameters :

        project

          Type : string

          Required : Yes

          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

        vmExtensionPolicy

          Location : path

          Required : Yes

          Type : string

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

          Description : Name of the VM extension policy resource to return.

        zone

          Location : path

          Description : Name of the zone for this request.

          Required : Yes

          Type : string

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

      Parameter Order :

    • project
    • zone
    • vmExtensionPolicy
    • Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}

  • compute.zoneVmExtensionPolicies.update

      Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}

      Parameters :

        vmExtensionPolicy

          Required : Yes

          Location : path

          Type : string

          Description : Name of the zone VM extension policy to update.

        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

          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

          Required : Yes

          Description : Project ID for this request.

        zone

          Location : path

          Required : Yes

          Description : Name of the zone for this request.

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

          Type : string

      HTTP Method : PATCH

      Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}

      Parameter Order :

    • project
    • zone
    • vmExtensionPolicy
    • Description : Modifies an existing zone VM extension policy.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
  • compute.zoneVmExtensionPolicies.insert

      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])?))

          Required : Yes

          Type : string

          Description : Project ID for this request.

          Location : path

        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.

          Required : Yes

          Type : string

          Location : path

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

      Description : Creates a new zone-level VM extension policy within a project.

      Parameter Order :

    • project
    • zone
    • Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • HTTP Method : POST

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

  • compute.globalVmExtensionPolicies.get

      HTTP Method : GET

      Flat Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Parameter Order :

    • project
    • globalVmExtensionPolicy
    • Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}

      Parameters :

        globalVmExtensionPolicy

          Type : string

          Required : Yes

          Location : path

          Description : Name of the GlobalVmExtensionPolicy resource to return.

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

        project

          Required : Yes

          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])?))

      Description : Gets details of a global VM extension policy.

  • compute.globalVmExtensionPolicies.aggregatedList

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Flat Path : projects/{project}/aggregated/vmExtensionPolicies

      Path : projects/{project}/aggregated/vmExtensionPolicies

      Parameters :

        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.

          Type : string

          Location : query

        serviceProjectNumber

          Type : string

          Location : query

          Format : int64

          Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

        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

          Required : Yes

          Description : Name of the project scoping this request.

          Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

          Location : path

          Type : string

        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

        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 onresource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

          Type : string

          Location : query

        returnPartialSuccess

          Location : query

          Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

          Type : boolean

        maxResults

          Default : 500

          Minimum : 0

          Location : query

          Type : integer

          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`)

      Parameter Order : project

      Description : Retrieves the list of all VM Extension Policy resources available to the specified project. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`.

      HTTP Method : GET

Updates

    Methods
  • compute.subnetworks.aggregatedList

      Parameters :

        views

          Location : query

          Enum :

        • DEFAULT
        • WITH_UTILIZATION
        • Description : Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response.

          Enum Descriptions :

        • Utilization data is included in the response.
        • Type : string

          Repeated : Yes

  • compute.reservationSubBlocks.get

      Parameters :

        view

          Type : string

          Description : View of the subBlock.

          Enum :

        • SUB_BLOCK_VIEW_BASIC
        • SUB_BLOCK_VIEW_FULL
        • SUB_BLOCK_VIEW_UNSPECIFIED
        • Enum Descriptions :

        • This view includes basic information about the reservation sub block
        • Includes detailed topology view.
        • The default / unset value. The API will default to the BASIC view.
        • Location : query

  • compute.firewallPolicies.listAssociations

      Parameters :

        includeInheritedPolicies

          Description : If set to "true", the response will contain a list of all associations for the containing folders and the containing organization of the target. The parameter has no effect if the target is an organization.

          Type : boolean

          Location : query