Compute Engine API (compute:beta)

2023-05-15

5 new methods

Additions

    Methods
  • compute.interconnectRemoteLocations.list

      Flat Path: projects/{project}/global/interconnectRemoteLocations

      Parameter Order: project

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Path: projects/{project}/global/interconnectRemoteLocations

      HTTP Method: GET

      Description: Retrieves the list of interconnect remote locations available to the specified project.

      Parameters:

        filter

          Location: query

          Type: string

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

        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

        orderBy

          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.

          Location: query

        maxResults

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

          Type: integer

          Default: 500

          Minimum: 0

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

        returnPartialSuccess

          Type: boolean

          Location: query

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

  • compute.interconnectRemoteLocations.get

      Parameter Order:

    • project
    • interconnectRemoteLocation
    • HTTP Method: GET

      Flat Path: projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}

      Parameters:

        project

          Type: string

          Location: path

          Description: Project ID for this request.

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

          Required: Yes

        interconnectRemoteLocation

          Type: string

          Description: Name of the interconnect remote location to return.

          Required: Yes

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

          Location: path

      Path: projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}

      Description: Returns the details for the specified interconnect remote location. Gets a list of available interconnect remote locations by making a list() request.

      Scopes:

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

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description: Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview

      Flat Path: projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy

      Parameters:

        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

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

          Type: string

          Location: path

          Description: Name of the region scoping this request.

          Required: Yes

        targetPool

          Description: Name of the TargetPool resource to which the security policy should be set. The name should conform to RFC1035.

          Location: path

          Required: Yes

          Type: string

        project

          Location: path

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

          Required: Yes

          Description: Project ID for this request.

          Type: string

      HTTP Method: POST

      Parameter Order:

    • project
    • region
    • targetPool
    • Path: projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy

  • compute.instances.setSecurityPolicy

      Description: Sets the Google Cloud Armor security policy for the specified instance. For more information, see Google Cloud Armor Overview

      Path: projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy

      Parameters:

        requestId

          Location: query

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

          Type: string

        instance

          Required: Yes

          Description: Name of the Instance resource to which the security policy should be set. The name should conform to RFC1035.

          Location: path

          Type: string

        project

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

          Description: Project ID for this request.

          Location: path

          Type: string

          Required: Yes

        zone

          Required: Yes

          Description: Name of the zone scoping this request.

          Type: string

          Location: path

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

      HTTP Method: POST

      Scopes:

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

      Parameter Order:

    • project
    • zone
    • instance
  • compute.targetInstances.setSecurityPolicy

      Path: projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy

      Parameters:

        project

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

          Description: Project ID for this request.

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

        zone

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

          Location: path

          Type: string

          Required: Yes

          Description: Name of the zone scoping this request.

        targetInstance

          Required: Yes

          Description: Name of the TargetInstance resource to which the security policy should be set. The name should conform to RFC1035.

          Type: string

          Location: path

      Scopes:

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

    • project
    • zone
    • targetInstance
    • HTTP Method: POST

      Description: Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview

      Flat Path: projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy