Udostępnij za pośrednictwem

Operacji

  • Artykuł

Pobieranie węzłów klastra

GET /clusters/{cluster}/nodes

Parametry

Typ Nazwa Opis Schemat
ścieżki klastra
wymagane		 Klaster do wykonywania zapytań struna
Query operacji
opcjonalne		 Jeśli zostanie podana, zwraca tylko węzły dla tego identyfikatora operacji i zawiera atrybut operacji w treści struna
Query request_id
opcjonalne		 Jeśli zostanie podana, zwraca tylko węzły dla operacji zidentyfikowane przez ten identyfikator żądania,
i zawiera atrybut operacji w treści		 struna

Odpowiedzi

Kod HTTP Opis Schemat
200 OK NodeList
400 Nieprawidłowa specyfikacja Brak zawartości
404 Nie znaleziono Brak zawartości

Przykładowe żądanie HTTP

Ścieżka żądania

/clusters/CLUSTER_NAME/nodes

Przykładowa odpowiedź HTTP

Odpowiedź 200

{
  "nodes" : [ { } ],
  "operation" : {
    "action" : "string",
    "startTime" : "2020-01-01T12:34:56Z"
  }
}

Tworzenie węzłów klastra

POST /clusters/{cluster}/nodes/create

Opis

Ta operacja dodaje nowe węzły z węzłaarray do klastra. Akceptuje wiele definicji węzłów w jednym wywołaniu. Zwraca adres URL operacji, która może służyć do śledzenia stanu operacji.

Parametry

Typ Nazwa Opis Schemat
ścieżki klastra
wymagane		 Klaster do dodawania węzłów do struna
Treść węzłów
wymagane		 Zestawy węzłów do utworzenia NodeCreationRequest

Odpowiedzi

Kod HTTP Opis Schemat
202 Akceptowane
nagłówki:
Location (ciąg) : adres URL operacji.		 NodeCreationResult
409 Nieprawidłowe dane wejściowe Brak zawartości

Przykładowe żądanie HTTP

Ścieżka żądania

/clusters/CLUSTER_NAME/nodes/create

Treść żądania

