Method: projects.regions.clusters.diagnose

Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata. After the operation completes, Operation.response contains DiagnoseClusterResults.

HTTP request

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

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.diagnose

Request body

The request body contains data with the following structure:

JSON representation 
{
  "tarballGcsDir": string,
  "tarballAccess": enum (TarballAccess),
  "diagnosisInterval": {
    object (Interval)
  },
  "jobs": [
    string
  ],
  "yarnApplicationIds": [
    string
  ]
}
Fields
tarballGcsDir

string

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:

  • dataproc.clusters.diagnose
tarballAccess

enum (TarballAccess)

Optional. (Optional) The access type to the diagnostic tarball. If not specified, falls back to default access of the bucket

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

  • dataproc.clusters.diagnose
diagnosisInterval

object (Interval)

Optional. Time interval in which diagnosis should be carried out on the cluster.
jobs[]

string

Optional. Specifies a list of jobs on which diagnosis is to be performed. Format: projects/{project}/regions/{region}/jobs/{job}
yarnApplicationIds[]

string

Optional. Specifies a list of yarn applications on which diagnosis is to be performed.

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.

TarballAccess

Defines who has access to the diagnostic tarball

Enums
TARBALL_ACCESS_UNSPECIFIED 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.

JSON representation 
{
  "startTime": string,
  "endTime": string
}
Fields
startTime

string (Timestamp format)

Optional. Inclusive start of the interval.

If specified, a Timestamp matching this interval will have to be the same or after the start.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Optional. Exclusive end of the interval.

If specified, a Timestamp matching this interval will have to be before the end.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".