Optional. (Optional) The output Cloud Storage directory for the diagnostic tarball. If not specified, a task-specific directory in the cluster's staging bucket will be used.
Authorization requires the following IAM permission on the specified resource tarballGcsDir:
Tarball Access unspecified. Falls back to default access of the bucket
GOOGLE_CLOUD_SUPPORT
Google Cloud Support group has read access to the diagnostic tarball
GOOGLE_DATAPROC_DIAGNOSE
Google Cloud Dataproc Diagnose service account has read access to the diagnostic tarball
Interval
Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).
The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.
If specified, a Timestamp matching this interval will have to be the same or after the start.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
If specified, a Timestamp matching this interval will have to be before the end.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
[[["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 retrieves cluster diagnostic information, returning an \u003ccode\u003eOperation\u003c/code\u003e which eventually contains \u003ccode\u003eDiagnoseClusterResults\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses \u003ccode\u003ePOST\u003c/code\u003e with a specific URL structure that includes \u003ccode\u003eprojectId\u003c/code\u003e, \u003ccode\u003eregion\u003c/code\u003e, and \u003ccode\u003eclusterName\u003c/code\u003e as path parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe request body is optional and can include details like a Cloud Storage directory for the diagnostic tarball (\u003ccode\u003etarballGcsDir\u003c/code\u003e), the tarball access type (\u003ccode\u003etarballAccess\u003c/code\u003e), and a specified diagnosis interval (\u003ccode\u003ediagnosisInterval\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires specific IAM permissions on \u003ccode\u003eclusterName\u003c/code\u003e (e.g. \u003ccode\u003edataproc.clusters.diagnose\u003c/code\u003e) and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eThe diagnostic process can be tailored to specific jobs and yarn applications, by providing their identifiers in the optional \u003ccode\u003ejobs\u003c/code\u003e and \u003ccode\u003eyarnApplicationIds\u003c/code\u003e fields respectively.\u003c/p\u003e\n"]]],[],null,["# Method: projects.regions.clusters.diagnose\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- [TarballAccess](#TarballAccess)\n- [Interval](#Interval)\n - [JSON representation](#Interval.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nGets cluster diagnostic information. The returned [Operation.metadata](/dataproc/docs/reference/rest/v1/projects.locations.operations#Operation.FIELDS.metadata) will be [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, [Operation.response](/dataproc/docs/reference/rest/v1/projects.locations.operations#Operation.FIELDS.response) contains [DiagnoseClusterResults](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults).\n\n### HTTP request\n\n`POST https://dataproc.googleapis.com/v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose`\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).\n\nTarballAccess\n-------------\n\nDefines who has access to the diagnostic tarball\n\nInterval\n--------\n\nRepresents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).\n\nThe start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time."]]