Custom Pools - CreateCapacityCustomPool (beta)

Utwórz pulę niestandardową.

Note

Ten interfejs API jest częścią wersji beta i jest udostępniany tylko do celów ewaluacyjnych i programistycznych. Może ona ulec zmianie na podstawie opinii i nie jest zalecana do użytku produkcyjnego. Podczas wywoływania tego interfejsu API wywołujące muszą określić true jako wartość parametru betazapytania .

Uprawnienia

Obiekt wywołujący musi być administratorem pojemności.

Wymagane zakresy delegowane

Capacity.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity Support
User Yes
Główne usługi i Tożsamości zarządzane Yes

Interfejs

POST https://api.fabric.microsoft.com/v1/capacities/{capacityId}/spark/pools?beta={beta}

Parametry identyfikatora URI

Nazwisko W Wymagane Typ Opis
capacityId
path True

string (uuid)

Identyfikator pojemności.

beta
query True

boolean

Ten wymagany parametr musi być ustawiony, aby uzyskać dostęp do true tego interfejsu API, który jest obecnie w wersji beta.

Treść żądania

Nazwisko Wymagane Typ Opis
autoScale True

AutoScaleProperties

Autoskalowanie.

dynamicExecutorAllocation True

DynamicExecutorAllocationProperties

Alokacja funkcji wykonawczej dynamicznej.

name True

string

Nazwa puli niestandardowej.
Nazwa musi mieć długość od 1 do 64 znaków i musi zawierać tylko litery, cyfry, kreski, podkreślenia i spacje.
Nazwy puli niestandardowej muszą być unikatowe w obszarze roboczym.
"Pula początkowa" to zarezerwowana nazwa puli niestandardowej.

nodeFamily True

NodeFamily

Rodzina węzłów.

nodeSize True

NodeSize

Rozmiar węzła.

Odpowiedzi

Nazwisko Typ Opis
201 Created

CustomPool

Żądanie zostało ukończone pomyślnie.


Nagłówki:

Lokalizacjistring — Adres URL nowo utworzonej puli.

429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer

Other Status Codes

ErrorResponse

Typowe kody błędów:

  • UnknownError — wystąpił błąd.

Przykłady

Create custom pool example

Przykładowe żądanie

POST https://api.fabric.microsoft.com/v1/capacities/ce6db599-0877-4fb1-aa1f-9b1b8d99dc40/spark/pools?beta=True

{
  "name": "pool1",
  "nodeFamily": "MemoryOptimized",
  "nodeSize": "Small",
  "autoScale": {
    "enabled": true,
    "minNodeCount": 1,
    "maxNodeCount": 2
  },
  "dynamicExecutorAllocation": {
    "enabled": true,
    "minExecutors": 1,
    "maxExecutors": 1
  }
}

Przykładowa odpowiedź

Location: https://api.fabric.microsoft.com/v1/capacities/ce6db599-0877-4fb1-aa1f-9b1b8d99dc40/spark/pools/2367293d-b70b-4b33-97f2-161b8d04a8d7
{
  "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
  "name": "pool1",
  "type": "Capacity",
  "nodeFamily": "MemoryOptimized",
  "nodeSize": "Small",
  "autoScale": {
    "enabled": true,
    "minNodeCount": 1,
    "maxNodeCount": 2
  },
  "dynamicExecutorAllocation": {
    "enabled": true,
    "minExecutors": 1,
    "maxExecutors": 1
  }
}

Definicje

Nazwisko Opis
AutoScaleProperties

Właściwości autoskaluj.

CreateCustomPoolRequest

Utwórz ładunek żądania puli niestandardowej.

CustomPool

Pula niestandardowa.

CustomPoolType

Typ puli niestandardowej. Dodatkowe typy CustomPoolType można dodawać w czasie.

DynamicExecutorAllocationProperties

Dynamiczne zalety alokacji funkcji wykonawczej.

ErrorParameter

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

ErrorRelatedResource

Obiekt szczegółowych informacji o zasobie związanym z błędem.

ErrorResponse

Odpowiedź na błąd.

ErrorResponseDetails

