Compute Engine API (compute:v1)

2021-12-07

12 new methods | 1 updated method

Additions

    Methods
  • compute.regionCommitments.update

      Scopes:

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

      Parameter Order:

    • project
    • region
    • commitment
    • Parameters:

        commitment

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

          Type: string

          Required: Yes

          Description: Name of the commitment for which auto renew is being updated.

          Location: path

        paths

          Location: query

          Repeated: Yes

          Type: string

        updateMask

          Format: google-fieldmask

          Type: string

          Description: update_mask indicates fields to be updated as part of this request.

          Location: query

        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

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

          Type: string

          Description: Name of the region for this request.

          Location: path

          Required: Yes

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

      HTTP Method: PATCH

      Flat Path: projects/{project}/regions/{region}/commitments/{commitment}

      Description: Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.

  • compute.reservations.update

      Description: Update share settings of the reservation.

      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

        project

          Location: path

          Description: Project ID for this request.

          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

        reservation

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

          Type: string

          Required: Yes

          Location: path

          Description: Name of the reservation to update.

        zone

          Description: Name of the zone for this request.

          Required: Yes

          Location: path

          Type: string

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

        updateMask

          Description: Update_mask indicates fields to be updated as part of this request.

          Format: google-fieldmask

          Location: query

          Type: string

        paths

          Repeated: Yes

          Type: string

          Location: query

      Flat Path: projects/{project}/zones/{zone}/reservations/{reservation}

      Scopes:

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

    • project
    • zone
    • reservation
    • Path: projects/{project}/zones/{zone}/reservations/{reservation}

      HTTP Method: PATCH

  • compute.backendBuckets.setEdgeSecurityPolicy

      Parameters:

        project

          Type: string

          Description: Project ID for this request.

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

          Location: path

          Required: Yes

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

        backendBucket

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

          Required: Yes

          Type: string

          Location: path

      Description: Sets the edge security policy for the specified backend bucket.

      HTTP Method: POST

      Flat Path: projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Path: projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy

      Parameter Order:

    • project
    • backendBucket
  • compute.snapshots.insert

      Parameter Order: project

      Description: Creates a snapshot in the specified project using the data included in the request.

      HTTP Method: POST

      Scopes:

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

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

      Parameters:

        project

          Required: Yes

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

          Type: string

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

  • compute.backendServices.setEdgeSecurityPolicy

      HTTP Method: POST

      Flat Path: projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy

      Scopes:

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

        project

          Type: string

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

          Location: path

          Required: Yes

          Description: Project ID for this request.

        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

        backendService

          Location: path

          Required: Yes

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

          Type: string

      Parameter Order:

    • project
    • backendService
    • Description: Sets the edge security policy for the specified backend service.

      Path: projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy

  • compute.machineImages.delete

      HTTP Method: DELETE

      Parameter Order:

    • project
    • machineImage
    • Flat Path: projects/{project}/global/machineImages/{machineImage}

      Scopes:

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

        machineImage

          Description: The name of the machine image to delete.

          Required: Yes

          Type: string

          Location: path

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

        project

          Description: Project ID for this request.

          Type: string

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

          Location: path

          Required: Yes

        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

      Description: Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone.

      Path: projects/{project}/global/machineImages/{machineImage}

  • compute.machineImages.getIamPolicy

      Scopes:

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

    • project
    • resource
    • Description: Gets the access control policy for a resource. May be empty if no such policy or resource exists.

      Parameters:

        project

          Location: path

          Type: string

          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

        resource

          Type: string

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

          Required: Yes

          Location: path

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

        optionsRequestedPolicyVersion

          Format: int32

          Description: Requested IAM Policy version.

          Location: query

          Type: integer

      HTTP Method: GET

      Flat Path: projects/{project}/global/machineImages/{resource}/getIamPolicy

      Path: projects/{project}/global/machineImages/{resource}/getIamPolicy

  • compute.machineImages.get

      Flat Path: projects/{project}/global/machineImages/{machineImage}

      HTTP Method: GET

      Description: Returns the specified machine image. Gets a list of available machine images by making a list() request.

      Parameter Order:

    • project
    • machineImage
    • Path: projects/{project}/global/machineImages/{machineImage}

      Parameters:

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

          Description: Project ID for this request.

          Type: string

          Required: Yes

        machineImage

          Required: Yes

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

          Location: path

          Type: string

          Description: The name of the machine image.

      Scopes:

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

      Description: Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance.

      Parameters:

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

          Location: path

          Type: string

          Required: Yes

        sourceInstance

          Type: string

          Description: Required. Source instance that is used to create the machine image from.

          Location: query

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

      Path: projects/{project}/global/machineImages

      Parameter Order: project

      HTTP Method: POST

      Scopes:

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

  • compute.machineImages.list

      Scopes:

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

      Parameters:

        filter

          Location: query

          Type: string

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

        pageToken

          Type: string

          Location: query

          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.

        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.

        maxResults

          Format: uint32

          Default: 500

          Type: integer

          Location: query

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

          Minimum: 0

        project

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

          Description: Project ID for this request.

          Type: string

          Location: path

      Description: Retrieves a list of machine images that are contained within the specified project.

      HTTP Method: GET

      Path: projects/{project}/global/machineImages

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

  • compute.machineImages.testIamPermissions

      Path: projects/{project}/global/machineImages/{resource}/testIamPermissions

      Parameter Order:

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

      HTTP Method: POST

      Flat Path: projects/{project}/global/machineImages/{resource}/testIamPermissions

      Scopes:

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

        resource

          Location: path

          Type: string

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

          Required: Yes

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

        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

          Location: path

          Required: Yes

          Description: Project ID for this request.

  • compute.machineImages.setIamPolicy

      Scopes:

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

    • project
    • resource
    • 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])?))

          Location: path

          Description: Project ID for this request.

          Required: Yes

          Type: string

        resource

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

          Location: path

          Type: string

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

          Required: Yes

      Flat Path: projects/{project}/global/machineImages/{resource}/setIamPolicy

      Path: projects/{project}/global/machineImages/{resource}/setIamPolicy

      Description: Sets the access control policy on the specified resource. Replaces any existing policy.

      HTTP Method: POST

Updates

    Methods
  • compute.instances.insert

      Parameters:

        sourceMachineImage

          Location: query

          Description: Specifies the machine image to use to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image: - https://www.googleapis.com/compute/v1/projects/project/global/global /machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage

          Type: string