Dela via

Custom Pools - List Workspace Custom Pools

Tjänst:
Spark
API-version:
v1

Visa en lista över anpassade pooler.

Behörigheter

Anroparen måste ha visningsprogram eller högre arbetsyteroll.

Obligatoriska delegerade omfång

Workspace.Read.All eller Workspace.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet Stöd
Användare Ja
Tjänstens huvudnamn och hanterade identiteter Ja

Gränssnitt

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

URI-parametrar

Name I Obligatorisk Typ Description
workspaceId
 path True

string (uuid)

Arbetsmiljöns ID.
continuationToken
 query

string

Fortsättningstoken. Används för att hämta nästa objekt i listan.

Svar

Name Typ Description
200 OK

CustomPools

Begäran har slutförts.
Other Status Codes

ErrorResponse

Vanliga felkoder:

  • UnknownError – Ett fel uppstod.

Exempel

List custom pools example
List custom pools with continuation example

List custom pools example

Exempelbegäran

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

Exempelsvar

Statuskod:
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

Exempelbegäran

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

Exempelsvar

Statuskod:
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"
}

Definitioner

Name Description
AutoScaleProperties

Autoskalningsegenskaper.
CustomPool

Anpassad pool.
CustomPools
CustomPoolType

Typ av anpassad pool. Ytterligare CustomPoolType typer kan läggas till över tid.
DynamicExecutorAllocationProperties

Proerties för dynamisk exekutorallokering.
ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.
ErrorResponse

Felsvaret.
ErrorResponseDetails

Information om felsvar.
NodeFamily

Nodfamilj. Ytterligare NodeFamily typer kan läggas till över tid.
NodeSize

Nodstorlek. Ytterligare NodeSize typer kan läggas till över tid.

AutoScaleProperties

Objekt

Autoskalningsegenskaper.

Name Typ Description
enabled

boolean

Status för den automatiska skalningen. Falskt – inaktiverat, sant – aktiverat.
maxNodeCount

integer (int32)

minimum: 1

Maximalt antal noder.
minNodeCount

integer (int32)

minimum: 1

Minsta antal noder.

CustomPool

Objekt

Anpassad pool.

Name Typ Description
autoScale

AutoScaleProperties

Autoskalning.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Dynamisk körallokering.
id

string (uuid)

Anpassat pool-ID.
name

string

Namn på anpassad pool.
nodeFamily

NodeFamily

Nodfamilj.
nodeSize

NodeSize

Nodstorlek.
type

CustomPoolType

Typ av anpassad pool.

CustomPools

Objekt
Name Typ Description
continuationToken

string

Token för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
continuationUri

string

URI:n för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
value

CustomPool[]

En lista över anpassade pooler.

CustomPoolType

Uppräkning

Typ av anpassad pool. Ytterligare CustomPoolType typer kan läggas till över tid.

Värde Description
Workspace

Anpassad pool på arbetsyta
Capacity

Anpassad pool på kapacitetsnivå

DynamicExecutorAllocationProperties

Objekt

Proerties för dynamisk exekutorallokering.

Name Typ Description
enabled

boolean

Status för den dynamiska körallokeringen. Falskt – inaktiverat, sant – aktiverat.
maxExecutors

integer (int32)

minimum: 1

Maximalt antal körbara filer.
minExecutors

integer (int32)

minimum: 1

Minimiexekutorer.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name Typ Description
resourceId

string

Det resurs-ID som ingår i felet.
resourceType

string

Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message

string

En mänsklig läsbar representation av felet.
moreDetails

ErrorResponseDetails[]

Lista över ytterligare felinformation.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.
requestId

string

ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message

string

En mänsklig läsbar representation av felet.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.

NodeFamily

Uppräkning

Nodfamilj. Ytterligare NodeFamily typer kan läggas till över tid.

Värde Description
MemoryOptimized

Minnesoptimerad

NodeSize

Uppräkning

Nodstorlek. Ytterligare NodeSize typer kan läggas till över tid.

Värde Description
Small

Liten nodstorlek
Medium

Medelhög nodstorlek
Large

Stor nodstorlek
XLarge

XLarge-nodstorlek
XXLarge

XXLarge nodstorlek