Szczegóły odpowiedzi na błąd.

NodeFamily

Rodzina węzłów. Dodatkowe typy NodeFamily można dodawać w czasie.

NodeSize

rozmiar węzła. Dodatkowe typy NodeSize można dodawać w czasie.

AutoScaleProperties

Właściwości autoskaluj.

Nazwisko Typ Opis
enabled

boolean

Stan automatycznego skalowania. Fałsz — wyłączone, true — włączone.

maxNodeCount

integer (int32)

minimum: 1

Maksymalna liczba węzłów.

minNodeCount

integer (int32)

minimum: 1

Minimalna liczba węzłów.

CreateCustomPoolRequest

Utwórz ładunek żądania puli niestandardowej.

Nazwisko Typ Opis
autoScale

AutoScaleProperties

Autoskalowanie.

dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Alokacja funkcji wykonawczej dynamicznej.

name

string

Nazwa puli niestandardowej.
Nazwa musi mieć długość od 1 do 64 znaków i musi zawierać tylko litery, cyfry, kreski, podkreślenia i spacje.
Nazwy puli niestandardowej muszą być unikatowe w obszarze roboczym.
"Pula początkowa" to zarezerwowana nazwa puli niestandardowej.

nodeFamily

NodeFamily

Rodzina węzłów.

nodeSize

NodeSize

Rozmiar węzła.

CustomPool

Pula niestandardowa.

Nazwisko Typ Opis
autoScale

AutoScaleProperties

Autoskalowanie.

dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Alokacja funkcji wykonawczej dynamicznej.

id

string (uuid)

Identyfikator puli niestandardowej.

name

string

Nazwa puli niestandardowej.

nodeFamily

NodeFamily

Rodzina węzłów.

nodeSize

NodeSize

Rozmiar węzła.

type

CustomPoolType

Typ puli niestandardowej.

CustomPoolType

Typ puli niestandardowej. Dodatkowe typy CustomPoolType można dodawać w czasie.

Wartość Opis
Workspace

Pula niestandardowa na poziomie obszaru roboczego

Capacity

Pula niestandardowa na poziomie pojemności

DynamicExecutorAllocationProperties

Dynamiczne zalety alokacji funkcji wykonawczej.

Nazwisko Typ Opis
enabled

boolean

Stan alokacji funkcji wykonawczej dynamicznej. Fałsz — wyłączone, true — włączone.

maxExecutors

integer (int32)

minimum: 1

Maksymalna liczba funkcji wykonawczych.

minExecutors

integer (int32)

minimum: 1

Minimalne funkcje wykonawcze.

ErrorParameter

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwisko Typ Opis
message

string

Czytelny dla człowieka opis znaczenia parametru.

name

string

Identyfikator parametru.

value

string

Wartość parametru.

ErrorRelatedResource

Obiekt szczegółowych informacji o zasobie związanym z błędem.

Nazwisko Typ Opis
resourceId

string

Identyfikator zasobu powiązany z błędem.

resourceType

string

Typ zasobu powiązanego z błędem.

ErrorResponse

Odpowiedź na błąd.

Nazwisko Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.

isRetriable

boolean

Jeśli to prawda, żądanie można ponowić. Użyj nagłówka Retry-After odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.

message

string

Czytelna reprezentacja błędu przez człowieka.

moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.

parameters

ErrorParameter[]

Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.

relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

requestId

string (uuid)

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Szczegóły odpowiedzi na błąd.

Nazwisko Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.

message

string

Czytelna reprezentacja błędu przez człowieka.

parameters

ErrorParameter[]

Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.

relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

NodeFamily

Rodzina węzłów. Dodatkowe typy NodeFamily można dodawać w czasie.

Wartość Opis
MemoryOptimized

Zoptymalizowana pamięć

NodeSize

rozmiar węzła. Dodatkowe typy NodeSize można dodawać w czasie.

Wartość Opis
Small

Mały rozmiar węzła

Medium

Średni rozmiar węzła

Large

Duży rozmiar węzła

XLarge

Rozmiar węzła XLarge

XXLarge

Rozmiar węzła XXLarge