Custom Pools - List Workspace Custom Pools

Служба:: Spark

Версия API:: v1

Вывод списка настраиваемых пулов.

Разрешения

Вызывающий объект должен иметь или более поздней роли рабочей области.

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

Workspace.Read.All или Workspace.ReadWrite.All

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

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

Идентичность	Поддержка
Пользователь	Да
субъекта-службы и управляемых удостоверений	Да

Интерфейс

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools

С использованием необязательных параметров:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools?continuationToken={continuationToken}

Параметры URI

Имя	В	Обязательно	Тип	Описание
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
continuationToken	query		string	Маркер продолжения. Используется для получения следующих элементов в списке.

Ответы

Имя	Тип	Описание
200 OK	CustomPools	Запрос успешно завершен.
Other Status Codes	ErrorResponse	Распространенные коды ошибок: UnknownError — произошла ошибка.

Имя

Тип

Описание

200 OK

CustomPools

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

Other Status Codes

ErrorResponse

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

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

Примеры

List custom pools example

List custom pools with continuation example

List custom pools example

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

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools

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

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

{
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Starter Pool",
      "type": "Workspace",
      "nodeFamily": "MemoryOptimized",
      "nodeSize": "Medium",
      "autoScale": {
        "enabled": true,
        "minNodeCount": 1,
        "maxNodeCount": 10
      },
      "dynamicExecutorAllocation": {
        "enabled": true,
        "minExecutors": 1,
        "maxExecutors": 9
      }
    },
    {
      "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
      "name": "pool1",
      "type": "Workspace",
      "nodeFamily": "MemoryOptimized",
      "nodeSize": "Small",
      "autoScale": {
        "enabled": true,
        "minNodeCount": 1,
        "maxNodeCount": 4
      },
      "dynamicExecutorAllocation": {
        "enabled": true,
        "minExecutors": 1,
        "maxExecutors": 2
      }
    }
  ]
}

List custom pools with continuation example

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

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools

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

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

{
  "value": [
    {
      "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
      "name": "pool1",
      "type": "Workspace",
      "nodeFamily": "MemoryOptimized",
      "nodeSize": "Small",
      "autoScale": {
        "enabled": true,
        "minNodeCount": 1,
        "maxNodeCount": 4
      },
      "dynamicExecutorAllocation": {
        "enabled": true,
        "minExecutors": 1,
        "maxExecutors": 2
      }
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Определения

Имя	Описание
AutoScaleProperties	Свойства автомасштабирования.
CustomPool	Пользовательский пул.
CustomPools
CustomPoolType	Тип настраиваемого пула. С течением времени могут добавляться дополнительные `CustomPoolType` типы.
DynamicExecutorAllocationProperties	Динамические преимущества выделения исполнителя.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
NodeFamily	Семейство узлов. С течением времени могут добавляться дополнительные `NodeFamily` типы.
NodeSize	размер узла. С течением времени могут добавляться дополнительные `NodeSize` типы.

AutoScaleProperties

Object

Свойства автомасштабирования.

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

CustomPool

Object

Пользовательский пул.

Имя	Тип	Описание
autoScale	AutoScaleProperties	Автомасштабирование.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Динамическое выделение исполнителя.
id	string (uuid)	Пользовательский идентификатор пула.
name	string	Имя настраиваемого пула.
nodeFamily	NodeFamily	Семейство узлов.
nodeSize	NodeSize	Размер узла.
type	CustomPoolType	Тип настраиваемого пула.

CustomPools

Object

Имя	Тип	Описание
continuationToken	string	Маркер для следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
continuationUri	string	Универсальный код ресурса (URI) следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
value	CustomPool[]	Список настраиваемых пулов.

CustomPoolType

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

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

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

DynamicExecutorAllocationProperties

Object

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

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

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

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

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

ErrorResponseDetails

Object

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

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

NodeFamily

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

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

Значение	Описание
MemoryOptimized	Оптимизировано использование памяти

NodeSize

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

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

Значение	Описание
Small	Небольшой размер узла
Medium	Средний размер узла
Large	Размер большого узла
XLarge	Размер узла XLarge
XXLarge	Размер узла XXLarge

Поделиться через

Custom Pools - List Workspace Custom Pools

Разрешения

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

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

Интерфейс

Параметры URI

Ответы

Примеры

List custom pools example

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

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

List custom pools with continuation example

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

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

Определения

AutoScaleProperties

CustomPool

CustomPools

CustomPoolType

DynamicExecutorAllocationProperties

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

NodeFamily

NodeSize