Published - Get Spark Compute

Служба:: Environment

Версия API:: v1

Получение вычислений spark среды.

Замечание

Этот API является версией бета-версии из-за нерекомендуемой версии 31 августа 2026 года. При вызове этого API вызывающие должны задать параметр beta запроса значением. false

Permissions

Разрешение на чтение элемента среды.

Обязательные делегированные области

Item.Read.All или Item.ReadWrite.All или Environment.Read.All или Environment.ReadWrite.All

поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Support
User	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute?beta={beta}

Параметры URI

Имя	В	Обязательно	Тип	Описание
environmentId	path	True	string (uuid)	Идентификатор среды.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
beta	query	True	boolean	Этот параметр задает используемую версию API. Установите для `false` использования версии выпуска.

Ответы

Имя Тип Описание

200 OK

Имя	Тип	Описание
200 OK	EnvironmentSparkCompute	Запрос успешно завершен.
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: UnknownError — произошла ошибка.

EnvironmentSparkCompute

Запрос успешно завершен.

429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

UnknownError — произошла ошибка.

Примеры

Get environment Spark compute example

Образец запроса

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/sparkcompute?beta=false

Пример ответа

Код состояния:: 200

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace",
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    }
  ],
  "runtimeVersion": "1.2"
}

Определения

Имя	Описание
CustomPoolMemory	Пользовательский пул памяти для драйвера Spark или исполнителя Spark. С течением времени могут добавляться дополнительные `CustomPoolMemory` типы.
CustomPoolType	Тип настраиваемого пула. С течением времени могут добавляться дополнительные `CustomPoolType` типы.
DynamicExecutorAllocationProperties	Динамические преимущества выделения исполнителя.
EnvironmentSparkCompute
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
InstancePool	Пул экземпляров.
SparkProperty	Ключ свойства Spark и его значение.

CustomPoolMemory

Перечисление

Пользовательский пул памяти для драйвера Spark или исполнителя Spark. С течением времени могут добавляться дополнительные CustomPoolMemory типы.

Значение	Описание
28g	28 ГБ памяти.
56g	Память 56G.
112g	Память 112G.
224g	Память 224G.
400g	Память 400G.

CustomPoolType

Перечисление

Тип настраиваемого пула. С течением времени могут добавляться дополнительные CustomPoolType типы.

Значение	Описание
Workspace	Настраиваемый пул уровня рабочей области
Capacity	Настраиваемый пул уровня емкости

DynamicExecutorAllocationProperties

Объект

Динамические преимущества выделения исполнителя.

Имя	Тип	Описание
enabled	boolean	Состояние динамического выделения исполнителя. False — отключено, true — включено.
maxExecutors	integer (int32) minimum: 1	Максимальное число исполнителя для динамического выделения и минимальное значение для этого свойства равно 1. Максимальное значение должно быть меньше пула `maxNodeCount`экземпляров.
minExecutors	integer (int32) minimum: 1	Минимальное число исполнителя для динамического выделения и минимальное значение для этого свойства — 1. Максимальное значение должно быть меньше `maxExecutors`.

EnvironmentSparkCompute

Объект

Имя	Тип	Описание
driverCores	integer (int32)	Ядро драйвера Spark. Должно быть одним из следующих значений: 4, 8, 16, 32, 64.
driverMemory	CustomPoolMemory	Память драйвера Spark.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Динамическое выделение исполнителя.
executorCores	integer (int32)	Ядро исполнителя Spark. Должно быть одним из следующих значений: 4, 8, 16, 32, 64.
executorMemory	CustomPoolMemory	Память исполнителя Spark.
instancePool	InstancePool	Пул среды должен быть допустимым настраиваемым пулом. "Начальный пул" означает использование начального пула.
runtimeVersion	string	Версия среды выполнения, найдите поддерживаемые среды выполнения структуры. Например: 1.3
sparkProperties	SparkProperty[]	Свойства Spark.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
isRetriable	boolean	Если задано значение true, запрос можно получить. `Retry-After` Используйте заголовок ответа, чтобы определить задержку, если она доступна.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

InstancePool

Объект

Пул экземпляров.

Имя	Тип	Описание
id	string (uuid)	Идентификатор пула экземпляров.
name	string	Имя пула экземпляров.
type	CustomPoolType	Тип пула экземпляров.

SparkProperty

Объект

Ключ свойства Spark и его значение.

Имя	Тип	Описание
key	string	Ключ свойства Spark.
value	string	Значение свойства Spark.