Staging - Get Spark Compute

Tjänst:: Environment

API-version:: v1

Hämta spark-beräkning för mellanlagring av miljö.

Anmärkning

Det här API:et är en versionsversion av en betaversion som ska vara inaktuell den 31 augusti 2026. När du anropar det här API:et måste anropare ange frågeparametern beta till värdet false.

Permissions

Läsbehörighet för miljöobjektet.

Obligatoriska delegerade omfång

Item.Read.All eller Item.ReadWrite.All eller Environment.Read.All eller Environment.ReadWrite.All

Microsoft Entra identiteter som stöds

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

Identitet	Support
User	Yes
Tjänsthuvudnamn och hanterade identiteter	Yes

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
environmentId	path	True	string (uuid)	Miljö-ID:t.
workspaceId	path	True	string (uuid)	Arbetsyte-ID.
beta	query	True	boolean	Den här parametern anger vilken version av API:et som ska användas. Ange till `false` för att använda versionsversionen.

Svar

Name Typ Description

200 OK

Name	Typ	Description
200 OK	EnvironmentSparkCompute	Begäran har slutförts.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: UnknownError – Ett fel uppstod.

EnvironmentSparkCompute

Begäran har slutförts.

429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

UnknownError – Ett fel uppstod.

Exempel

Get environment staging spark compute example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace",
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603",
    "maxClustersToHydrateLimit": 10
  },
  "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",
  "customLivePoolSupport": "Enabled",
  "customLivePoolSettings": {
    "maxClustersToHydrate": 4,
    "clusterIdleTimeout": "PT20M",
    "customLivePoolLifespan": "PT1H"
  }
}

Definitioner

Name	Description
CustomLivePoolSettings	Inställningar för hydrering av livepooler i miljöns spark-beräkning.
CustomLivePoolSupport	Flagga som styr om stöd för livepool är aktivt. Ytterligare `CustomLivePoolSupport` värden kan läggas till över tid.
CustomPoolMemory	Anpassat poolminne för Spark-drivrutinen eller Spark-kören. Ytterligare `CustomPoolMemory` typer kan läggas till över tid.
CustomPoolType	Typ av anpassad pool. Ytterligare `CustomPoolType` typer kan läggas till över tid.
DynamicExecutorAllocationProperties	Proerties för dynamisk exekutorallokering.
EnvironmentSparkCompute
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
InstancePool	Instanspoolen.
SparkProperty	En Spark-egenskapsnyckel och dess värde.

CustomLivePoolSettings

Objekt

Inställningar för hydrering av livepooler i miljöns spark-beräkning.

Name	Typ	Description
clusterIdleTimeout	string (duration)	Tröskelvärde för inaktivitet efter vilken ett hydratiserat kluster släpps med formatet ISO 8601-varaktighet. Minimum: PT20M. Max: PT24H.
customLivePoolLifespan	string (duration)	Maximal livslängd för aktivering av en livepool med iso 8601-varaktighetsformatet. Livepooljobbet körs under den här varaktigheten och avslutas sedan. Minimum: PT30M. Max: PT24H.
maxClustersToHydrate	integer (int32) minimum: 1	Maximalt antal kluster som ska förhydrera under varje aktiveringscykel. Minsta antal: 1. Det högsta tillåtna värdet bestäms av kapacitetsstorleken och exponeras i instanspoolsinställningarna som `InstancePool.maxClustersToHydrateLimit`.

CustomLivePoolSupport

Uppräkning

Flagga som styr om stöd för livepool är aktivt. Ytterligare CustomLivePoolSupport värden kan läggas till över tid.

Värde	Description
Enabled	Stöd för livepooler är aktivt.
Disabled	Stöd för livepooler är inaktivt. Konfigurationen behålls.

CustomPoolMemory

Uppräkning

Anpassat poolminne för Spark-drivrutinen eller Spark-kören. Ytterligare CustomPoolMemory typer kan läggas till över tid.

Värde	Description
28g	28 GB minne.
56g	56G-minne.
112g	112G-minne.
224g	224G-minne.
400g	400G-minne.

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	Det maximala körnumret för dynamisk allokering och minimivärdet för den här egenskapen är 1. Det maximala värdet måste vara lägre än instanspoolen `maxNodeCount`.
minExecutors	integer (int32) minimum: 1	Det minsta körnumret för dynamisk allokering och minimivärdet för den här egenskapen är 1. Det maximala värdet måste vara lägre än `maxExecutors`.

EnvironmentSparkCompute

Objekt

Name	Typ	Description
customLivePoolSettings	CustomLivePoolSettings	Inställningar för hydrering av livepooler. Styr hur kluster är förhydrerade när stöd för livepool är aktiverat.
customLivePoolSupport	CustomLivePoolSupport	Styr om den aktiva poolen är aktiverad. När `Enabled`, är kluster förhydrerade enligt hydreringsinställningarna så att arbetsbelastningar startar utan svarstid för kallstart.
driverCores	integer (int32)	Spark-drivrutinskärna. Måste vara något av följande värden: 4, 8, 16, 32, 64.
driverMemory	CustomPoolMemory	Spark-drivrutinsminne.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamisk körallokering.
executorCores	integer (int32)	Spark-exekutorkärna. Måste vara något av följande värden: 4, 8, 16, 32, 64.
executorMemory	CustomPoolMemory	Spark-körminne.
instancePool	InstancePool	Miljöpoolen måste vara en giltig anpassad pool. "Startpool" innebär att använda startpool.
runtimeVersion	string	Körningsversion hittar du de infrastrukturresurser som stöds. Exempel: 1.3
sparkProperties	SparkProperty[]	Spark-egenskaper.

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.
isRetriable	boolean	När det är sant kan begäran göras på nytt. Använd svarshuvudet `Retry-After` för att fastställa fördröjningen, om den är tillgänglig.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	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.

InstancePool

Objekt

Instanspoolen.

Name	Typ	Description
id	string (uuid)	Instanspools-ID.
maxClustersToHydrateLimit	integer (int32)	Serverberäknad övre gräns för inställningen för livepoolen `maxClustersToHydrate` bestäms av den kapacitetsstorlek som är associerad med den här poolen.
name	string	Namn på instanspool.
type	CustomPoolType	Typ av instanspool.

SparkProperty

Objekt

En Spark-egenskapsnyckel och dess värde.

Name	Typ	Description
key	string	Spark-egenskapsnyckeln.
value	string	Egenskapsvärdet Spark.