Compute Engine API (compute:v1)

2022-08-15

6 new methods

Additions

    Methods
  • compute.regionSslPolicies.delete

      Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}

      Scopes :

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

      Parameters :

        project

          Type : string

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

        region

          Location : path

          Type : string

          Description : Name of the region scoping this request.

          Required : Yes

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

        sslPolicy

          Description : Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.

          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

      Parameter Order :

    • project
    • region
    • sslPolicy
    • Description : Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.

      HTTP Method : DELETE

  • compute.regionSslPolicies.patch

      Flat Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}

      Parameter Order :

    • project
    • region
    • sslPolicy
    • Description : Patches the specified SSL policy with the data included in the request.

      Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}

      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

        sslPolicy

          Description : Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.

          Required : Yes

          Location : path

          Type : string

        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

        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

      Scopes :

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

  • compute.regionSslPolicies.list

      Parameters :

        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

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

          Type : string

        maxResults

          Minimum : 0

          Default : 500

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

          Format : uint32

          Type : integer

        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

        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.

          Type : string

          Location : query

        project

          Description : Project ID for this request.

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

        region

          Location : path

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

          Description : Name of the region scoping this request.

          Required : Yes

          Type : string

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

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

      Description : Lists all the SSL policies that have been configured for the specified project and region.

  • compute.regionSslPolicies.insert

      HTTP Method : POST

      Description : Creates a new policy in the specified project and region using the data included in the request.

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

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

      Scopes :

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

    • project
    • region
    • 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

        region

          Location : path

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

          Description : Name of the region scoping this request.

          Required : Yes

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

          Location : query

          Type : string

  • compute.regionSslPolicies.listAvailableFeatures

      Description : Lists all features that can be specified in the SSL policy when using custom profile.

      Path : projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures

      HTTP Method : GET

      Parameter Order :

    • project
    • region
    • Flat Path : projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures

      Scopes :

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

        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

        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

        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

        filter

          Type : string

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

        region

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

          Description : Name of the region scoping this request.

          Required : Yes

          Location : path

          Type : string

        maxResults

          Minimum : 0

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

          Default : 500

          Location : query

          Type : integer

        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

  • compute.regionSslPolicies.get

      Flat Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}

      Parameter Order :

    • project
    • region
    • sslPolicy
    • HTTP Method : GET

      Description : Lists all of the ordered rules present in a single specified policy.

      Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}

      Parameters :

        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

        sslPolicy

          Type : string

          Description : Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.

          Location : path

          Required : Yes

        project

          Type : string

          Location : path

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

      Scopes :

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