Compute Engine API (compute:v1)

2023-10-01

41 updated methods | 8 removed methods

Updates

    Methods

  • ▼ ▲ compute.acceleratorTypes.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.globalOperations.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.addresses.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • ▼ ▲ compute.disks.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • ▼ ▲ compute.securityPolicies.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.instances.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.reservations.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • ▼ ▲ compute.instanceGroups.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • ▼ ▲ compute.instanceGroupManagers.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • ▼ ▲ compute.autoscalers.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.backendServices.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Type: string

          Location: query

  • ▼ ▲ compute.regionCommitments.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.diskTypes.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • ▼ ▲ compute.forwardingRules.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Type: string

          Location: query

  • ▼ ▲ compute.healthChecks.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.instanceTemplates.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.interconnectAttachments.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • ▼ ▲ compute.machineTypes.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.networkAttachments.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • ▼ ▲ compute.networkEdgeSecurityServices.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.networkEndpointGroups.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • ▼ ▲ compute.nodeGroups.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.nodeTemplates.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.nodeTypes.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • ▼ ▲ compute.packetMirrorings.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.publicDelegatedPrefixes.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.resourcePolicies.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.routers.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • ▼ ▲ compute.serviceAttachments.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.sslCertificates.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.sslPolicies.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.subnetworks.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Type: string

          Location: query

  • ▼ ▲ compute.targetHttpProxies.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.targetHttpsProxies.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.targetInstances.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.targetPools.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.targetTcpProxies.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.targetVpnGateways.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.urlMaps.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.vpnGateways.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Type: string

          Location: query

  • ▼ ▲ compute.vpnTunnels.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

Deletions

    Methods

  • ▼ ▲ compute.regionNetworkEndpointGroups.detachNetworkEndpoints

      Description: Detach the network endpoint from the specified network endpoint group.

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

      HTTP Method: POST

      Parameters:

        region

          Type: string

          Required: Yes

          Location: path

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

        networkEndpointGroup

          Required: Yes

          Location: path

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

          Type: string

        requestId

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

          Type: string

          Location: query

        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

      Scopes:

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

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

      Parameter Order:

    • project
    • region
    • networkEndpointGroup

  • ▼ ▲ compute.regionNetworkEndpointGroups.listNetworkEndpoints

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

      Flat Path: projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/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

      Parameters:

        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.

        region

          Type: string

          Required: Yes

          Location: path

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

        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

        networkEndpointGroup

          Type: string

          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.

          Location: path

          Required: Yes

        project

          Description: Project ID for this request.

          Required: Yes

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

        maxResults

          Default: 500

          Minimum: 0

          Format: uint32

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

        returnPartialSuccess

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

          Location: query

          Type: boolean

        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.

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

      Parameter Order:

    • project
    • region
    • networkEndpointGroup

  • ▼ ▲ compute.regionNetworkEndpointGroups.attachNetworkEndpoints

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

      Scopes:

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

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

      HTTP Method: POST

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

      Parameter Order:

    • project
    • region
    • networkEndpointGroup

      • Parameters:

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

        region

          Location: path

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

          Type: string

          Required: Yes

        project

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

          Type: string

          Required: Yes

          Location: path

          Description: Project ID for this request.

        networkEndpointGroup

          Required: Yes

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

          Type: string

          Location: path

  • ▼ ▲ compute.regionSecurityPolicies.getRule

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

      HTTP Method: GET

      Parameter Order:

    • project
    • region
    • securityPolicy

      • Scopes:

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

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

      Parameters:

        region

          Description: Name of the region scoping this request.

          Type: string

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

          Required: Yes

          Location: path

        priority

          Type: integer

          Location: query

          Format: int32

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

        securityPolicy

          Location: path

          Type: string

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

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

          Required: Yes

        project

          Description: Project ID for this request.

          Required: Yes

          Location: path

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

          Type: string

      Description: Gets a rule at the specified priority.

  • ▼ ▲ compute.regionSecurityPolicies.removeRule

      Description: Deletes a rule at the specified priority.

      Scopes:

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

      • Parameters:

        project

          Description: Project ID for this request.

          Required: Yes

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

        region

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

          Description: Name of the region scoping this request.

          Type: string

          Required: Yes

          Location: path

        priority

          Format: int32

          Location: query

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

          Type: integer

        securityPolicy

          Type: string

          Description: Name of the security policy to update.

          Required: Yes

          Location: path

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

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

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

      Parameter Order:

    • project
    • region
    • securityPolicy

      • HTTP Method: POST

  • ▼ ▲ compute.regionSecurityPolicies.addRule

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

      Scopes:

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

      • Description: Inserts a rule into a security policy.

      Parameter Order:

    • project
    • region
    • securityPolicy

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

      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.

          Required: Yes

          Location: path

          Type: string

        region

          Type: string

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

          Required: Yes

          Description: Name of the region scoping this request.

          Location: path

        securityPolicy

          Location: path

          Description: Name of the security policy to update.

          Required: Yes

          Type: string

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

        validateOnly

          Type: boolean

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

          Location: query

      HTTP Method: POST

  • ▼ ▲ compute.regionSecurityPolicies.patchRule

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

      Description: Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.

      Scopes:

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

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

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

          Type: string

          Required: Yes

          Location: path

          Description: Project ID for this request.

        region

          Description: Name of the region scoping this request.

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

          Required: Yes

          Location: path

          Type: string

        priority

          Type: integer

          Format: int32

          Location: query

          Description: The priority of the rule to patch.

        validateOnly

          Type: boolean

          Location: query

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

        securityPolicy

          Description: Name of the security policy to update.

          Required: Yes

          Location: path

          Type: string

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

      Parameter Order:

    • project
    • region
    • securityPolicy

      • HTTP Method: POST

  • ▼ ▲ compute.interconnects.getMacsecConfig

      HTTP Method: GET

      Parameters:

        project

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

          Description: Project ID for this request.

          Required: Yes

        interconnect

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

          Required: Yes

          Type: string

          Location: path

          Description: Name of the interconnect resource to query.

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

      Scopes:

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

      • Parameter Order:

    • project
    • interconnect

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

      Description: Returns the interconnectMacsecConfig for the specified Interconnect.