{
  "requestId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

Przykładowa odpowiedź HTTP

Odpowiedź 202

{
  "operationId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

Cofanie przydziału węzłów klastra

POST /clusters/{cluster}/nodes/deallocate

Opis

Ta operacja cofa przydział węzłów w klastrze. Węzły można zidentyfikować na kilka sposobów, w tym nazwę węzła, identyfikator węzła lub według filtru.

Parametry

Typ Nazwa Opis Schemat
ścieżki klastra
wymagane		 Klaster do cofnięcia przydziału węzłów w struna
Treść akcja
wymagane		 Opis węzłów do cofnięcia przydziału NodeManagementRequest

Odpowiedzi

Kod HTTP Opis Schemat
202 Akceptowane
nagłówki:
Location (ciąg) : adres URL operacji.		 NodeManagementResult
409 Nieprawidłowe dane wejściowe Brak zawartości

Przykładowe żądanie HTTP

Ścieżka żądania

/clusters/CLUSTER_NAME/nodes/deallocate

Treść żądania

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Przykładowa odpowiedź HTTP

Odpowiedź 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Kończenie i usuwanie węzłów klastra

POST /clusters/{cluster}/nodes/remove

Opis

Ta operacja usuwa węzły w klastrze. Węzły można zidentyfikować na kilka sposobów, w tym nazwę węzła, identyfikator węzła lub według filtru. Należy pamiętać, że domyślnie węzły są usuwane po zakończeniu (chyba że węzeł ma ustawioną wartość true), w takim przypadku to wywołanie nie różni się od zakończenia.

Parametry

Typ Nazwa Opis Schemat
ścieżki klastra
wymagane		 Klaster do usuwania węzłów w struna
Treść akcja
wymagane		 Opis węzłów do usunięcia NodeManagementRequest

Odpowiedzi

Kod HTTP Opis Schemat
202 Akceptowane
nagłówki:
Location (ciąg) : adres URL operacji.		 NodeManagementResult
409 Nieprawidłowe dane wejściowe Brak zawartości

Przykładowe żądanie HTTP

Ścieżka żądania

/clusters/CLUSTER_NAME/nodes/remove

Treść żądania

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Przykładowa odpowiedź HTTP

Odpowiedź 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Kończenie lub cofanie przydziału węzłów klastra

POST /clusters/{cluster}/nodes/shutdown

Opis

Ta operacja kończy lub cofa przydział węzłów w klastrze, w zależności od tego, czy atrybut ShutdownPolicy w każdym węźle ma wartość Terminate (wartość domyślna) lub Cofnij przydział, odpowiednio.

Parametry

Typ Nazwa Opis Schemat
ścieżki klastra
wymagane		 Klaster do zamykania węzłów w programie struna
Treść akcja
wymagane		 Opis węzłów do zamknięcia NodeManagementRequest

Odpowiedzi

Kod HTTP Opis Schemat
202 Akceptowane
nagłówki:
Location (ciąg) : adres URL operacji.		 NodeManagementResult
409 Nieprawidłowe dane wejściowe Brak zawartości

Przykładowe żądanie HTTP

Ścieżka żądania

/clusters/CLUSTER_NAME/nodes/shutdown

Treść żądania

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Przykładowa odpowiedź HTTP

Odpowiedź 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Uruchamianie cofniętych przydziałów lub zakończonych węzłów klastra

POST /clusters/{cluster}/nodes/start

Opis

Ta operacja uruchamia węzły w klastrze. Węzły można zidentyfikować na kilka sposobów, w tym nazwę węzła, identyfikator węzła lub według filtru.

Parametry

Typ Nazwa Opis Schemat
ścieżki klastra
wymagane		 Klaster do uruchamiania węzłów w struna
Treść akcja
wymagane		 Opis węzłów do uruchomienia NodeManagementRequest

Odpowiedzi

Kod HTTP Opis Schemat
202 Akceptowane
nagłówki:
Location (ciąg) : adres URL operacji.		 NodeManagementResult
409 Nieprawidłowe dane wejściowe Brak zawartości

Przykładowe żądanie HTTP

Ścieżka żądania

/clusters/CLUSTER_NAME/nodes/start

Treść żądania

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Przykładowa odpowiedź HTTP

Odpowiedź 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Kończenie węzłów klastra

POST /clusters/{cluster}/nodes/terminate

Opis

Ta operacja kończy węzły w klastrze. Węzły można zidentyfikować na kilka sposobów, w tym nazwę węzła, identyfikator węzła lub według filtru.

Parametry

Typ Nazwa Opis Schemat
ścieżki klastra
wymagane		 Klaster do zakończenia węzłów w struna
Treść akcja
wymagane		 Opis węzłów do zakończenia NodeManagementRequest

Odpowiedzi

Kod HTTP Opis Schemat
202 Akceptowane
nagłówki:
Location (ciąg) : adres URL operacji.		 NodeManagementResult
409 Nieprawidłowe dane wejściowe Brak zawartości

Przykładowe żądanie HTTP

Ścieżka żądania

/clusters/CLUSTER_NAME/nodes/terminate

Treść żądania

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Przykładowa odpowiedź HTTP

Odpowiedź 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Skalowanie klastra do rozmiaru

POST /clusters/{cluster}/scale/{nodearray}

Opis

Ta operacja dodaje węzły zgodnie z potrzebami do węzłaarray, aby osiągnąć łączną liczbę. Żądanie jest przetwarzane jednorazowo i nie dodaje ponownie węzłów później, aby zachować daną liczbę. Jest to skalowane według łącznej liczby rdzeni lub węzłów całkowitych, ale nie obu tych węzłów. Zwraca adres URL operacji, która może służyć do śledzenia stanu operacji.

Parametry

Typ Nazwa Opis Schemat
ścieżki klastra
wymagane		 Klaster do dodawania węzłów do struna
ścieżki nodearray
wymagane		 Węzełarray do dodawania węzłów do struna
Query totalCoreCount
opcjonalne		 Całkowita liczba rdzeni, które mają znajdować się w tej tablicy węzłów, w tym węzły, które zostały już utworzone liczba całkowita
Query totalNodeCount
opcjonalne		 Całkowita liczba maszyn, które mają znajdować się w tej tablicy węzłów, łącznie z utworzonymi węzłami liczba całkowita

Odpowiedzi

Kod HTTP Opis Schemat
202 Akceptowane
nagłówki:
Location (ciąg) : adres URL operacji.		 NodeCreationResult
409 Nieprawidłowe dane wejściowe Brak zawartości

Przykładowe żądanie HTTP

Ścieżka żądania

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Przykładowa odpowiedź HTTP

Odpowiedź 202

{
  "operationId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

Uzyskiwanie stanu klastra

GET /clusters/{cluster}/status

Opis

Ta operacja zawiera informacje dotyczące węzłów i węzłów w danym klastrze. Dla każdego węzłaarray zwraca stan każdego "zasobnika" alokacji, który może być używany, na przykład ile węzłów znajduje się w zasobniku, ile więcej można dodać itp. Każdy zasobnik to zestaw możliwych maszyn wirtualnych danego profilu sprzętu, który można utworzyć w danej lokalizacji, w ramach danego konta klienta itp. Prawidłowe zasobniki dla węzłaarray są określane przez definicję klastra użytkownika, ale limity są określane częściowo przez dostawcę usług w chmurze.

Parametry

Typ Nazwa Opis Schemat
ścieżki klastra
wymagane		 Klaster do wykonywania zapytań struna
Query węzłów
opcjonalne		 Jeśli wartość true, węzły i odwołania do węzłów są zwracane w odpowiedzi boolowski

Odpowiedzi

Kod HTTP Opis Schemat
200 OK ClusterStatus

Przykładowe żądanie HTTP

Ścieżka żądania

/clusters/CLUSTER_NAME/status

Przykładowa odpowiedź HTTP

Odpowiedź 200

{
  "maxCoreCount" : 16,
  "maxCount" : 4,
  "nodearrays" : [ "object" ],
  "nodes" : [ { } ],
  "state" : "Starting",
  "targetState" : "Started"
}

Pobieranie informacji o użyciu i opcjonalnych kosztach dla klastra

GET /clusters/{cluster}/usage

Opis

Ta operacja zwraca ogólne dane użycia (godziny podstawowe) i dane kosztów, jeśli są dostępne, dla klastra, a także podział na liczbę węzłów. Domyślnie zwraca wartość użycia bieżącego miesiąca.

Parametry

Typ Nazwa Opis Schemat
ścieżki klastra
wymagane		 Klaster do zwracania danych użycia dla struna
Query przedziału czasu
opcjonalne		 Jeśli zostanie podana, określa zakres czasu, który ma być używany dla zapytania. MonthToDate zwraca użycie dla bieżącego miesiąca, a ostatni Miesiąc zwraca użycie w poprzednim miesiącu. Funkcja weekToDate zwraca użycie dla bieżącego tygodnia (począwszy od niedzieli). parametry zapytania niestandardowe wymagają parametrów zapytania "from" i "to". Wartość domyślna to MonthToDate. Wszystkie czasy są w formacie UTC. wyliczenie (monthToDate, lastMonth, weekToDate, custom)
Query z
opcjonalne		 W przypadku niestandardowych ram czasowych jest to początek przedziału czasu w formacie ISO-8601. Jest to zaokrąglane w dół do najbliższej godziny lub dnia. struna
Query do
opcjonalne		 W przypadku niestandardowych ram czasowych jest to koniec przedziału czasu w formacie ISO-8601. Jest to zaokrąglane do najbliższej godziny lub dnia. struna
Query szczegółowości
opcjonalne		 Określa sposób agregowania danych: według godziny, codziennie lub jako pojedyncza liczba. Ta wartość domyślna to codziennie. wyliczenie (suma, codziennie, co godzinę)

Odpowiedzi

Kod HTTP Opis Schemat
200 OK ClusterUsage

Przykładowe żądanie HTTP

Ścieżka żądania

/clusters/CLUSTER_NAME/usage

Przykładowa odpowiedź HTTP

Odpowiedź 200

{
  "usage" : [ "object" ]
}

Wyświetla listę stanu operacji

GET /operations/

Parametry

Typ Nazwa Opis Schemat
Query request_id
opcjonalne		 Identyfikator żądania dla operacji. Jeśli zostanie to podane, lista będzie zawierać tylko 0 lub 1 element. struna

Odpowiedzi

Kod HTTP Opis Schemat
200 OK tablica <OperationStatus>
400 Nieprawidłowe żądanie Brak zawartości
404 Nie znaleziono Brak zawartości

Przykładowe żądanie HTTP

Ścieżka żądania

/operations/

Przykładowa odpowiedź HTTP

Odpowiedź 200

[ {
  "action" : "string",
  "startTime" : "2020-01-01T12:34:56Z"
} ]

Pobiera stan operacji według identyfikatora

GET /operations/{id}

Parametry

Typ Nazwa Opis Schemat
ścieżki identyfikatora
wymagane		 Identyfikator operacji struna

Odpowiedzi

Kod HTTP Opis Schemat
200 OK OperationStatus
404 Nie znaleziono Brak zawartości

Przykładowe żądanie HTTP

Ścieżka żądania

/operations/00000000-0000-0000-0000-000000000000

Przykładowa odpowiedź HTTP

Odpowiedź 200

{
  "action" : "string",
  "startTime" : "2020-01-01T12:34:56Z"
}

Zasoby

ClusterStatus

Stan klastra

Nazwa Opis Schemat
maxCoreCount
wymagane		 Maksymalna liczba rdzeni, które można dodać do tego klastra
Przykład: 16		 liczba całkowita
maxCount
wymagane		 Maksymalna liczba węzłów, które można dodać do tego klastra
Przykład: 4		 liczba całkowita
nodearrays
wymagane		 Przykład: [ "object" ] < nodearrays> tablicy
węzłów
opcjonalne		 Opcjonalna lista węzłów w tym klastrze uwzględniana tylko wtedy, gdy węzły=true znajdują się w zapytaniu
Przykład: [ "[node](#node)" ]		 tablica Node
stanu
opcjonalne		 Bieżący stan klastra, jeśli został uruchomiony co najmniej raz
Przykład: "Starting"		 struna
targetState
opcjonalne		 Żądany stan klastra (np. Uruchomiono lub Zakończone)
Przykład: "Started"		 struna

nodearrays

Nazwa Opis Schemat
zasobniki
wymagane		 Każdy zasobnik alokacji dla tego węzłaarray. Ustawienia "liczba rdzeni" są zawsze wielokrotną liczbą rdzeni dla tego zasobnika.
Przykład: [ "object" ]		 < zasobniki> tablicy
maxCoreCount
wymagane		 Maksymalna liczba rdzeni, które mogą znajdować się w tym węźle
Przykład: 16		 liczba całkowita
maxCount
wymagane		 Maksymalna liczba węzłów, które mogą znajdować się w tej tablicy węzłów
Przykład: 4		 liczba całkowita
nazwa
wymagane		 Węzełarray, który opisuje
Przykład: "execute"		 struna
nodearray
wymagane		 Atrybuty tego węzłaarray
Przykład: "[node](#node)"		 Node

zasobniki

Nazwa Opis Schemat
activeCoreCount
wymagane		 Liczba rdzeni używanych dla tego zasobnika w tym węźle
Przykład: 40		 liczba całkowita
activeCount
wymagane		 Liczba węzłów używanych dla tego zasobnika w tym węźle. Obejmuje to węzły, które nadal uzyskują maszynę wirtualną.
Przykład: 10		 liczba całkowita
activeNodes
opcjonalne		 Nazwy węzłów używane dla tego zasobnika w tym węźle. Obejmuje to węzły, które nadal uzyskują maszynę wirtualną. Jest to uwzględniane tylko wtedy, gdy węzły=true znajdują się w zapytaniu.
Przykład: [ "string" ]		 tablica > ciągu <
availableCoreCount
wymagane		 Ile dodatkowych rdzeni można utworzyć w tym zasobniku, w tym węźle. Zawsze wiele dostępnychcount.
Przykład: 8		 liczba całkowita
availableCount
wymagane		 Ile dodatkowych węzłów można utworzyć w tym zasobniku, w tym węźle. Należy pamiętać, że może to być mniej niż sugerowane przez parametr maxCount i usedCount, ponieważ wartość maxCount może być ograniczona globalnie.
Przykład: 2		 liczba całkowita
bucketId
wymagane		 Identyfikator tego zasobnika. Zawsze będzie to miało taką samą wartość dla danego zasobnika w węźle, o ile klaster nie zostanie usunięty.
Przykład: "00000000-0000-0000-0000-000000000000"		 struna
consumedCoreCount
wymagane		 Liczba rdzeni dla tej rodziny, które są już używane w całym regionie.
Przykład: 2		 liczba całkowita
definicji
opcjonalne		 Właściwości tego zasobnika używane do tworzenia węzłów z tego zasobnika. Interfejs API create-nodes przyjmuje tę definicję we właściwości bucket.
Przykład: "object"		 definicji
familyConsumedCoreCount
opcjonalne		 Liczba rdzeni dla tej rodziny, które są już używane w całym regionie.
Przykład: 2		 liczba całkowita
familyQuotaCoreCount
opcjonalne		 Liczba rdzeni, które można uruchomić dla tej rodziny w tym regionie. Może to nie być liczba całkowita wielokrotności limitu przydziału.
Przykład: 16		 liczba całkowita
familyQuotaCount
opcjonalne		 Łączna liczba wystąpień, które można uruchomić (biorąc pod uwagę wartość familyQuotaCoreCount)
Przykład: 4		 liczba całkowita
invalidReason
wymagane		 Jeśli wartość false jest prawidłowa, będzie zawierać przyczynę, dla którego zasobnik jest nieprawidłowy. Obecnie Nieaktywne i DisabledMachineType są jedynymi przyczynami.
Przykład: "DisabledMachineType"		 struna
lastCapacityFailure
wymagane		 Jak długo, w sekundach, od czasu ostatniego wystąpienia tego zasobnika, wystąpił błąd pojemności. Każda wartość ujemna jest traktowana jako nigdy.
Przykład: 180.0		 numer
maxCoreCount
wymagane		 Maksymalna liczba rdzeni, które mogą znajdować się w tym zasobniku, w tym limity globalne i węzłów. Zawsze wielokrotność parametru maxCount.
Przykład: 16		 liczba całkowita
maxCount
wymagane		 Maksymalna liczba węzłów, które mogą znajdować się w tym zasobniku, w tym limity globalne i węzłaarray
Przykład: 4		 liczba całkowita
maxPlacementGroupCoreSize
wymagane		 Maksymalna całkowita liczba rdzeni, które mogą znajdować się w grupie umieszczania w tym zasobniku. Zawsze wielokrotność parametru maxPlacementGroupSize.
Przykład: 64		 liczba całkowita
maxPlacementGroupSize
wymagane		 Maksymalna całkowita liczba wystąpień, które mogą znajdować się w grupie umieszczania w tym zasobniku
Przykład: 16		 liczba całkowita
placementGroups
wymagane		 Grupy umieszczania używane dla tego węzłaarray, jeśli istnieją.
Przykład: [ "object" ]		 tablica <placementGroups>
limitu przydziału CoreCount
wymagane		 Liczba rdzeni, które można uruchomić dla tej rodziny w tym regionie, uwzględniając również liczbę rdzeni przydziału regionalnego. Może to nie być liczba całkowita wielokrotności limitu przydziału.
Przykład: 16		 liczba całkowita
quotaCount
wymagane		 Liczba wystąpień, które można uruchomić (podane limity przydziałuCoreCount)
Przykład: 4		 liczba całkowita
regionalConsumedCoreCount
opcjonalne		 Liczba rdzeni, które są już używane w całym regionie.
Przykład: 2		 liczba całkowita
regionalQuotaCoreCount
opcjonalne		 Liczba rdzeni, które można uruchomić w tym regionie. Może to nie być liczba całkowita wielu regionalnychQuotaCount.
Przykład: 16		 liczba całkowita
regionalQuotaCount
opcjonalne		 Łączna liczba wystąpień, które można uruchomić (biorąc pod uwagę regionalną wartośćQuotaCoreCount)
Przykład: 4		 liczba całkowita
prawidłowe
wymagane		 Jeśli to prawda, ten zasobnik reprezentuje aktualnie prawidłowy zasobnik do użycia dla nowych węzłów. Jeśli wartość false, ten zasobnik reprezentuje tylko istniejące węzły.
Przykład: true		 boolowski
virtualMachine
wymagane		 Właściwości maszyn wirtualnych uruchomionych z tego zasobnika
Przykład: "object"		 virtualMachine

definicji

Nazwa Opis Schemat
machineType
wymagane		 Rozmiar maszyny wirtualnej maszyny wirtualnej
Przykład: "A2"		 struna

placementGroups

Nazwa Opis Schemat
activeCoreCount
wymagane		 Ile rdzeni jest w tym zestawie skalowania
Przykład: 16		 liczba całkowita
activeCount
wymagane		 Ile węzłów jest w tym zestawie skalowania
Przykład: 4		 liczba całkowita
nazwa
wymagane		 Unikatowy identyfikator tej grupy umieszczania
Przykład: "my-placement-group"		 struna

virtualMachine

Nazwa Opis Schemat
gpuCount
wymagane		 Liczba procesorów GPU tego typu maszyny
Przykład: 2		 liczba całkowita
infiniband
wymagane		 Jeśli ta maszyna wirtualna obsługuje łączność InfiniBand
Przykład: true		 boolowski
pamięci
wymagane		 Pamięć RAM na tej maszynie wirtualnej w GB
Przykład: 7.5		 numer
pcpuCount
wymagane		 Liczba fizycznych procesorów CPU tego typu maszyny
Przykład: 16		 liczba całkowita
vcpuCount
wymagane		 Liczba procesorów wirtualnych tego typu maszyny
Przykład: 32		 liczba całkowita
vcpuQuotaCount
opcjonalne		 Liczba procesorów wirtualnych używanych przez tę maszynę z limitu przydziału
Przykład: 2		 liczba całkowita

KlasterUsage

Informacje o użyciu i opcjonalnych kosztach dla klastra

Nazwa Opis Schemat
użycia
wymagane		 Lista użycia według interwału czasu
Przykład: [ "object" ]		 tablica użycia

użycia

Nazwa Opis Schemat
podziału
wymagane		 Podział użycia w tym interwale według kategorii "node" i "nodearray"
Przykład: [ "[clusterusageitem](#clusterusageitem)" ]		 tablica <ClusterUsageItem>
koniec
wymagane		 Koniec interwału (wyłączny)
Przykład: "string"		 struna

wymagane		 Początek interwału (włącznie)
Przykład: "string"		 struna
łączna
wymagane		 Ogólne użycie tego klastra w tym interwale z kategorią "klaster"
Przykład: "[clusterusageitem](#clusterusageitem)"		 ClusterUsageItem

KlasterUsageItem

Nazwa Opis Schemat
kategorii
wymagane		 "klaster" dla ogólnego użycia; "węzeł" dla jednego węzła głównego bez tablicy; "nodearray" dla całego węzłaarray
Przykład: "string"		 wyliczenie (klaster, węzeł, nodearray)
kosztów
opcjonalne		 Kwota, która zostanie naliczona za to użycie, w dolarach amerykańskich i według stawek detalicznych. Uwaga: wszystkie kwoty kosztów są szacowane i nie odzwierciedlają rzeczywistego rachunku!
Przykład: 0.0		 numer
szczegółów
opcjonalne		 Szczegóły rozmiaru maszyny wirtualnej używanej przez środowisko nodearray, w tym godziny, core_count, priorytet regionu i system operacyjny.
Przykład: [ "object" ]		 < szczegóły> tablicy
godzin
wymagane		 Liczba godzin użycia dla tej kategorii
Przykład: 0.0		 numer
węzła
opcjonalne		 Nazwa węzła lub węzłaarray, dla których jest używana wartość (brak danych na poziomie klastra)
Przykład: "string"		 struna

szczegółów

Nazwa Opis Schemat
core_count
opcjonalne		 Liczba rdzeni w tym rozmiarze maszyny wirtualnej
Przykład: 0.0		 numer
kosztów
opcjonalne		 Koszt tego rozmiaru maszyny wirtualnej
Przykład: 0.0		 numer
godzin
opcjonalne		 Liczba godzin użycia dla tego rozmiaru maszyny wirtualnej
Przykład: 0.0		 numer
systemu operacyjnego
opcjonalne		 Typ systemu operacyjnego
Przykład: "string"		 wyliczenie (Windows, Linux)
priorytetu
opcjonalne		 Priorytet jednostki SKU maszyny wirtualnej
Przykład: "string"		 wyliczenie (regularne, spot)
regionu
opcjonalne		 Region, w którym jest tworzone wystąpienie maszyny wirtualnej
Przykład: "string"		 struna
vm_size
opcjonalne		 Rozmiar jednostki SKU maszyny wirtualnej
Przykład: "string"		 struna

Węzeł

Rekord węzła

Typ : obiekt

NodeCreationRequest

Określa sposób dodawania węzłów do klastra

Nazwa Opis Schemat
requestId
opcjonalne		 Opcjonalny unikatowy token dostarczony przez użytkownika, aby zapobiec zduplikowaniu operacji w przypadku błędów komunikacji sieciowej. Jeśli jest to uwzględnione i pasuje do wcześniejszego identyfikatora żądania, serwer ignoruje to żądanie i zwraca błąd 409.
Przykład: "00000000-0000-0000-0000-000000000000"		 struna
zestawy
wymagane		 Lista definicji węzłów do utworzenia. Żądanie musi zawierać co najmniej jeden zestaw. Każdy zestaw może określać inny zestaw właściwości.
Przykład: [ "object" ]		 < ustawia tablicę>

zestawy

Nazwa Opis Schemat
liczba
wymagane		 Liczba węzłów do utworzenia
Przykład: 1		 liczba całkowita
definicji
opcjonalne		 Definicja zasobnika do użycia. Jest to dostarczane przez wywołanie interfejsu API stanu klastra. Jeśli brakuje niektórych elementów podanych w wywołaniu stanu lub brakuje całej właściwości zasobnika, zostanie użyty pierwszy zasobnik zgodny z podanymi elementami.
Przykład: "object"		 definicji
nameFormat
opcjonalne		 Jeśli zostanie podana, węzły będą używać tej konwencji nazewnictwa zamiast standardowego formatu "nodearray-%d"
Przykład: "custom-name-%d"		 struna
nameOffset
opcjonalne		 Jeśli zostanie podana wartość parametru nameFormat, zrównoważy indeks węzła dla nowych węzłów.
Przykład: 1		 liczba całkowita
nodeAttributes
opcjonalne		 Dodatkowe atrybuty do ustawienia w każdym węźle z tego zestawu
Przykład: "[node](#node)"		 Node
nodearray
wymagane		 Nazwa węzłaarray do uruchamiania węzłów z
Przykład: "execute"		 struna
placementGroupId
opcjonalne		 Jeśli zostanie podana, węzły o tej samej wartości dla groupId zostaną uruchomione w tej samej grupie umieszczania.
Przykład: "string"		 struna

definicji

Nazwa Opis Schemat
machineType
opcjonalne		 Przykład: "A2" struna

NodeCreationResult

Nazwa Opis Schemat
operationId
wymagane		 Identyfikator tej operacji
Przykład: "00000000-0000-0000-0000-000000000000"		 struna
zestawy
wymagane		 Tablica zestawów w takiej samej kolejności, jak w żądaniu
Przykład: [ "object" ]		 < ustawia tablicę>

zestawy

Nazwa Opis Schemat
dodano
wymagane		 Ile węzłów zostało uruchomionych w tym zestawie
Przykład: 1		 liczba całkowita
komunikatu
opcjonalne		 Wskazuje, dlaczego nie można dodać wszystkich żądanych węzłów, jeśli są obecne
Przykład: "string"		 struna

NodeList

Wyniki wyszukiwania węzła

Nazwa Opis Schemat
węzłów
wymagane		 Zwrócone węzły
Przykład: [ "[node](#node)" ]		 tablica Node
operacji
opcjonalne		 Jeśli zapytanie zawiera identyfikator operacji, jest to stan tej operacji
Przykład: "[operationstatus](#operationstatus)"		 OperationStatus

NodeManagementRequest

Określa sposób wykonywania akcji w węzłach w klastrze. Istnieje wiele sposobów określania węzłów, a jeśli jest uwzględniony więcej niż jeden sposób, jest traktowany jako związek.

Nazwa Opis Schemat
filtru
opcjonalne		 Wyrażenie filtru zgodne z węzłami. Należy pamiętać, że ciągi w wyrażeniu muszą być poprawnie cytowane.
Przykład: "State === \"Started\""		 struna
nazwy hostów
opcjonalne		 Lista krótkich nazw hostów (bez domeny) do zarządzania
Przykład: [ "hostname1", "hostname2" ]		 tablica > ciągu <
identyfikatorów
opcjonalne		 Lista identyfikatorów węzłów do zarządzania
Przykład: [ "id1", "id2" ]		 tablica > ciągu <
ip_addresses
opcjonalne		 Lista adresów IP do zarządzania
Przykład: [ "10.0.1.1", "10.1.1.2" ]		 tablica > ciągu <
nazwy
opcjonalne		 Lista nazw węzłów do zarządzania
Przykład: [ "name1", "name2" ]		 tablica > ciągu <
requestId
opcjonalne		 Opcjonalny unikatowy token dostarczony przez użytkownika, aby zapobiec zduplikowaniu operacji w przypadku błędów komunikacji sieciowej. Jeśli jest to uwzględnione i pasuje do wcześniejszego identyfikatora żądania, serwer ignoruje to żądanie i zwraca błąd 409.
Przykład: "00000000-0000-0000-0000-000000000000"		 struna

NodeManagementResult

Nazwa Opis Schemat
węzłów
wymagane		 Tablica informacji o każdym węźle pasujących do filtru w żądaniu zarządzania. Stan każdego węzła wskazuje, czy miało to wpływ na żądanie.
Przykład: [ "object" ]		 < węzłów> tablicy
operationId
wymagane		 Identyfikator tej operacji
Przykład: "00000000-0000-0000-0000-000000000000"		 struna

węzłów

Nazwa Opis Schemat
błędu
opcjonalne		 Jeśli stan to Błąd, zawiera komunikat o błędzie
Przykład: "This node must be terminated before it can be removed"		 struna
identyfikatora
wymagane		 Identyfikator węzła
Przykład: "id1"		 struna
nazwa
wymagane		 Nazwa węzła
Przykład: "name1"		 struna
stanu
opcjonalne		 Jeden z ok lub błąd
Przykład: "Error"		 wyliczenie (OK, błąd)

OperationStatus

Stan tej operacji węzła

Nazwa Opis Schemat
akcja
wymagane		 Przykład: "string" wyliczenie (tworzenie)
startTime
wymagane		 Po przesłaniu tej operacji
Przykład: "2020-01-01T12:34:56Z"		 ciąg (data/godzina)