Published - Get Spark Compute

Dienst:: Environment

API-Version:: v1

Umgebungs-Spark compute abrufen.

Hinweis

Diese API ist eine Version einer Betaversion, die am 31. März 2027 veraltet ist. Beim Aufrufen dieser API müssen Aufrufer den Abfrageparameter beta auf den Wert festlegen. false

Erlaubnisse

Lesen-Berechtigung für das Umgebungselement.

Erforderliche delegierte Bereiche

Item.Read.All oder Item.ReadWrite.All oder Environment.Read.All oder Environment.ReadWrite.All

Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität	Support
Benutzer	Yes
Service Principal und Verwaltete Identitäten	Yes

Schnittstelle

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
environmentId	path	True	string (uuid)	Die Umgebungs-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
beta	query	True	boolean	Dieser Parameter gibt an, welche Version der API verwendet werden soll. Legen Sie diese Einstellung fest, `false` um die Version zu verwenden.

Antworten

Name Typ Beschreibung

200 OK

Name	Typ	Beschreibung
200 OK	EnvironmentSparkCompute	Die Anforderung wurde erfolgreich abgeschlossen.
429 Too Many Requests	ErrorResponse	Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen `Retry-After` Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden. Header Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: UnknownError – Ein Fehler ist aufgetreten.

EnvironmentSparkCompute

Die Anforderung wurde erfolgreich abgeschlossen.

429 Too Many Requests

ErrorResponse

Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Get environment Spark compute example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
CustomLivePoolSettings	Einstellungen für die Hydratation im Livepool für die Spark compute der Umgebung.
CustomLivePoolSupport	Flag, das steuert, ob die Unterstützung des Livepools aktiv ist. Zusätzliche `CustomLivePoolSupport` Werte können im Laufe der Zeit hinzugefügt werden.
CustomPoolMemory	Benutzerdefinierter Poolspeicher für Spark-Treiber oder Spark-Executor. Zusätzliche `CustomPoolMemory` Typen können im Laufe der Zeit hinzugefügt werden.
CustomPoolType	Benutzerdefinierter Pooltyp. Zusätzliche `CustomPoolType` Typen können im Laufe der Zeit hinzugefügt werden.
DynamicExecutorAllocationProperties	Dynamischer Zuweisungsprozeur.
EnvironmentSparkCompute
ErrorParameter	Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
InstancePool	Der Instanzpool.
SparkProperty	Ein Spark-Eigenschaftsschlüssel und sein Wert.

CustomLivePoolSettings

Objekt

Einstellungen für die Hydratation im Livepool für die Spark compute der Umgebung.

Name	Typ	Beschreibung
clusterIdleTimeout	string (duration)	Leerlaufzeitschwellenwert, nach dem ein hydratisierter Cluster freigegeben wird, unter Verwendung des ISO 8601-Dauerformats. Minimum: PT20M. Maximum: PT24H.
customLivePoolLifespan	string (duration)	Maximale Lebensdauer einer Livepoolaktivierung mit dem ISO 8601-Dauerformat. Der Livepoolauftrag wird für diese Dauer ausgeführt und beendet. Minimum: PT30M. Maximum: PT24H.
maxClustersToHydrate	integer (int32) minimum: 1	Maximale Anzahl von Clustern, die während jedes Aktivierungszyklus vorab hydratisiert werden sollen. Mindestwert: 1 Der maximal zulässige Wert wird durch die Kapazitätsgröße bestimmt und wird für die Instanzpooleinstellungen als `InstancePool.maxClustersToHydrateLimit`verfügbar gemacht.

CustomLivePoolSupport

Enumeration

Flag, das steuert, ob die Unterstützung des Livepools aktiv ist. Zusätzliche CustomLivePoolSupport Werte können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Enabled	Die Unterstützung des Livepools ist aktiv.
Disabled	Die Unterstützung des Livepools ist inaktiv. Die Konfiguration wird beibehalten.