8 new methods | 41 updated methods

Additions

    Methods

  • ▼ ▲ compute.regionNetworkEndpointGroups.detachNetworkEndpoints

      Description: Detach the network endpoint from the specified network endpoint group.

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

      HTTP Method: POST

      Parameters:

        region

          Type: string

          Required: Yes

          Location: path

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

        networkEndpointGroup

          Required: Yes

          Location: path

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

          Type: string

        requestId

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

          Type: string

          Location: query

        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

      Scopes:

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

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

      Parameter Order:

    • project
    • region
    • networkEndpointGroup

  • ▼ ▲ compute.regionNetworkEndpointGroups.listNetworkEndpoints

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

      Flat Path: projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/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

      Parameters:

        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.

        region

          Type: string

          Required: Yes

          Location: path

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

        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

        networkEndpointGroup

          Type: string

          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.

          Location: path

          Required: Yes

        project

          Description: Project ID for this request.

          Required: Yes

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

        maxResults

          Default: 500

          Minimum: 0

          Format: uint32

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

        returnPartialSuccess

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

          Location: query

          Type: boolean

        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.

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

      Parameter Order:

    • project
    • region
    • networkEndpointGroup

  • ▼ ▲ compute.regionNetworkEndpointGroups.attachNetworkEndpoints

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

      Scopes:

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

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

      HTTP Method: POST

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

      Parameter Order:

    • project
    • region
    • networkEndpointGroup

      • Parameters:

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

        region

          Location: path

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

          Type: string

          Required: Yes

        project

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

          Type: string

          Required: Yes

          Location: path

          Description: Project ID for this request.

        networkEndpointGroup

          Required: Yes

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

          Type: string

          Location: path

  • ▼ ▲ compute.regionSecurityPolicies.getRule

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

      HTTP Method: GET

      Parameter Order:

    • project
    • region
    • securityPolicy

      • Scopes:

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

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

      Parameters:

        region

          Description: Name of the region scoping this request.

          Type: string

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

          Required: Yes

          Location: path

        priority

          Type: integer

          Location: query

          Format: int32

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

        securityPolicy

          Location: path

          Type: string

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

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

          Required: Yes

        project

          Description: Project ID for this request.

          Required: Yes

          Location: path

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

          Type: string

      Description: Gets a rule at the specified priority.

  • ▼ ▲ compute.regionSecurityPolicies.removeRule

      Description: Deletes a rule at the specified priority.

      Scopes:

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

      • Parameters:

        project

          Description: Project ID for this request.

          Required: Yes

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

        region

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

          Description: Name of the region scoping this request.

          Type: string

          Required: Yes

          Location: path

        priority

          Format: int32

          Location: query

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

          Type: integer

        securityPolicy

          Type: string

          Description: Name of the security policy to update.

          Required: Yes

          Location: path

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

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

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

      Parameter Order:

    • project
    • region
    • securityPolicy

      • HTTP Method: POST

  • ▼ ▲ compute.regionSecurityPolicies.addRule

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

      Scopes:

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

      • Description: Inserts a rule into a security policy.

      Parameter Order:

    • project
    • region
    • securityPolicy

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

      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.

          Required: Yes

          Location: path

          Type: string

        region

          Type: string

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

          Required: Yes

          Description: Name of the region scoping this request.

          Location: path

        securityPolicy

          Location: path

          Description: Name of the security policy to update.

          Required: Yes

          Type: string

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

        validateOnly

          Type: boolean

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

          Location: query

      HTTP Method: POST

  • ▼ ▲ compute.regionSecurityPolicies.patchRule

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

      Description: Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.

      Scopes:

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

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

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

          Type: string

          Required: Yes

          Location: path

          Description: Project ID for this request.

        region

          Description: Name of the region scoping this request.

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

          Required: Yes

          Location: path

          Type: string

        priority

          Type: integer

          Format: int32

          Location: query

          Description: The priority of the rule to patch.

        validateOnly

          Type: boolean

          Location: query

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

        securityPolicy

          Description: Name of the security policy to update.

          Required: Yes

          Location: path

          Type: string

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

      Parameter Order:

    • project
    • region
    • securityPolicy

      • HTTP Method: POST

  • ▼ ▲ compute.interconnects.getMacsecConfig

      HTTP Method: GET

      Parameters:

        project

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

          Description: Project ID for this request.

          Required: Yes

        interconnect

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

          Required: Yes

          Type: string

          Location: path

          Description: Name of the interconnect resource to query.

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

      Scopes:

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

      • Parameter Order:

    • project
    • interconnect

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

      Description: Returns the interconnectMacsecConfig for the specified Interconnect.

