Published - Get Spark Compute

Tjeneste:: Environment

API-version:: v1

Hent beregning af miljøgnisten.

Notat

Denne API er en version af en betaversion, der frarådes den 31. marts 2027. Når du kalder denne API – kaldere skal angive forespørgselsparameteren beta til værdien false

Rettigheder

Læsetilladelse til miljøelementet.

Påkrævede delegerede områder

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

Microsoft Entra understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identity	Støtte
User	Ja
tjenesteprincipal og administrerede identiteter	Ja

Interface

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

URI-parametre

Navn	I	Påkrævet	Type	Beskrivelse
environmentId	path	True	string (uuid)	Miljø-id'et.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
beta	query	True	boolean	Denne parameter angiver, hvilken version af API'en der skal bruges. Angiv til at `false` bruge versionen af versionen.

Svar

Navn Type Beskrivelse

200 OK

Navn	Type	Beskrivelse
200 OK	EnvironmentSparkCompute	Anmodningen blev fuldført.
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: UnknownError – Der opstod en fejl.

EnvironmentSparkCompute

Anmodningen blev fuldført.

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

UnknownError – Der opstod en fejl.

Eksempler

Get environment Spark compute example

Eksempelanmodning

HTTP

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

Eksempelsvar

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

Navn	Beskrivelse
CustomLivePoolSettings	Indstillinger for hydrering af livebassin på miljøets spark-beregning.
CustomLivePoolSupport	Flag, der styrer, om understøttelse af livepuljer er aktiv. Der kan tilføjes flere `CustomLivePoolSupport` værdier over tid.
CustomPoolMemory	Brugerdefineret gruppehukommelse til Spark-driver eller Spark-eksekvering. Der kan tilføjes flere `CustomPoolMemory` typer over tid.
CustomPoolType	Brugerdefineret gruppetype. Der kan tilføjes flere `CustomPoolType` typer over tid.
DynamicExecutorAllocationProperties	Fordele ved dynamisk eksekvering.
EnvironmentSparkCompute
ErrorParameter	En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
InstancePool	Forekomstpuljen.
SparkProperty	En Spark-egenskabsnøgle og dens værdi.

CustomLivePoolSettings

Objekt

Indstillinger for hydrering af livebassin på miljøets spark-beregning.

Navn	Type	Beskrivelse
clusterIdleTimeout	string (duration)	Grænse for inaktivitet, hvorefter en hydreret klynge frigives ved hjælp af VARIGHEDsformatet ISO 8601. Minimum: PT20M. Maksimum: PT24H.
customLivePoolLifespan	string (duration)	Maksimal levetid for aktivering af en livegruppe ved hjælp af ISO 8601-varighedsformatet. Jobbet med den dynamiske pulje kører i denne varighed og afsluttes derefter. Minimum: PT30M. Maksimum: PT24H.
maxClustersToHydrate	integer (int32) minimum: 1	Det maksimale antal klynger, der skal præhydreres under hver aktiveringscyklus. Minimum: 1. Den maksimalt tilladte værdi bestemmes af kapacitetsstørrelsen og vises i indstillingerne for forekomstpuljen som `InstancePool.maxClustersToHydrateLimit`.

CustomLivePoolSupport

Optælling

Flag, der styrer, om understøttelse af livepuljer er aktiv. Der kan tilføjes flere CustomLivePoolSupport værdier over tid.

Værdi	Beskrivelse
Enabled	Live pool support er aktiv.
Disabled	Live pool support er inaktiv. Konfigurationen bevares.

CustomPoolMemory

Optælling

Brugerdefineret gruppehukommelse til Spark-driver eller Spark-eksekvering. Der kan tilføjes flere CustomPoolMemory typer over tid.

Værdi	Beskrivelse
28g	28 GB hukommelse.
56g	56G-hukommelse.
112g	112G hukommelse.
224g	224G hukommelse.
400g	400 G hukommelse.

CustomPoolType

Optælling

Brugerdefineret gruppetype. Der kan tilføjes flere CustomPoolType typer over tid.

Værdi	Beskrivelse
Workspace	Brugerdefineret gruppe på arbejdsområdeniveau
Capacity	Brugerdefineret gruppe på kapacitetsniveau

DynamicExecutorAllocationProperties

Objekt

Fordele ved dynamisk eksekvering.

Navn	Type	Beskrivelse
enabled	boolean	Status for den dynamiske eksekveringsallokering. False – Deaktiveret, sand – Aktiveret.
maxExecutors	integer (int32) minimum: 1	Det maksimale eksekveringsnummer for dynamisk allokering og minimum for denne egenskab er 1. Maksimumværdien skal være lavere end forekomstpuljen `maxNodeCount`.
minExecutors	integer (int32) minimum: 1	Det mindste eksekveringsnummer for dynamisk allokering og minimum for denne egenskab er 1. Maksimumværdien skal være lavere end `maxExecutors`.

EnvironmentSparkCompute

Objekt

Navn	Type	Beskrivelse
customLivePoolSettings	CustomLivePoolSettings	Indstillinger for hydrering af livebassin. Styrer, hvordan klynger hydreres på forhånd, når understøttelse af livepuljer er aktiveret.
customLivePoolSupport	CustomLivePoolSupport	Styrer, om den dynamiske gruppe er aktiveret. Når `Enabled`, hydreres klynger i henhold til hydreringsindstillingerne, så arbejdsbelastninger starter uden ventetid for kold start.
driverCores	integer (int32)	Spark-driverkerne. Skal være en af følgende værdier: 4, 8, 16, 32, 64.
driverMemory	CustomPoolMemory	Spark-driverhukommelse.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamisk eksekveringsallokering.
executorCores	integer (int32)	Spark executor core. Skal være en af følgende værdier: 4, 8, 16, 32, 64.
executorMemory	CustomPoolMemory	Spark-eksekveringshukommelse.
instancePool	InstancePool	Miljøgruppen skal være en gyldig brugerdefineret pulje. "Startbassin" betyder brug startbassin.
runtimeVersion	string	Runtime-version, find de understøttede fabric runtimes. Eksempel: 1.3
sparkProperties	SparkProperty[]	Spark-egenskaber.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn	Type	Beskrivelse
message	string	En læsevenlig beskrivelse af parameterens betydning.
name	string	Parameter-id'et.
value	string	Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Navn	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

InstancePool

Objekt

Forekomstpuljen.

Navn	Type	Beskrivelse
id	string (uuid)	Forekomstgruppe-id.
maxClustersToHydrateLimit	integer (int32)	Serverberegnet øvre grænse for indstillingen for den dynamiske pulje `maxClustersToHydrate` bestemmes af den kapacitetsstørrelse, der er knyttet til denne gruppe.
name	string	Navn på forekomstgruppe.
type	CustomPoolType	Forekomstgruppetype.

SparkProperty

Objekt

En Spark-egenskabsnøgle og dens værdi.

Navn	Type	Beskrivelse
key	string	Spark-egenskabsnøglen.
value	string	Egenskaben Spark-værdi.