Method: projects.regions.clusters.patch

Updates a cluster in a project. The returnedOperation.metadata will beClusterOperationMetadata. The cluster must be in aRUNNING state or an error is returned.

HTTP request

PATCH https://dataproc.googleapis.com/v1/projects/{projectId}/regions/{region}/clusters/{clusterName}

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
projectId

string

Required. The ID of the Google Cloud Platform project the cluster belongs to.

region

string

Required. The Dataproc region in which to handle the request.

clusterName

string

Required. The cluster name.

Query parameters

Parameters
gracefulDecommissionTimeout

string (Duration format)

Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. (see JSON representation ofDuration).

Only supported on Dataproc image versions 1.2 and higher.

updateMask

string (FieldMask format)

Required. Specifies the path, relative toCluster, of the field to update. For example, to change the number of workers in a cluster to 5, theupdateMask parameter would be specified asconfig.worker_config.num_instances, and thePATCH request body would specify the new value, as follows:

{  "config":{    "workerConfig":{      "numInstances":"5"    }  }}

Similarly, to change the number of preemptible workers in a cluster to 5, theupdateMask parameter would beconfig.secondary_worker_config.num_instances, and thePATCH request body would be set as follows:

{  "config":{    "secondaryWorkerConfig":{      "numInstances":"5"    }  }}

Note: Currently, only the following fields can be updated:

MaskPurpose
labelsUpdate labels
config.worker_config.num_instancesResize primary worker group
config.secondary_worker_config.num_instancesResize secondary worker group
config.autoscaling_config.policy_uriUse, stop using, or change autoscaling policies

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

requestId

string

Optional. A unique ID used to identify the request. If the server receives twoUpdateClusterRequests with the same id, then the second request will be ignored and the firstgoogle.longrunning.Operation created and stored in the backend is returned.

It is recommended to always set this value to aUUID.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Request body

The request body contains an instance ofCluster.

Response body

If successful, the response body contains an instance ofOperation.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-20 UTC.