Updates

    Methods

  • ▼ ▲ compute.vpnGateways.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Type: string

          Location: query

  • ▼ ▲ compute.instances.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.packetMirrorings.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.autoscalers.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.targetVpnGateways.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.disks.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • ▼ ▲ compute.publicDelegatedPrefixes.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.subnetworks.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Type: string

          Location: query

  • ▼ ▲ compute.urlMaps.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.networkEdgeSecurityServices.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.targetTcpProxies.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.targetInstances.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.addresses.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • ▼ ▲ compute.serviceAttachments.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.forwardingRules.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Type: string

          Location: query

  • ▼ ▲ compute.targetHttpProxies.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.sslPolicies.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.healthChecks.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.instanceGroupManagers.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • ▼ ▲ compute.acceleratorTypes.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.routers.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • ▼ ▲ compute.instanceTemplates.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.machineTypes.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.nodeGroups.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.globalOperations.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.targetPools.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.instanceGroups.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • ▼ ▲ compute.backendServices.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Type: string

          Location: query

  • ▼ ▲ compute.diskTypes.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • ▼ ▲ compute.reservations.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • ▼ ▲ compute.regionCommitments.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.vpnTunnels.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • ▼ ▲ compute.interconnectAttachments.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • ▼ ▲ compute.nodeTypes.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • ▼ ▲ compute.sslCertificates.aggregatedList

      Parameters:

        serviceProjectNumber

          Format: int64

          Location: query

          Type: string

  • ▼ ▲ compute.nodeTemplates.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query

  • ▼ ▲ compute.networkEndpointGroups.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Type: string

          Format: int64

  • ▼ ▲ compute.networkAttachments.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Location: query

          Format: int64

  • ▼ ▲ compute.securityPolicies.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.resourcePolicies.aggregatedList

      Parameters:

        serviceProjectNumber

          Location: query

          Format: int64

          Type: string

  • ▼ ▲ compute.targetHttpsProxies.aggregatedList

      Parameters:

        serviceProjectNumber

          Type: string

          Format: int64

          Location: query