Published - Get Spark Compute

Service:: Environment

Versione API:: v1

Ottenere il calcolo spark dell'ambiente.

Annotazioni

Questa API è una versione di rilascio di una versione beta a causa della deprecazione del 31 marzo 2027. Quando si chiama questa API, i chiamanti devono impostare il parametro beta di query sul valore false

Permissions

Autorizzazione di lettura per l'elemento dell'ambiente.

Ambiti delegati obbligatori

Item.Read.All o Item.ReadWrite.All o Environment.Read.All o Environment.ReadWrite.All

Microsoft Entra identità supportate

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Support
User	Yes
Principale del servizio e Identità gestite	Yes

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
environmentId	path	True	string (uuid)	ID ambiente.
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.
beta	query	True	boolean	Questo parametro specifica la versione dell'API da usare. Impostare su `false` per usare la versione di rilascio.

Risposte

Nome Tipo Descrizione

200 OK

Nome	Tipo	Descrizione
200 OK	EnvironmentSparkCompute	Richiesta completata correttamente.
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione `Retry-After` che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: UnknownError: si è verificato un errore.

EnvironmentSparkCompute

Richiesta completata correttamente.

429 Too Many Requests

ErrorResponse

È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive.

Intestazioni

Retry-After: integer

Other Status Codes

ErrorResponse

Codici di errore comuni:

UnknownError: si è verificato un errore.

Esempio

Get environment Spark compute example

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
CustomLivePoolSettings	Impostazioni di idratazione del pool live nel calcolo Spark dell'ambiente.
CustomLivePoolSupport	Flag che controlla se il supporto del pool live è attivo. È possibile aggiungere valori aggiuntivi `CustomLivePoolSupport` nel tempo.
CustomPoolMemory	Memoria del pool personalizzata per il driver Spark o l'executor Spark. È possibile aggiungere altri tipi di `CustomPoolMemory` nel tempo.
CustomPoolType	Tipo di pool personalizzato. È possibile aggiungere altri tipi di `CustomPoolType` nel tempo.
DynamicExecutorAllocationProperties	Proerità di allocazione dell'executor dinamico.
EnvironmentSparkCompute
ErrorParameter	Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
InstancePool	Pool di istanze.
SparkProperty	Una chiave della proprietà Spark e il relativo valore.

CustomLivePoolSettings

Oggetto

Impostazioni di idratazione del pool live nel calcolo Spark dell'ambiente.

Nome	Tipo	Descrizione
clusterIdleTimeout	string (duration)	Soglia di inattività dopo la quale viene rilasciato un cluster idratato, usando il formato di durata ISO 8601. Minimo: PT20M. Massimo: PT24H.
customLivePoolLifespan	string (duration)	Durata massima di attivazione di un pool live, usando il formato di durata ISO 8601. Il processo del pool live viene eseguito per questa durata e quindi termina. Minimo: PT30M. Massimo: PT24H.
maxClustersToHydrate	integer (int32) minimum: 1	Numero massimo di cluster da pre-idratare durante ogni ciclo di attivazione. Minimo: 1. Il valore massimo consentito è determinato dalle dimensioni della capacità e viene esposto nelle impostazioni del pool di istanze come `InstancePool.maxClustersToHydrateLimit`.

CustomLivePoolSupport

Enumerazione

Flag che controlla se il supporto del pool live è attivo. È possibile aggiungere valori aggiuntivi CustomLivePoolSupport nel tempo.

Valore	Descrizione
Enabled	Il supporto del pool live è attivo.
Disabled	Il supporto del pool live è inattivo. La configurazione viene mantenuta.

CustomPoolMemory

Enumerazione

Memoria del pool personalizzata per il driver Spark o l'executor Spark. È possibile aggiungere altri tipi di CustomPoolMemory nel tempo.

Valore	Descrizione
28g	28 GB di memoria.
56g	Memoria 56G.
112g	Memoria 112G.
224g	Memoria 224G.
400g	Memoria 400G.

CustomPoolType

Enumerazione

Tipo di pool personalizzato. È possibile aggiungere altri tipi di CustomPoolType nel tempo.

Valore	Descrizione
Workspace	Pool personalizzato a livello di area di lavoro
Capacity	Pool personalizzato a livello di capacità

DynamicExecutorAllocationProperties

Oggetto

Proerità di allocazione dell'executor dinamico.

Nome	Tipo	Descrizione
enabled	boolean	Stato dell'allocazione dell'executor dinamico. False - Disabilitato, true - Abilitato.
maxExecutors	integer (int32) minimum: 1	Il numero massimo di executor per l'allocazione dinamica e il valore minimo per questa proprietà è 1. Il valore massimo deve essere inferiore al pool `maxNodeCount`di istanze .
minExecutors	integer (int32) minimum: 1	Il numero minimo di executor per l'allocazione dinamica e il minimo per questa proprietà è 1. Il valore massimo deve essere inferiore a `maxExecutors`.

EnvironmentSparkCompute

Oggetto

Nome	Tipo	Descrizione
customLivePoolSettings	CustomLivePoolSettings	Impostazioni di idratazione del pool live. Controlla il modo in cui i cluster vengono pre-idratati quando è abilitato il supporto del pool live.
customLivePoolSupport	CustomLivePoolSupport	Controlla se il pool live è abilitato. Quando `Enabled`, i cluster vengono pre-idratati in base alle impostazioni di idratazione in modo che i carichi di lavoro inizino senza latenza di avvio a freddo.
driverCores	integer (int32)	Core del driver Spark. Deve essere uno dei valori seguenti: 4, 8, 16, 32, 64.
driverMemory	CustomPoolMemory	Memoria del driver Spark.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Allocazione dell'executor dinamico.
executorCores	integer (int32)	Core dell'executor Spark. Deve essere uno dei valori seguenti: 4, 8, 16, 32, 64.
executorMemory	CustomPoolMemory	Memoria dell'executor Spark.
instancePool	InstancePool	Il pool di ambiente deve essere un pool personalizzato valido. "Pool di avvio" significa usare il pool di avvio.
runtimeVersion	string	Versione di runtime, trovare i runtime dell'infrastruttura supportati. Ad esempio: 1.3
sparkProperties	SparkProperty[]	Proprietà di Spark.

ErrorParameter

Oggetto

Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.

Nome	Tipo	Descrizione
message	string	Descrizione leggibile del significato del parametro.
name	string	L'identificatore dei parametri.
value	string	Valore del parametro.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della `Retry-After` risposta per determinare il ritardo, se disponibile.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

InstancePool

Oggetto

Pool di istanze.

Nome	Tipo	Descrizione
id	string (uuid)	ID pool di istanze.
maxClustersToHydrateLimit	integer (int32)	Limite superiore calcolato dal server per l'impostazione del pool `maxClustersToHydrate` live, determinato dalle dimensioni della capacità associate a questo pool.
name	string	Nome del pool di istanze.
type	CustomPoolType	Tipo di pool di istanze.

SparkProperty

Oggetto

Una chiave della proprietà Spark e il relativo valore.

Nome	Tipo	Descrizione
key	string	Chiave della proprietà Spark.
value	string	Valore della proprietà Spark.