- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Updates a cluster in a project. The returned Operation.metadata
will be ClusterOperationMetadata
. The cluster must be in a
state or an error is returned.RUNNING
HTTP request
PATCH https://dataproc.googleapis.com/v1/projects/{projectId}/regions/{region}/clusters/{clusterName}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
projectId
|
Required. The ID of the Google Cloud Platform project the cluster belongs to. |
region
|
Required. The Dataproc region in which to handle the request. |
clusterName
|
Required. The cluster name. |
Query 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 of Duration ).
Only supported on Dataproc image versions 1.2 and higher.
updateMask
string (
FieldMask
format)
Required. Specifies the path, relative to Cluster
, of the field to update. For example, to change the number of workers in a cluster to 5, the updateMask
parameter would be specified as config.worker_config.num_instances
, and the PATCH
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, the updateMask
parameter would be config.secondary_worker_config.num_instances
, and the PATCH
request body would be set as follows:
{
"config":{
"secondaryWorkerConfig":{
"numInstances":"5"
}
}
}
Note:Currently, only the following fields can be updated:
| Mask | Purpose |
| labels | Update labels |
| config.worker_config.num_instances | Resize primary worker group |
| config.secondary_worker_config.num_instances | Resize secondary worker group |
| config.autoscaling_config.policy_uri | Use, 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 two UpdateClusterRequest
s with the same id, then the second request will be ignored and the first google.longrunning.Operation
created and stored in the backend is returned.
It is recommended to always set this value to a UUID .
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 of Cluster
.
Response body
If successful, the response body contains an instance of Operation
.
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
