你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Big Data Pools - Get

参考

Service:: Synapse

API Version:: 2020-12-01

获取大数据池

GET {endpoint}/bigDataPools/{bigDataPoolName}?api-version=2020-12-01

URI 参数

名称	在	必需	类型	说明
bigDataPoolName	path	True	string	大数据池名称
endpoint	path	True	string uri	工作区开发终结点，例如 `https://myworkspace.dev.azuresynapse.net` 。
api-version	query	True	string	Synapse 客户端 API 版本。

响应

名称	类型	说明
200 OK	BigDataPoolResourceInfo	成功响应。
Other Status Codes	ErrorContract	描述操作失败原因的错误响应。

示例

Get Big Data Pool

Sample Request

HTTP

GET exampleWorkspace.dev.azuresynapse.net/bigDataPools/pool1?api-version=2020-12-01

Sample Response

Status code:: 200

{
  "properties": {
    "creationDate": "2020-07-14T10:09:52.5133333Z",
    "sparkVersion": "3.3",
    "nodeCount": 3,
    "nodeSize": "Small",
    "nodeSizeFamily": "MemoryOptimized",
    "autoScale": {
      "enabled": true,
      "minNodeCount": 3,
      "maxNodeCount": 20
    },
    "autoPause": {
      "enabled": true,
      "delayInMinutes": 15
    },
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkComputes/pool1",
  "name": "pool1",
  "type": "Microsoft.Synapse/workspaces/sparkComputes",
  "location": "southeastasia",
  "tags": {}
}

Status code:: default

{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

定义

名称	说明
AutoPauseProperties	Spark 池自动暂停属性
AutoScaleProperties	Spark 池自动缩放属性
BigDataPoolResourceInfo	大数据池
DynamicExecutorAllocation	动态执行程序分配属性
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorContract	错误详细信息。
ErrorResponse	错误响应
LibraryInfo	有关在工作区级别创建的库/包的信息。
LibraryRequirements	Spark 池库版本要求
NodeSize	大数据池中每个节点的计算能力级别。
NodeSizeFamily	大数据池提供的节点类型。

AutoPauseProperties

Spark 池自动暂停属性

名称	类型	说明
delayInMinutes	integer	大数据池自动暂停之前的空闲时间分钟数。
enabled	boolean	是否为大数据池启用了自动暂停。

AutoScaleProperties

Spark 池自动缩放属性

名称	类型	说明
enabled	boolean	是否为大数据池启用自动缩放。
maxNodeCount	integer	大数据池可以支持的最大节点数。
minNodeCount	integer	大数据池可以支持的最小节点数。

BigDataPoolResourceInfo

大数据池

名称	类型	说明
id	string	资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	资源所在的地理位置
name	string	资源的名称
properties.autoPause	AutoPauseProperties	Spark 池自动暂停属性自动暂停属性
properties.autoScale	AutoScaleProperties	Spark 池自动缩放属性自动缩放属性
properties.cacheSize	integer	缓存大小
properties.creationDate	string	创建大数据池的时间。
properties.customLibraries	LibraryInfo[]	与 Spark 池关联的自定义库/包的列表。
properties.defaultSparkLogFolder	string	将写入 Spark 日志的默认文件夹。
properties.dynamicExecutorAllocation	DynamicExecutorAllocation	动态执行程序分配
properties.isComputeIsolationEnabled	boolean	是否需要计算隔离。
properties.lastSucceededTimestamp	string	成功更新大数据池的时间。
properties.libraryRequirements	LibraryRequirements	Spark 池库版本要求库版本要求
properties.nodeCount	integer	大数据池中的节点数。
properties.nodeSize	NodeSize	大数据池中每个节点的计算能力级别。
properties.nodeSizeFamily	NodeSizeFamily	大数据池提供的节点类型。
properties.provisioningState	string	大数据池的状态。
properties.sessionLevelPackagesEnabled	boolean	会话级别包是否已启用。
properties.sparkConfigProperties	LibraryRequirements	Spark 池库版本要求用于指定其他属性的 Spark 配置文件
properties.sparkEventsFolder	string	Spark 事件文件夹
properties.sparkVersion	string	Apache Spark 版本。
tags	object	资源标记。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

DynamicExecutorAllocation

动态执行程序分配属性

名称	类型	说明
enabled	boolean	指示是否启用动态执行程序分配。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorContract

错误详细信息。

名称	类型	说明
error	ErrorResponse	错误响应错误详细信息。

ErrorResponse

错误响应

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorResponse[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

LibraryInfo

有关在工作区级别创建的库/包的信息。

名称	类型	说明
containerName	string	存储 Blob 容器名称。
creatorId	string	库/包的创建者 ID。
name	string	库的名称。
path	string	库的存储 Blob 路径。
provisioningStatus	string	库/包的预配状态。
type	string	库的类型。
uploadedTimestamp	string	库的上次更新时间。

LibraryRequirements

Spark 池库版本要求

名称	类型	说明
content	string	库要求。
filename	string	库要求文件的文件名。
time	string	库要求文件的上次更新时间。

NodeSize

大数据池中每个节点的计算能力级别。

名称	类型	说明
Large	string
Medium	string
None	string
Small	string
XLarge	string
XXLarge	string
XXXLarge	string

NodeSizeFamily

大数据池提供的节点类型。

名称	类型	说明
MemoryOptimized	string
None	string