Method: projects.locations.privateClouds.clusters.patch

Modifies a Cluster resource. Only the following fields can be updated: nodeTypeConfigs.*.node_count. Only fields specified in updateMask are applied.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster

Query parameters


string (FieldMask format)

Required. Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the updateMask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".



Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).



Optional. True if you want the request to be validated and not executed; false otherwise.

Request body

The request body contains an instance of Cluster.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.