CustomPoolMemory

Enumeration

Benutzerdefinierter Poolspeicher für Spark-Treiber oder Spark-Executor. Zusätzliche CustomPoolMemory Typen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
28g	28 GB Arbeitsspeicher.
56g	56G Arbeitsspeicher.
112g	112G-Speicher.
224g	224G Arbeitsspeicher.
400g	400G Arbeitsspeicher.

CustomPoolType

Enumeration

Benutzerdefinierter Pooltyp. Zusätzliche CustomPoolType Typen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Workspace	Benutzerdefinierter Pool auf Arbeitsbereichsebene
Capacity	Benutzerdefinierter Pool auf Kapazitätsebene

DynamicExecutorAllocationProperties

Objekt

Dynamischer Zuweisungsprozeur.

Name	Typ	Beschreibung
enabled	boolean	Der Status der dynamischen Executorzuordnung. False – Deaktiviert, true – Aktiviert.
maxExecutors	integer (int32) minimum: 1	Die maximale Ausführungsnummer für die dynamische Zuordnung und das Minimum für diese Eigenschaft ist 1. Der Maximalwert muss niedriger als der Instanzpool `maxNodeCount`sein.
minExecutors	integer (int32) minimum: 1	Die minimale Ausführungsnummer für die dynamische Zuordnung und das Mindestmaß für diese Eigenschaft ist 1. Der Maximalwert muss niedriger sein als `maxExecutors`.

EnvironmentSparkCompute

Objekt

Name	Typ	Beschreibung
customLivePoolSettings	CustomLivePoolSettings	Hydratationseinstellungen für Livepools. Steuert, wie Cluster vorhydratisiert werden, wenn die Unterstützung des Livepools aktiviert ist.
customLivePoolSupport	CustomLivePoolSupport	Steuert, ob der Livepool aktiviert ist. Wenn `Enabled`, Cluster gemäß den Hydratationseinstellungen vorhydratisiert werden, sodass Workloads ohne Kaltstartlatenz beginnen.
driverCores	integer (int32)	Spark-Treiberkern. Muss einer der folgenden Werte sein: 4, 8, 16, 32, 64.
driverMemory	CustomPoolMemory	Spark-Treiberspeicher.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamische Ausführungszuweisung.
executorCores	integer (int32)	Spark executor core. Muss einer der folgenden Werte sein: 4, 8, 16, 32, 64.
executorMemory	CustomPoolMemory	Spark executor memory.
instancePool	InstancePool	Der Umgebungspool muss ein gültiger benutzerdefinierter Pool sein. "StarterPool" bedeutet, den Startpool zu verwenden.
runtimeVersion	string	Laufzeitversion: Suchen Sie die unterstützten Fabric-Laufzeiten. Beispiel: 1.3
sparkProperties	SparkProperty[]	Spark-Eigenschaften.

ErrorParameter

Objekt

Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt.

Name	Typ	Beschreibung
message	string	Eine lesbare Beschreibung der Bedeutung des Parameters.
name	string	Die Parameterkennung.
value	string	Der übergebene Wert

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
isRetriable	boolean	Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den `Retry-After` Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
parameters	ErrorParameter[]	Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
parameters	ErrorParameter[]	Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

InstancePool

Objekt

Der Instanzpool.

Name	Typ	Beschreibung
id	string (uuid)	Instanzpool-ID.
maxClustersToHydrateLimit	integer (int32)	Server-berechnete obere Grenze für die Einstellung des Livepools `maxClustersToHydrate` , bestimmt durch die Kapazitätsgröße, die diesem Pool zugeordnet ist.
name	string	Name des Instanzpools.
type	CustomPoolType	Instanzpooltyp.

SparkProperty

Objekt

Ein Spark-Eigenschaftsschlüssel und sein Wert.

Name	Typ	Beschreibung
key	string	Der Spark-Eigenschaftsschlüssel.
value	string	Der Spark-Eigenschaftswert.