Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • Машинное обучение
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Истории успеха
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex Data Processing
  • Начало работы
  • Управление доступом
  • Правила тарификации
  • Справочник Terraform
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • Start
        • Stop
        • ListOperations
        • ListHosts
        • ListUILinks
  • Метрики Monitoring
  • Аудитные логи Audit Trails
  • Публичные материалы
  • Вопросы и ответы
  • Обучающие курсы

В этой статье:

  • HTTP request
  • Path parameters
  • Response
  • Monitoring
  • ClusterConfig
  • HadoopConfig
  • InitializationAction
  1. Справочник API
  2. REST (англ.)
  3. Cluster
  4. Get

Yandex Data Processing API, REST: Cluster.Get

Статья создана
Yandex Cloud
Обновлена 24 апреля 2025 г.
  • HTTP request
  • Path parameters
  • Response
  • Monitoring
  • ClusterConfig
  • HadoopConfig
  • InitializationAction

Returns the specified cluster.

To get the list of all available clusters, make a ClusterService.List request.

HTTP requestHTTP request

GET https://dataproc.api.cloud.yandex.net/dataproc/v1/clusters/{clusterId}

Path parametersPath parameters

Field

Description

clusterId

string

Required field. ID of the Yandex Data Processing cluster.

To get a cluster ID make a ClusterService.List request.

ResponseResponse

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"
        }
      ],
      "osloginEnabled": "boolean"
    }
  },
  "health": "string",
  "status": "string",
  "zoneId": "string",
  "serviceAccountId": "string",
  "bucket": "string",
  "uiProxy": "boolean",
  "securityGroupIds": [
    "string"
  ],
  "hostGroupIds": [
    "string"
  ],
  "deletionProtection": "boolean",
  "logGroupId": "string",
  "environment": "string"
}

A Yandex Data Processing 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
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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.

description

string

Description of the cluster.

labels

object (map<string, string>)

Cluster labels as key:value pairs.

monitoring[]

Monitoring

Monitoring systems relevant to the cluster.

config

ClusterConfig

Configuration of the cluster.

health

enum (Health)

Aggregated cluster health.

  • HEALTH_UNKNOWN: Object is in unknown state (we have no data).
  • ALIVE: Object is alive and well (for example, all hosts of the cluster are alive).
  • DEAD: Object is inoperable (it cannot perform any of its essential functions).
  • DEGRADED: Object is partially alive (it can perform some of its essential functions).

status

enum (Status)

Cluster status.

  • STATUS_UNKNOWN: Cluster state is unknown.
  • CREATING: Cluster is being created.
  • RUNNING: Cluster is running normally.
  • ERROR: Cluster encountered a problem and cannot operate.
  • STOPPING: Cluster is stopping.
  • STOPPED: Cluster stopped.
  • STARTING: Cluster is starting.

zoneId

string

ID of the availability zone where the cluster resides.

serviceAccountId

string

ID of service account for the Yandex Data Processing manager agent.

bucket

string

Object Storage bucket to be used for Yandex Data Processing jobs that are run in the cluster.

uiProxy

boolean

Whether UI Proxy feature is enabled.

securityGroupIds[]

string

User security groups.

hostGroupIds[]

string

Host groups hosting VMs of the cluster.

deletionProtection

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

environment

enum (Environment)

Environment of the cluster

  • ENVIRONMENT_UNSPECIFIED
  • PRODUCTION
  • PRESTABLE

MonitoringMonitoring

Metadata of a monitoring system for a Yandex Data Processing cluster.

Field

Description

name

string

Name of the monitoring system.

description

string

Description of the monitoring system.

link

string

Link to the monitoring system.

ClusterConfigClusterConfig

Field

Description

versionId

string

Image version for cluster provisioning.
All available versions are listed in the documentation.

hadoop

HadoopConfig

Yandex Data Processing specific configuration options.

HadoopConfigHadoopConfig

Hadoop configuration that describes services installed in a cluster,
their properties and settings.

Field

Description

services[]

enum (Service)

Set of services used in the cluster (if empty, the default set is used).

  • SERVICE_UNSPECIFIED
  • HDFS
  • YARN
  • MAPREDUCE
  • HIVE
  • TEZ
  • ZOOKEEPER
  • HBASE
  • SQOOP
  • FLUME
  • SPARK
  • ZEPPELIN
  • OOZIE
  • LIVY

properties

object (map<string, string>)

Properties set for all hosts in *-site.xml configurations. The key should indicate
the service and the property.

For example, use the key 'hdfs:dfs.replication' to set the dfs.replication property
in the file /etc/hadoop/conf/hdfs-site.xml.

sshPublicKeys[]

string

List of public SSH keys to access to cluster hosts.

initializationActions[]

InitializationAction

Set of init-actions

osloginEnabled

boolean

Oslogin enable on cluster nodes

InitializationActionInitializationAction

Field

Description

uri

string

URI of the executable file

args[]

string

Arguments to the initialization action

timeout

string (int64)

Execution timeout

Была ли статья полезна?

Предыдущая
Overview
Следующая
List
Проект Яндекса
© 2025 ООО «Яндекс.Облако»