Compute Engine API (compute:alpha)

2022-03-01

11 new methods | 1 updated method | 1 removed method

Additions

    Methods
  • compute.disks.startAsyncReplication

      Description: Starts asynchronous replication. Must be invoked on the primary disk.

      HTTP Method: POST

      Parameters:

        zone

          Required: Yes

          Location: path

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

          Type: string

          Description: The name of the zone for this request.

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

        disk

          Location: path

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

          Required: Yes

          Description: The name of the persistent disk.

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

          Required: Yes

          Type: string

          Location: path

          Description: Project ID for this request.

      Parameter Order:

    • project
    • zone
    • disk
    • Path: projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication

      Flat Path: projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication

      Scopes:

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

      Description: Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.

      Parameter Order:

    • project
    • zone
    • Parameters:

        project

          Type: string

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

        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

        zone

          Required: Yes

          Type: string

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

          Description: The name of the zone for this request. This must be the zone of the primary or secondary disks in the consistency group.

          Location: path

      Path: projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication

      Scopes:

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

      Flat Path: projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication

  • compute.disks.stopAsyncReplication

      Scopes:

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

    • project
    • zone
    • disk
    • Flat Path: projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication

      Description: Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.

      Path: projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication

      Parameters:

        zone

          Description: The name of the zone for this request.

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

          Type: string

          Required: Yes

          Location: path

        disk

          Description: The name of the persistent disk.

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

          Location: path

          Type: string

          Required: Yes

        project

          Type: string

          Required: Yes

          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

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

      HTTP Method: POST

  • compute.regionTargetTcpProxies.insert

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

      Parameter Order:

    • project
    • region
    • Description: Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.

      Scopes:

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

      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

        region

          Type: string

          Location: path

          Required: Yes

          Description: Name of the region scoping this request.

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

        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

          Description: Project ID for this request.

          Required: Yes

          Location: path

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

  • compute.regionTargetTcpProxies.list

      HTTP Method: GET

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

      Parameter Order:

    • project
    • region
    • Scopes:

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

        orderBy

          Location: query

          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

        project

          Required: Yes

          Description: Project ID for this request.

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

        filter

          Description: A filter expression that filters resources listed in the response. The 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) ```

          Location: query

          Type: string

        region

          Description: Name of the region scoping this request.

          Required: Yes

          Type: string

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

          Location: path

        pageToken

          Description: Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

          Location: query

          Type: string

        maxResults

          Format: uint32

          Minimum: 0

          Description: The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

          Default: 500

          Location: query

          Type: integer

        returnPartialSuccess

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

          Type: boolean

          Location: query

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

      Description: Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.

  • compute.regionTargetTcpProxies.get

      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

        region

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

          Location: path

          Type: string

          Required: Yes

          Description: Name of the region scoping this request.

        targetTcpProxy

          Location: path

          Required: Yes

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

          Type: string

          Description: Name of the TargetTcpProxy resource to return.

      HTTP Method: GET

      Scopes:

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

    • project
    • region
    • targetTcpProxy
    • Description: Returns the specified TargetTcpProxy resource.

      Path: projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}

      Flat Path: projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}

  • compute.regionTargetTcpProxies.testIamPermissions

      Parameters:

        resource

          Location: path

          Type: string

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

          Description: Name or id of the resource for this request.

          Required: Yes

        project

          Location: path

          Type: string

          Description: Project ID for this request.

          Required: Yes

          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

          Type: string

          Location: path

          Description: The name of the region for this request.

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

          Required: Yes

      Parameter Order:

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

      Description: Returns permissions that a caller has on the specified resource.

      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}/targetTcpProxies/{resource}/testIamPermissions

      HTTP Method: POST

  • compute.regionTargetTcpProxies.delete

      Parameter Order:

    • project
    • region
    • targetTcpProxy
    • Parameters:

        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

        region

          Required: Yes

          Type: string

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

          Description: Name of the region scoping this request.

          Location: path

        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

        targetTcpProxy

          Location: path

          Required: Yes

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

          Type: string

          Description: Name of the TargetTcpProxy resource to delete.

      Flat Path: projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}

      HTTP Method: DELETE

      Description: Deletes the specified TargetTcpProxy resource.

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Path: projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}

  • compute.regionDisks.startAsyncReplication

      Parameter Order:

    • project
    • region
    • disk
    • Description: Starts asynchronous replication. Must be invoked on the primary disk.

      Path: projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication

      Scopes:

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

      Parameters:

        project

          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

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

          Type: string

          Location: query

        region

          Required: Yes

          Location: path

          Type: string

          Description: The name of the region for this request.

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

        disk

          Type: string

          Location: path

          Required: Yes

          Description: The name of the persistent disk.

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

      Flat Path: projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication

  • compute.regionDisks.stopGroupAsyncReplication

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Path: projects/{project}/regions/{region}/disks/stopGroupAsyncReplication

      HTTP Method: POST

      Flat Path: projects/{project}/regions/{region}/disks/stopGroupAsyncReplication

      Description: Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.

      Parameters:

        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

        region

          Location: path

          Type: string

          Required: Yes

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

          Description: The name of the region for this request. This must be the region of the primary or secondary disks in the consistency group.

        project

          Description: Project ID for this request.

          Required: Yes

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

      Parameter Order:

    • project
    • region
  • compute.regionDisks.stopAsyncReplication

      Scopes:

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

        region

          Description: The name of the region for this request.

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

          Required: Yes

          Type: string

          Location: path

        project

          Description: Project ID for this request.

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

          Required: Yes

          Location: path

          Type: string

        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

        disk

          Type: string

          Location: path

          Description: The name of the persistent disk.

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

          Required: Yes

      Parameter Order:

    • project
    • region
    • disk
    • Path: projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication

      Flat Path: projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication

      HTTP Method: POST

      Description: Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.

Updates

    Methods
  • compute.instances.simulateMaintenanceEvent

      Parameters:

        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

Deletions

    Methods
  • compute.regionSslPolicies.getIamPolicy

      Scopes:

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

      Parameters:

        optionsRequestedPolicyVersion

          Description: Requested IAM Policy version.

          Location: query

          Format: int32

          Type: integer

        region

          Required: Yes

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

          Location: path

          Description: The name of the region for this request.

          Type: string

        resource

          Type: string

          Location: path

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

          Description: Name or id of the resource for this request.

          Required: Yes

        project

          Type: string

          Required: Yes

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

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

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

      HTTP Method: GET

      Parameter Order:

    • project
    • region
    • resource