Resource: Cluster
Describes the identifying information, config, and status of a cluster of Compute Engine instances.
JSON representation | |
---|---|
{ "projectId": string, "clusterName": string, "config": { object ( |
Fields | |
---|---|
projectId |
Required. The Google Cloud Platform project ID that the cluster belongs to. |
clusterName |
Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused. |
config |
Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated. |
labels |
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 |
status |
Output only. Cluster status. |
statusHistory[] |
Output only. The previous cluster status. |
clusterUuid |
Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster. |
metrics |
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 ( |
Fields | |
---|---|
state |
Output only. The cluster's state. |
detail |
Output only. Optional details of cluster's state. |
stateStartTime |
Output only. Time when this state was entered (see JSON representation of Timestamp). A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
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. |
STOPPING |
The cluster is being stopped. It cannot be used. |
STOPPED |
The cluster is currently stopped. It is not ready for use. |
STARTING |
The cluster is being started. It is not ready for use. |
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 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 |
The HDFS metrics. An object containing a list of |
yarnMetrics |
The YARN metrics. An object containing a list of |
Methods |
|
---|---|
|
Creates a cluster in a project. |
|
Deletes a cluster in a project. |
|
Gets cluster diagnostic information. |
|
Gets the resource representation for a cluster in a project. |
|
Gets the access control policy for a resource. |
|
Lists all regions/{region}/clusters in a project alphabetically. |
|
Updates a cluster in a project. |
|
Sets the access control policy on the specified resource. |
|
Starts a cluster in a project. |
|
Stops a cluster in a project. |
|
Returns permissions that a caller has on the specified resource. |