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 |
|---|---|---|---|---|
|
capacity
|
path | True |
string (uuid) |
Identyfikator pojemności. |
|
beta
|
query | True |
boolean |
Ten wymagany parametr musi być ustawiony, aby uzyskać dostęp do |
Treść żądania
| Nazwisko | Wymagane | Typ | Opis |
|---|---|---|---|
| autoScale | True |
Autoskalowanie. |
|
| dynamicExecutorAllocation | True |
Alokacja funkcji wykonawczej dynamicznej. |
|
| name | True |
string |
Nazwa puli niestandardowej. |
| nodeFamily | True |
Rodzina węzłów. |
|
| nodeSize | True |
Rozmiar węzła. |
Odpowiedzi
| Nazwisko | Typ | Opis |
|---|---|---|
| 201 Created |
Żądanie zostało ukończone pomyślnie. Nagłówki:
Lokalizacji |
|
| 429 Too Many Requests |
Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Nagłówki Retry-After: integer |
|
| Other Status Codes |
Typowe kody błędów:
|
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 |
|---|---|
|
Auto |
Właściwości autoskaluj. |
|
Create |
Utwórz ładunek żądania puli niestandardowej. |
|
Custom |
Pula niestandardowa. |
|
Custom |
Typ puli niestandardowej. Dodatkowe typy |
|
Dynamic |
Dynamiczne zalety alokacji funkcji wykonawczej. |
|
Error |
Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie. |
|
Error |
Obiekt szczegółowych informacji o zasobie związanym z błędem. |
|
Error |
Odpowiedź na błąd. |
|
Error |
Szczegóły odpowiedzi na błąd. |
|
Node |
Rodzina węzłów. Dodatkowe typy |
|
Node |
rozmiar węzła. Dodatkowe typy |
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 |
Autoskalowanie. |
|
| dynamicExecutorAllocation |
Alokacja funkcji wykonawczej dynamicznej. |
|
| name |
string |
Nazwa puli niestandardowej. |
| nodeFamily |
Rodzina węzłów. |
|
| nodeSize |
Rozmiar węzła. |
CustomPool
Pula niestandardowa.
| Nazwisko | Typ | Opis |
|---|---|---|
| autoScale |
Autoskalowanie. |
|
| dynamicExecutorAllocation |
Alokacja funkcji wykonawczej dynamicznej. |
|
| id |
string (uuid) |
Identyfikator puli niestandardowej. |
| name |
string |
Nazwa puli niestandardowej. |
| nodeFamily |
Rodzina węzłów. |
|
| nodeSize |
Rozmiar węzła. |
|
| type |
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 |
| message |
string |
Czytelna reprezentacja błędu przez człowieka. |
| moreDetails |
Lista dodatkowych szczegółów błędu. |
|
| parameters |
Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie. |
|
| relatedResource |
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 |
Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie. |
|
| relatedResource |
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 |