Compute Engine API (compute:v1)

2022-09-09

9 new methods

Additions

    Methods
  • compute.regionBackendServices.setIamPolicy

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description: Sets the access control policy on the specified resource. Replaces any existing policy.

      HTTP Method: POST

      Parameters:

        region

          Location: path

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

          Description: The name of the region for this request.

          Required: Yes

          Type: string

        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

        resource

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

          Type: string

          Required: Yes

          Location: path

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

      Parameter Order:

    • project
    • region
    • resource
    • Flat Path: projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy

      Path: projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy

  • compute.regionBackendServices.getIamPolicy

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Flat Path: projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy

      HTTP Method: GET

      Parameter Order:

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

      Parameters:

        optionsRequestedPolicyVersion

          Location: query

          Description: Requested IAM Policy version.

          Format: int32

          Type: integer

        region

          Type: string

          Location: path

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

          Required: Yes

          Description: The name of the region for this request.

        resource

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

          Type: string

          Required: Yes

          Location: path

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

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

          Description: Project ID for this request.

          Required: Yes

          Location: path

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

  • compute.backendServices.setIamPolicy

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

          Type: string

          Required: Yes

          Location: path

          Description: Project ID for this request.

        resource

          Location: path

          Required: Yes

          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.

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

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

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

      Scopes:

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

  • compute.backendServices.getIamPolicy

      Parameters:

        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

          Location: path

          Description: Project ID for this request.

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

        optionsRequestedPolicyVersion

          Type: integer

          Location: query

          Format: int32

          Description: Requested IAM Policy version.

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

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

      HTTP Method: GET

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

      Parameter Order:

    • project
    • resource
    • Scopes:

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

      Scopes:

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

      HTTP Method: GET

      Description: Retrieves the list of all SslPolicy resources, regional and global, available to the specified project.

      Flat Path: projects/{project}/aggregated/sslPolicies

      Parameters:

        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

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

          Type: string

          Description: Name of the project scoping this request.

          Location: path

        filter

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

          Location: query

          Type: string

        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.

        includeAllScopes

          Location: query

          Description: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

          Type: boolean

        maxResults

          Format: uint32

          Location: query

          Type: integer

          Default: 500

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

        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

      Parameter Order: project

  • compute.regionTargetTcpProxies.get

      HTTP Method: GET

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

      Parameter Order:

    • project
    • region
    • targetTcpProxy
    • Parameters:

        targetTcpProxy

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

          Location: path

          Required: Yes

          Type: string

          Description: Name of the TargetTcpProxy resource to return.

        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.

        region

          Description: Name of the region scoping this request.

          Required: Yes

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

          Location: path

          Type: string

      Description: Returns the specified TargetTcpProxy resource.

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

      Scopes:

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

      Description: Deletes the specified TargetTcpProxy resource.

      Scopes:

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

    • project
    • region
    • targetTcpProxy
    • Parameters:

        targetTcpProxy

          Type: string

          Required: Yes

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

          Location: path

          Description: Name of the TargetTcpProxy resource to delete.

        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.

          Type: string

          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

        region

          Type: string

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

          Location: path

          Description: Name of the region scoping this request.

          Required: Yes

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

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

      HTTP Method: DELETE

  • compute.regionTargetTcpProxies.list

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

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

      HTTP Method: GET

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

        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

        region

          Type: string

          Description: Name of the region scoping this request.

          Required: Yes

          Location: path

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

        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

        maxResults

          Minimum: 0

          Type: integer

          Default: 500

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

          Format: uint32

          Location: query

        pageToken

          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.

          Type: string

        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

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

      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
  • compute.regionTargetTcpProxies.insert

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

          Required: Yes

          Location: path

          Type: string

        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

          Required: Yes

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

          Type: string

          Description: Name of the region scoping this request.

          Location: path

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

      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.

      HTTP Method: POST

      Scopes:

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