REST Resource: projects.regions.clusters

• Resource: Cluster
  • JSON representation
• ClusterStatus
  • JSON representation
• State
• Substate
• ClusterMetrics
  • JSON representation
• Methods

Resource: Cluster

Describes the identifying information, config, and status of a cluster of Compute Engine instances.

JSON representation
{ "projectId": string, "clusterName": string, "config": { object(ClusterConfig) }, "labels": { string: string, ... }, "status": { object(ClusterStatus) }, "statusHistory": [ { object(ClusterStatus) } ], "clusterUuid": string, "metrics": { object(ClusterMetrics) } }

Fields
projectId	string Required. The Google Cloud Platform project ID that the cluster belongs to.
clusterName	string Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
config	object(ClusterConfig) Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
labels	map (key: string, value: string) Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
status	object(ClusterStatus) Output only. Cluster status.
statusHistory[]	object(ClusterStatus) Output only. The previous cluster status.
clusterUuid	string Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
metrics	object(ClusterMetrics) Output only. Contains cluster daemon metrics such as HDFS and YARN stats. Beta Feature: This report is available for testing purposes only. It may be changed before final release.

ClusterStatus

The status of a cluster and its instances.

JSON representation
{ "state": enum(State), "detail": string, "stateStartTime": string, "substate": enum(Substate) }

Fields
state	enum(State) Output only. The cluster's state.
detail	string Output only. Optional details of cluster's state.
stateStartTime	string (Timestamp format) Output only. Time when this state was entered. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
substate	enum(Substate) Output only. Additional state information that includes status reported by the agent.

State

The cluster state.

Enums
UNKNOWN	The cluster state is unknown.
CREATING	The cluster is being created and set up. It is not ready for use.
RUNNING	The cluster is currently running and healthy. It is ready for use.
ERROR	The cluster encountered an error. It is not ready for use.
DELETING	The cluster is being deleted. It cannot be used.
UPDATING	The cluster is being updated. It continues to accept and process jobs.

Substate

The cluster substate.

Enums
UNSPECIFIED	The cluster substate is unknown.
UNHEALTHY	The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted). Applies to RUNNING state.
STALE_STATUS	The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent). Applies to RUNNING state.

ClusterMetrics

Contains cluster daemon metrics, such as HDFS and YARN stats.

Beta Feature: This report is available for testing purposes only. It may be changed before final release.

JSON representation
{ "hdfsMetrics": { string: string, ... }, "yarnMetrics": { string: string, ... } }

Fields
hdfsMetrics	map (key: string, value: string (int64 format)) The HDFS metrics. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
yarnMetrics	map (key: string, value: string (int64 format)) The YARN metrics. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Methods
create	Creates a cluster in a project.
delete	Deletes a cluster in a project.
diagnose	Gets cluster diagnostic information.
get	Gets the resource representation for a cluster in a project.
getIamPolicy	Gets the access control policy for a resource.
list	Lists all regions/{region}/clusters in a project.
patch	Updates a cluster in a project.
setIamPolicy	Sets the access control policy on the specified resource.
testIamPermissions	Returns permissions that a caller has on the specified resource.