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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-20 UTC."],[[["\u003cp\u003eThis endpoint allows you to stop a specified cluster within a Google Cloud project using a \u003ccode\u003ePOST\u003c/code\u003e request to a specific URL structure.\u003c/p\u003e\n"],["\u003cp\u003eThe request URL requires three path parameters: \u003ccode\u003eprojectId\u003c/code\u003e, \u003ccode\u003eregion\u003c/code\u003e, and \u003ccode\u003eclusterName\u003c/code\u003e, to identify the target cluster.\u003c/p\u003e\n"],["\u003cp\u003eThe request body can optionally include a \u003ccode\u003eclusterUuid\u003c/code\u003e and a \u003ccode\u003erequestId\u003c/code\u003e for identifying the specific cluster and ensuring idempotency of the request.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests return an \u003ccode\u003eOperation\u003c/code\u003e object, and authentication requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eThe stop cluster API requires the following IAM permissions on the resource \u003ccode\u003eclusterName\u003c/code\u003e: \u003ccode\u003edataproc.clusters.stop\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: projects.regions.clusters.stop\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nStops a cluster in a project.\n\n### HTTP request\n\n`POST https://dataproc.googleapis.com/v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:stop`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/dataproc/docs/reference/rest/v1/projects.locations.operations#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
