Method: projects.regions.clusters.delete

Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectId

string

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

string

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

string

Required. The cluster name.

Authorization requires the following IAM permission on the specified resource clusterName:

  • dataproc.clusters.delete

Query parameters

Parameters
clusterUuid

string

Optional. Specifying the clusterUuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.
requestId

string

Optional. A unique ID used to identify the request. If the server receives two DeleteClusterRequests 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.
gracefulTerminationTimeout

string (Duration format)

Optional. The graceful termination timeout for the deletion of the cluster. Indicate the time the request will wait to complete the running jobs on the cluster before its forceful deletion. Default value is 0 indicating that the user has not enabled the graceful termination. Value can be between 60 second and 6 Hours, in case the graceful termination is enabled. (There is no separate flag to check the enabling or disabling of graceful termination, it can be checked by the values in the field).

Request body

The request body must be empty.

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.