Published - Get Spark Compute

Tjeneste:: Environment

API-versjon:: v1

Få databehandling for miljøgnist.

Note

Denne API-en er en versjon av en betaversjon som skal avskrives 31. mars 2027. Når du kaller denne API-en , må innringere angi spørringsparameteren beta til verdien false

Tillatelser

Lesetillatelse for miljøelementet.

Nødvendige delegerte omfang

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

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identity	Kundestøtte
User	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

URI-parametere

Name	I	Obligatorisk	Type	Beskrivelse
environmentId	path	True	string (uuid)	Miljø-ID-en.
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.
beta	query	True	boolean	Denne parameteren angir hvilken versjon av API-en som skal brukes. Sett til å `false` bruke versjonsversjonen.

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK	EnvironmentSparkCompute	Forespørselen er fullført.
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: UnknownError - Det oppstod en feil.

EnvironmentSparkCompute

Forespørselen er fullført.

429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer

Other Status Codes

ErrorResponse

Vanlige feilkoder:

UnknownError - Det oppstod en feil.

Eksempler

Get environment Spark compute example

Eksempelforespørsel

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

Definisjoner

Name	Beskrivelse
CustomLivePoolSettings	Innstillinger for hydrering av live pool på miljøets spark-databehandling.
CustomLivePoolSupport	Flagg som kontrollerer om støtte for direkte utvalg er aktiv. Tilleggsverdier `CustomLivePoolSupport` kan legges til over tid.
CustomPoolMemory	Egendefinert utvalgsminne for Spark-driver eller Spark-eksekutor. Flere `CustomPoolMemory` typer kan legges til over tid.
CustomPoolType	Egendefinert utvalgstype. Flere `CustomPoolType` typer kan legges til over tid.
DynamicExecutorAllocationProperties	Dynamiske fordelinger for eksekutortildeling.
EnvironmentSparkCompute
ErrorParameter	En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
InstancePool	Forekomstutvalget.
SparkProperty	En Spark-egenskapsnøkkel og verdien.

CustomLivePoolSettings

Objekt

Innstillinger for hydrering av live pool på miljøets spark-databehandling.

Name	Type	Beskrivelse
clusterIdleTimeout	string (duration)	Inaktiv tidsterskel som en hydrert klynge slippes ut etter, ved hjelp av ISO 8601-varighetsformatet. Minimum: PT20M. Maksimum: PT24H.
customLivePoolLifespan	string (duration)	Maksimal levetid for aktivering av et direkte utvalg ved hjelp av ISO 8601-varighetsformatet. Live pool-jobben kjører for denne varigheten, og avsluttes deretter. Minimum: PT30M. Maksimum: PT24H.
maxClustersToHydrate	integer (int32) minimum: 1	Maksimalt antall klynger som prehydraterer under hver aktiveringssyklus. Minimum: 1. Den maksimalt tillatte verdien bestemmes av kapasitetsstørrelsen og vises på innstillingene for forekomstutvalget som `InstancePool.maxClustersToHydrateLimit`.

CustomLivePoolSupport

Opplisting

Flagg som kontrollerer om støtte for direkte utvalg er aktiv. Tilleggsverdier CustomLivePoolSupport kan legges til over tid.

Verdi	Beskrivelse
Enabled	Støtte for direkte utvalg er aktiv.
Disabled	Støtte for direkte utvalg er inaktiv. Konfigurasjonen beholdes.

CustomPoolMemory

Opplisting

Egendefinert utvalgsminne for Spark-driver eller Spark-eksekutor. Flere CustomPoolMemory typer kan legges til over tid.

Verdi	Beskrivelse
28g	28 GB minne.
56g	56 G minne.
112g	112 G minne.
224g	224 G minne.
400g	400 G minne.

CustomPoolType

Opplisting

Egendefinert utvalgstype. Flere CustomPoolType typer kan legges til over tid.

Verdi	Beskrivelse
Workspace	Egendefinert utvalg på arbeidsområdenivå
Capacity	Egendefinert utvalg på kapasitetsnivå

DynamicExecutorAllocationProperties

Objekt

Dynamiske fordelinger for eksekutortildeling.

Name	Type	Beskrivelse
enabled	boolean	Statusen for den dynamiske eksekutortildelingen. False - Deaktivert, sann - Aktivert.
maxExecutors	integer (int32) minimum: 1	Maksimalt executor-nummer for dynamisk tildeling og minimum for denne egenskapen er 1. Maksimumsverdien må være lavere enn forekomstutvalget `maxNodeCount`.
minExecutors	integer (int32) minimum: 1	Minimumsnummeret for eksekutor for dynamisk tildeling og minimum for denne egenskapen er 1. Maksimumsverdien må være lavere enn `maxExecutors`.

EnvironmentSparkCompute

Objekt

Name	Type	Beskrivelse
customLivePoolSettings	CustomLivePoolSettings	Innstillinger for hydrering av levende basseng. Styrer hvordan klynger er prehydrert når støtte for live pool er aktivert.
customLivePoolSupport	CustomLivePoolSupport	Kontrollerer om det direktesendte utvalget er aktivert. Når `Enabled`, er klynger prehydrert i henhold til hydreringsinnstillingene, slik at arbeidsbelastningene starter uten kald start ventetid.
driverCores	integer (int32)	Spark driverkjerne. Må være én av følgende verdier: 4, 8, 16, 32, 64.
driverMemory	CustomPoolMemory	Spark-driverminne.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamisk eksekutortildeling.
executorCores	integer (int32)	Spark-eksekutorkjerne. Må være én av følgende verdier: 4, 8, 16, 32, 64.
executorMemory	CustomPoolMemory	Spark executor-minne.
instancePool	InstancePool	Miljøutvalget må være et gyldig egendefinert utvalg. "Startutvalg" betyr å bruke startutvalget.
runtimeVersion	string	Runtime-versjonen, finn de støttede stoffkjøringene. Eksempel: 1.3
sparkProperties	SparkProperty[]	Spark-egenskaper.

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name	Type	Beskrivelse
message	string	En lesbar beskrivelse av parameterens betydning.
name	string	Parameteridentifikatoren.
value	string	Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. `Retry-After` Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

InstancePool

Objekt

Forekomstutvalget.

Name	Type	Beskrivelse
id	string (uuid)	Forekomstutvalgs-ID.
maxClustersToHydrateLimit	integer (int32)	Serverkombinert øvre grense for live pool-innstillingen `maxClustersToHydrate` , bestemmes av kapasitetsstørrelsen som er knyttet til dette utvalget.
name	string	Navn på forekomstutvalg.
type	CustomPoolType	Forekomstutvalgstype.

SparkProperty

Objekt

En Spark-egenskapsnøkkel og verdien.

Name	Type	Beskrivelse
key	string	Spark-egenskapsnøkkelen.
value	string	Spark-egenskapsverdien.