Compute Engine API (compute:v1)

2023-10-02

8 new methods | 41 updated methods

Additions

    Methods
  • compute.regionSecurityPolicies.removeRule

      Path: projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule

      Flat Path: projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule

      HTTP Method: POST

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description: Deletes a rule at the specified priority.

      Parameter Order:

    • project
    • region
    • securityPolicy
    • Parameters:

        securityPolicy

          Description: Name of the security policy to update.

          Type: string

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

          Required: Yes

          Location: path

        region

          Type: string

          Required: Yes

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

          Description: Name of the region scoping this request.

          Location: path

        priority

          Description: The priority of the rule to remove from the security policy.

          Location: query

          Type: integer

          Format: int32

        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.

          Required: Yes

          Type: string

          Location: path

  • compute.regionSecurityPolicies.patchRule

      Flat Path: projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule

      HTTP Method: POST

      Parameters:

        validateOnly

          Description: If true, the request will not be committed.

          Location: query

          Type: boolean

        priority

          Location: query

          Description: The priority of the rule to patch.

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

          Required: Yes

          Type: string

          Location: path

          Description: Project ID for this request.

        region

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

          Required: Yes

          Type: string

          Description: Name of the region scoping this request.

          Location: path

        securityPolicy

          Type: string

          Description: Name of the security policy to update.

          Required: Yes

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

          Location: path

      Parameter Order:

    • project
    • region
    • securityPolicy
    • Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description: Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.

      Path: projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule

  • compute.regionSecurityPolicies.getRule

      Description: Gets a rule at the specified priority.

      Path: projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule

      Parameters:

        project

          Required: Yes

          Description: Project ID for this request.

          Location: path

          Type: string

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

        priority

          Description: The priority of the rule to get from the security policy.

          Type: integer

          Location: query

          Format: int32

        region

          Location: path

          Type: string

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

          Required: Yes

          Description: Name of the region scoping this request.

        securityPolicy

          Description: Name of the security policy to which the queried rule belongs.

          Required: Yes

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

          Type: string

          Location: path

      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}/regions/{region}/securityPolicies/{securityPolicy}/getRule

      Parameter Order:

    • project
    • region
    • securityPolicy
    • HTTP Method: GET

  • compute.regionSecurityPolicies.addRule

      Path: projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule

      Flat Path: projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule

      Description: Inserts a rule into a security policy.

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

          Description: Project ID for this request.

          Location: path

          Required: Yes

          Type: string

        validateOnly

          Description: If true, the request will not be committed.

          Type: boolean

          Location: query

        securityPolicy

          Required: Yes

          Description: Name of the security policy to update.

          Location: path

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

          Type: string

        region

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

          Location: path

          Description: Name of the region scoping this request.

          Type: string

          Required: Yes

      HTTP Method: POST

      Scopes:

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

    • project
    • region
    • securityPolicy
  • compute.regionNetworkEndpointGroups.detachNetworkEndpoints

      Flat Path: projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints

      Parameters:

        region

          Location: path

          Required: Yes

          Description: The name of the region where the network endpoint group is located. It should comply with RFC1035.

          Type: string

        networkEndpointGroup

          Description: The name of the network endpoint group you are detaching network endpoints from. It should comply with RFC1035.

          Type: string

          Required: Yes

          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). end_interface: MixerMutationRequestBuilder

        project

          Location: path

          Type: string

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

          Description: Project ID for this request.

          Required: Yes

      HTTP Method: POST

      Parameter Order:

    • project
    • region
    • networkEndpointGroup
    • Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description: Detach the network endpoint from the specified network endpoint group.

      Path: projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints

  • compute.regionNetworkEndpointGroups.listNetworkEndpoints

      Scopes:

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

      Description: Lists the network endpoints in the specified network endpoint group.

      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

          Description: Project ID for this request.

          Type: string

          Location: path

        maxResults

          Location: query

          Type: integer

          Default: 500

          Minimum: 0

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

        pageToken

          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.

          Location: query

        returnPartialSuccess

          Type: boolean

          Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

          Location: query

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

          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.

          Location: query

          Type: string

        networkEndpointGroup

          Required: Yes

          Type: string

          Location: path

          Description: The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.

        region

          Description: The name of the region where the network endpoint group is located. It should comply with RFC1035.

          Location: path

          Type: string

          Required: Yes

      Parameter Order:

    • project
    • region
    • networkEndpointGroup
    • Path: projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints

      Flat Path: projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints

  • compute.regionNetworkEndpointGroups.attachNetworkEndpoints

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Flat Path: projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints

      Description: Attach a list of network endpoints to the specified network endpoint group.

      Path: projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints

      Parameter Order:

    • project
    • region
    • networkEndpointGroup
    • HTTP Method: POST

      Parameters:

        project

          Required: Yes

          Type: string

          Description: Project ID for this request.

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

        requestId

          Type: string

          Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

          Location: query

        region

          Type: string

          Description: The name of the region where you want to create the network endpoint group. It should comply with RFC1035.

          Required: Yes

          Location: path

        networkEndpointGroup

          Description: The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.

          Type: string

          Required: Yes

          Location: path

  • compute.interconnects.getMacsecConfig

      Description: Returns the interconnectMacsecConfig for the specified Interconnect.

      Scopes:

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

      Parameters:

        interconnect

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

          Location: path

          Type: string

          Required: Yes

          Description: Name of the interconnect resource to query.

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

          Required: Yes

          Description: Project ID for this request.

          Location: path

      Parameter Order:

    • project
    • interconnect
    • Flat Path: projects/{project}/global/interconnects/{interconnect}/getMacsecConfig

      Path: projects/{project}/global/interconnects/{interconnect}/getMacsecConfig

Updates

    Methods
  • compute.machineTypes.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Type: string

          Location: query

  • compute.targetHttpsProxies.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • compute.targetHttpProxies.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • compute.instanceTemplates.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • compute.securityPolicies.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • compute.targetPools.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • compute.subnetworks.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Type: string

          Location: query

  • compute.diskTypes.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • compute.forwardingRules.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • compute.vpnGateways.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • compute.instanceGroupManagers.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • compute.nodeTypes.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • compute.nodeGroups.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • compute.healthChecks.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • compute.networkAttachments.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • compute.publicDelegatedPrefixes.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • compute.routers.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Type: string

          Location: query

  • compute.nodeTemplates.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Type: string

          Location: query

  • compute.instanceGroups.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • compute.targetTcpProxies.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • compute.disks.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • compute.regionCommitments.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • compute.vpnTunnels.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • compute.sslCertificates.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • compute.networkEdgeSecurityServices.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • compute.serviceAttachments.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • compute.networkEndpointGroups.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • compute.packetMirrorings.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • compute.sslPolicies.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Type: string

          Location: query

  • compute.urlMaps.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • compute.reservations.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • compute.addresses.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • compute.instances.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • compute.resourcePolicies.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • compute.autoscalers.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • compute.targetVpnGateways.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • compute.backendServices.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • compute.globalOperations.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • compute.interconnectAttachments.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • compute.acceleratorTypes.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • compute.targetInstances.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query