Method: projects.regions.clusters.stop

• HTTP request
• Path parameters
• Request body
  • JSON representation
• Response body
• Authorization scopes
• Try it!

Stops a cluster in a project.

HTTP request

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

The URL uses gRPC 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. Authorization requires the following IAM permission on the specified resource clusterName: dataproc.clusters.stop

Request body

The request body contains data with the following structure:

JSON representation
{ "clusterUuid": string, "requestId": string }

Fields
clusterUuid	string Optional. Specifying the clusterUuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.
requestId	string Optional. A unique ID used to identify the request. If the server receives two StopClusterRequests 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. Recommendation: 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.

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.