Condividi tramite

Custom Pools - List Workspace Custom Pools

  • Riferimento
Servizio:
Spark
Versione API:
v1

Elencare i pool personalizzati.

Autorizzazioni

Il chiamante deve avere ruolo visualizzatore o superiore.

Ambiti delegati obbligatori

Workspace.Read.All o Workspace.ReadWrite.All

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità Assistenza
Utente Sì
'entità servizio e identità gestite Sì

Interfaccia

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
workspaceId
 path True

string (uuid)

ID dell'area di lavoro.
continuationToken
 query

string

Token di continuazione. Consente di ottenere gli elementi successivi nell'elenco.

Risposte

Nome Tipo Descrizione
200 OK

CustomPools

Richiesta completata correttamente.
Other Status Codes

ErrorResponse

Codici di errore comuni:

  • UnknownError: si è verificato un errore.

Esempio

List custom pools example
List custom pools with continuation example

List custom pools example

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
}

Definizioni

Nome Descrizione
AutoScaleProperties

Proprietà di scalabilità automatica.
CustomPool

Pool personalizzato.
CustomPools
CustomPoolType

Tipo di pool personalizzato. È possibile aggiungere altri tipi di CustomPoolType nel tempo.
DynamicExecutorAllocationProperties

Proerità di allocazione dell'executor dinamico.
ErrorRelatedResource

Oggetto dettagli risorsa correlato all'errore.
ErrorResponse

Risposta di errore.
ErrorResponseDetails

Dettagli della risposta di errore.
NodeFamily

Famiglia di nodi. È possibile aggiungere altri tipi di NodeFamily nel tempo.
NodeSize

dimensioni del nodo. È possibile aggiungere altri tipi di NodeSize nel tempo.

AutoScaleProperties

Object

Proprietà di scalabilità automatica.

Nome Tipo Descrizione
enabled

boolean

Stato della scalabilità automatica. False - Disabilitato, true - Abilitato.
maxNodeCount

integer (int32)

minimum: 1

Numero massimo di nodi.
minNodeCount

integer (int32)

minimum: 1

Numero minimo di nodi.

CustomPool

Object

Pool personalizzato.

Nome Tipo Descrizione
autoScale

AutoScaleProperties

Abilitare la scalabilità automatica.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Allocazione dell'executor dinamico.
id

string (uuid)

ID pool personalizzato.
name

string

Nome pool personalizzato.
nodeFamily

NodeFamily

Famiglia di nodi.
nodeSize

NodeSize

Dimensioni del nodo.
type

CustomPoolType

Tipo di pool personalizzato.

CustomPools

Object
Nome Tipo Descrizione
continuationToken

string

Token per il batch del set di risultati successivo. Se non sono presenti altri record, viene rimosso dalla risposta.
continuationUri

string

URI del batch del set di risultati successivo. Se non sono presenti altri record, viene rimosso dalla risposta.
value

CustomPool[]

Elenco di pool personalizzati.

CustomPoolType

Enumerazione

Tipo di pool personalizzato. È possibile aggiungere altri tipi di CustomPoolType nel tempo.

Valore Descrizione
Capacity

Pool personalizzato a livello di capacità
Workspace

Pool personalizzato a livello di area di lavoro

DynamicExecutorAllocationProperties

Object

Proerità di allocazione dell'executor dinamico.

Nome Tipo Descrizione
enabled

boolean

Stato dell'allocazione dell'executor dinamico. False - Disabilitato, true - Abilitato.
maxExecutors

integer (int32)

minimum: 1

Numero massimo di executor.
minExecutors

integer (int32)

minimum: 1

Executor minimo.

ErrorRelatedResource

Object

Oggetto dettagli risorsa correlato all'errore.

Nome Tipo Descrizione
resourceId

string

ID risorsa coinvolto nell'errore.
resourceType

string

Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Object

Risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message

string

Rappresentazione leggibile dell'errore.
moreDetails

ErrorResponseDetails[]

Elenco di dettagli aggiuntivi sull'errore.
relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.
requestId

string

ID della richiesta associata all'errore.

ErrorResponseDetails

Object

Dettagli della risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message

string

Rappresentazione leggibile dell'errore.
relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.

NodeFamily

Enumerazione

Famiglia di nodi. È possibile aggiungere altri tipi di NodeFamily nel tempo.

Valore Descrizione
MemoryOptimized

Ottimizzata per l'uso della memoria

NodeSize

Enumerazione

dimensioni del nodo. È possibile aggiungere altri tipi di NodeSize nel tempo.

Valore Descrizione
Large

Dimensioni dei nodi di grandi dimensioni
Medium

Dimensioni medie dei nodi
Small

Dimensioni dei nodi di piccole dimensioni
XLarge

Dimensioni del nodo XLarge
XXLarge

Dimensioni del nodo XXLarge