Data Proc API, REST: Cluster.get
Returns the specified cluster.
To get the list of all available clusters, make a list request.
HTTP request
GET https://dataproc.api.cloud.yandex.net/dataproc/v1/clusters/{clusterId}
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the Data Proc cluster. To get a cluster ID make a list request. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"versionId": "string",
"hadoop": {
"services": [
"string"
],
"properties": "object",
"sshPublicKeys": [
"string"
],
"initializationActions": [
{
"uri": "string",
"args": [
"string"
],
"timeout": "string"
}
]
}
},
"health": "string",
"status": "string",
"zoneId": "string",
"serviceAccountId": "string",
"bucket": "string",
"uiProxy": true,
"securityGroupIds": [
"string"
],
"hostGroupIds": [
"string"
],
"deletionProtection": true,
"logGroupId": "string"
}
A Data Proc cluster. For details about the concept, see documentation.
Field | Description |
---|---|
id | string ID of the cluster. Generated at creation time. |
folderId | string ID of the folder that the cluster belongs to. |
createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
name | string Name of the cluster. The name is unique within the folder. The string length in characters must be 1-63. |
description | string Description of the cluster. The string length in characters must be 0-256. |
labels | object Cluster labels as No more than 64 per resource. |
monitoring[] | object Monitoring systems relevant to the cluster. |
monitoring[]. name |
string Name of the monitoring system. |
monitoring[]. description |
string Description of the monitoring system. |
monitoring[]. link |
string Link to the monitoring system. |
config | object Configuration of the cluster. |
config. versionId |
string Image version for cluster provisioning. All available versions are listed in the documentation. |
config. hadoop |
object Data Proc specific configuration options. Hadoop configuration that describes services installed in a cluster, their properties and settings. |
config. hadoop. services[] |
string Set of services used in the cluster (if empty, the default set is used). |
config. hadoop. properties |
object Properties set for all hosts in For example, use the key 'hdfs:dfs.replication' to set the |
config. hadoop. sshPublicKeys[] |
string List of public SSH keys to access to cluster hosts. |
config. hadoop. initializationActions[] |
object Set of init-actions |
config. hadoop. initializationActions[]. uri |
string URI of the executable file |
config. hadoop. initializationActions[]. args[] |
string Arguments to the initialization action |
config. hadoop. initializationActions[]. timeout |
string (int64) Execution timeout |
health | string Aggregated cluster health.
|
status | string Cluster status.
|
zoneId | string ID of the availability zone where the cluster resides. |
serviceAccountId | string ID of service account for the Data Proc manager agent. |
bucket | string Object Storage bucket to be used for Data Proc jobs that are run in the cluster. |
uiProxy | boolean (boolean) Whether UI Proxy feature is enabled. |
securityGroupIds[] | string User security groups. |
hostGroupIds[] | string Host groups hosting VMs of the cluster. |
deletionProtection | boolean (boolean) Deletion Protection inhibits deletion of the cluster |
logGroupId | string ID of the cloud logging log group to write logs. If not set, default log group for the folder will be used. To prevent logs from being sent to the cloud set cluster property dataproc:disable_cloud_logging = true |