Udostępnij przez

Operations

Pobieranie węzłów klastra

GET /clusters/{cluster}/nodes

Parameters

Typ Name Description Schema
Path cluster
required		 Klaster do wykonywania zapytań ciąg
Query operation
optional		 Jeśli zostanie podana, zwraca tylko węzły dla tego identyfikatora operacji i zawiera atrybut operacji w treści ciąg
Query request_id
optional		 Jeśli zostanie podana, zwraca tylko węzły dla operacji zidentyfikowane przez ten identyfikator żądania,
i zawiera atrybut operacji w treści		 ciąg

Responses

HTTP Code Description Schema
200 OK NodeList
400 Invalid specification No Content
404 Not found No Content

Przykładowe żądanie HTTP

Request path

/clusters/CLUSTER_NAME/nodes

Przykładowa odpowiedź HTTP

Response 200

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

Tworzenie węzłów klastra

POST /clusters/{cluster}/nodes/create

Description

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

Parameters

Typ Name Description Schema
Path cluster
required		 Klaster do dodawania węzłów do ciąg
Body nodes
required		 Zestawy węzłów do utworzenia NodeCreationRequest

Responses

HTTP Code Description Schema
202 Accepted
Headers :
Location (ciąg) : adres URL operacji.		 NodeCreationResult
409 Invalid input No Content

Przykładowe żądanie HTTP

Request path

/clusters/CLUSTER_NAME/nodes/create

Request body

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

Przykładowa odpowiedź HTTP

Response 202

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

Cofanie przydziału węzłów klastra

POST /clusters/{cluster}/nodes/deallocate

Description

Ta operacja cofa przydział węzłów w klastrze. Węzły można zidentyfikować przy użyciu kilku metod, w tym nazwy węzła, identyfikatora węzła lub filtru.

Parameters

Typ Name Description Schema
Path cluster
required		 Klaster, w którym chcesz cofnąć przydział węzłów ciąg
Body action
required		 Opis węzłów do cofnięcia przydziału NodeManagementRequest

Responses

HTTP Code Description Schema
202 Accepted
Headers :
Location (ciąg) : adres URL operacji.		 NodeManagementResult
409 Invalid input No Content

Przykładowe żądanie HTTP

Request path

/clusters/CLUSTER_NAME/nodes/deallocate

Request body

{
  "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

Response 202

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

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

POST /clusters/{cluster}/nodes/remove

Description

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 za pomocą filtru. Domyślnie węzły są usuwane po zakończeniu, chyba że węzeł ma właściwość ustawioną Fixed na true. W takim przypadku to wywołanie działa tak samo jak zakończenie.

Parameters

Typ Name Description Schema
Path cluster
required		 Klaster, w którym chcesz usunąć węzły ciąg
Body action
required		 Opis węzłów do usunięcia NodeManagementRequest

Responses

HTTP Code Description Schema
202 Accepted
Headers :
Location (ciąg) : adres URL operacji.		 NodeManagementResult
409 Invalid input No Content

Przykładowe żądanie HTTP

Request path

/clusters/CLUSTER_NAME/nodes/remove

Request body

{
  "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

Response 202

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

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

POST /clusters/{cluster}/nodes/shutdown

Description

Ta operacja kończy lub cofa przydział węzłów w klastrze. Operacja używa atrybutu ShutdownPolicy w każdym węźle, aby określić akcję. Jeśli atrybut jest ustawiony na Terminate (wartość domyślna), operacja kończy węzeł. Jeśli atrybut jest ustawiony na Deallocate, operacja cofnie przydział węzła.

Parameters

Typ Name Description Schema
Path cluster
required		 Klaster, w którym chcesz zamknąć węzły ciąg
Body action
required		 Opis węzłów do zamknięcia NodeManagementRequest

Responses

HTTP Code Description Schema
202 Accepted
Headers :
Location (ciąg) : adres URL operacji.		 NodeManagementResult
409 Invalid input No Content

Przykładowe żądanie HTTP

Request path

/clusters/CLUSTER_NAME/nodes/shutdown

Request body

{
  "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

Response 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

Description

Ta operacja uruchamia węzły w klastrze. Węzły można zidentyfikować według nazwy węzła, identyfikatora węzła lub filtru.

Parameters

Typ Name Description Schema
Path cluster
required		 Klaster do uruchamiania węzłów w ciąg
Body action
required		 Opis węzłów do uruchomienia NodeManagementRequest

Responses

HTTP Code Description Schema
202 Accepted
Headers :
Location (ciąg) : adres URL operacji.		 NodeManagementResult
409 Invalid input No Content

Przykładowe żądanie HTTP

Request path

/clusters/CLUSTER_NAME/nodes/start

Request body

{
  "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

Response 202

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

Kończenie węzłów klastra

POST /clusters/{cluster}/nodes/terminate

Description

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 za pomocą filtru.

Parameters

Typ Name Description Schema
Path cluster
required		 Klaster, w którym chcesz zakończyć węzły ciąg
Body action
required		 Opis węzłów do zakończenia NodeManagementRequest

Responses

HTTP Code Description Schema
202 Accepted
Headers :
Location (ciąg) : adres URL operacji.		 NodeManagementResult
409 Invalid input No Content

Przykładowe żądanie HTTP

Request path

/clusters/CLUSTER_NAME/nodes/terminate

Request body

{
  "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

Response 202

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

Skalowanie klastra do rozmiaru

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

Description

Ta operacja dodaje węzły zgodnie z potrzebami do tablicy węzłów, aby osiągnąć łączną liczbę. Klaster przetwarza żądanie jednorazowo. Nie powoduje ponownego dodania węzłów później, aby zachować liczbę. Można skalować według łącznej liczby rdzeni lub węzłów sumy, ale nie obu tych węzłów. Operacja zwraca adres URL używany do śledzenia stanu operacji.

Parameters

Typ Name Description Schema
Path cluster
required		 Klaster do dodawania węzłów do ciąg
Path nodearray
required		 Tablica węzłów do dodawania węzłów do ciąg
Query totalCoreCount
optional		 Całkowita liczba rdzeni w tej tablicy węzłów, łącznie z utworzonymi węzłami liczba całkowita
Query totalNodeCount
optional		 Łączna liczba maszyn w tej tablicy węzłów, w tym już utworzonych węzłów liczba całkowita

Responses

HTTP Code Description Schema
202 Accepted
Headers :
Location (ciąg) : adres URL operacji.		 NodeCreationResult
409 Invalid input No Content

Przykładowe żądanie HTTP

Request path

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Przykładowa odpowiedź HTTP

Response 202

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

Uzyskiwanie stanu klastra

GET /clusters/{cluster}/status

Description

Ta operacja zwraca informacje dotyczące węzłów i tablic węzłów w klastrze. Dla każdej tablicy węzłów zwraca stan każdego "zasobnika" alokacji, którego można użyć. Stan pokazuje, ile węzłów znajduje się w zasobniku i ile więcej węzłów można dodać. Każdy zasobnik to zestaw możliwych maszyn wirtualnych z określonym profilem sprzętu. Te maszyny wirtualne można utworzyć w określonej lokalizacji w ramach konta klienta. Definicja klastra użytkownika określa prawidłowe zasobniki dla tablicy węzłów. Dostawca usług w chmurze określa limity.

Parameters

Typ Name Description Schema
Path cluster
required		 Klaster do wykonywania zapytań ciąg
Query nodes
optional		 Jeśli wartość true, odpowiedź zawiera odwołania do węzłów i węzłów boolean

Responses

HTTP Code Description Schema
200 OK ClusterStatus

Przykładowe żądanie HTTP

Request path

/clusters/CLUSTER_NAME/status

Przykładowa odpowiedź HTTP

Response 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

Description

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.

Parameters

Typ Name Description Schema
Path cluster
required		 Klaster do zwracania danych użycia dla ciąg
Query timeframe
optional		 Zakres czasu 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 godziny są w strefie czasowej UTC. wyliczenie (monthToDate, lastMonth, weekToDate, custom)
Query from
optional		 W przypadku niestandardowych ram czasowych początek przedziału czasu w formacie ISO-8601. Wartość jest zaokrąglona w dół do najbliższej godziny lub dnia. ciąg
Query to
optional		 W przypadku niestandardowych ram czasowych użyj końca przedziału czasu w formacie ISO-8601. Wartość jest zaokrąglana do najbliższej godziny lub dnia. ciąg
Query granularity
optional		 Określa sposób agregowania danych: według godziny, codziennie lub jako pojedyncza liczba. Wartość domyślna to codziennie. wyliczenie (suma, codziennie, co godzinę)

Responses

HTTP Code Description Schema
200 OK ClusterUsage

Przykładowe żądanie HTTP

Request path

/clusters/CLUSTER_NAME/usage

Przykładowa odpowiedź HTTP

Response 200

{
  "usage" : [ "object" ]
}

Wyświetla listę stanu operacji

GET /operations/

Parameters

Typ Name Description Schema
Query request_id
optional		 Identyfikator żądania dla operacji. Jeśli podasz ten identyfikator, lista zawiera zero lub jeden element. ciąg

Responses

HTTP Code Description Schema
200 OK < OperationStatus> array
400 Invalid request No Content
404 Not found No Content

Przykładowe żądanie HTTP

Request path

/operations/

Przykładowa odpowiedź HTTP

Response 200

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

Pobiera stan operacji według identyfikatora

GET /operations/{id}

Parameters

Typ Name Description Schema
Path id
required		 Identyfikator operacji ciąg

Responses

HTTP Code Description Schema
200 OK OperationStatus
404 Not found No Content

Przykładowe żądanie HTTP

Request path

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

Przykładowa odpowiedź HTTP

Response 200

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

Resources

ClusterStatus

Stan klastra.

Name Description Schema
maxCoreCount
required		 Maksymalna liczba rdzeni, które można dodać do tego klastra.
Example : 16		 liczba całkowita
maxCount
required		 Maksymalna liczba węzłów, które można dodać do tego klastra.
Example : 4		 liczba całkowita
nodearrays
required		 Example : [ "object" ] < nodearrays> array
nodes
optional		 Opcjonalna lista węzłów w tym klastrze. Odpowiedź zawiera tę listę tylko w przypadku ustawienia nodes=true w zapytaniu.
Example : [ "[node](#node)" ]		 < Node> array
state
optional		 Bieżący stan klastra, jeśli klaster został uruchomiony co najmniej raz
Example : "Starting"		 ciąg
targetState
optional		 Żądany stan klastra (na przykład Uruchomiony lub Zakończony)
Example : "Started"		 ciąg

nodearrays

Name Description Schema
buckets
required		 Każdy zasobnik alokacji dla tej tablicy węzłów. Ustawienia "liczba rdzeni" są zawsze wielokrotną liczbą rdzeni dla tego zasobnika.
Example : [ "object" ]		 < buckets> array
maxCoreCount
required		 Maksymalna liczba rdzeni w tej tablicy węzłów
Example : 16		 liczba całkowita
maxCount
required		 Maksymalna liczba węzłów w tej tablicy węzłów
Example : 4		 liczba całkowita
name
required		 Nazwa tablicy węzłów
Example : "execute"		 ciąg
nodearray
required		 Atrybuty tej tablicy węzłów
Example : "[node](#node)"		 Node

buckets

Name Description Schema
activeCoreCount
required		 Liczba rdzeni używanych dla tego zasobnika w tej tablicy węzłów
Example : 40		 liczba całkowita
activeCount
required		 Liczba węzłów używanych dla tego zasobnika w tej tablicy węzłów. Ta liczba obejmuje węzły, które nadal uzyskują maszynę wirtualną.
Example : 10		 liczba całkowita
activeNodes
optional		 Nazwy węzłów używane dla tego zasobnika w tej tablicy węzłów. Ta lista zawiera węzły, które nadal uzyskują maszynę wirtualną. Odpowiedź zawiera tę właściwość tylko wtedy, gdy zapytanie zawiera nodes=truewartość .
Example : [ "string" ]		 <tablica ciągów >
availableCoreCount
required		 Ile dodatkowych rdzeni można utworzyć w tym zasobniku i tablicy węzłów. Ta wartość jest zawsze wielokrotną wartością availableCount.
Example : 8		 liczba całkowita
availableCount
required		 Ile dodatkowych węzłów można utworzyć w tym zasobniku i tablicy węzłów. Ta wartość może być mniejsza niż liczba uzyskana po odjęciu usedCount od maxCountelementu , ponieważ maxCount może mieć limit globalny.
Example : 2		 liczba całkowita
bucketId
required		 Identyfikator tego zasobnika. Ta wartość pozostaje taka sama dla danego zasobnika w tablicy węzłów, o ile klaster nie zostanie usunięty.
Example : "00000000-0000-0000-0000-000000000000"		 ciąg
consumedCoreCount
required		 Liczba rdzeni dla tej rodziny, które są już używane w całym regionie.
Example : 2		 liczba całkowita
definition
optional		 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 .
Example : "object"		 definition
familyConsumedCoreCount
optional		 Liczba rdzeni dla tej rodziny, które są już używane w całym regionie.
Example : 2		 liczba całkowita
familyQuotaCoreCount
optional		 Liczba rdzeni, które można uruchomić dla tej rodziny w tym regionie. Ta liczba może nie być liczbą całkowitą wielokrotną limitu przydziałuCount.
Example : 16		 liczba całkowita
familyQuotaCount
optional		 Liczba wystąpień, które można uruchomić podczas ustawiania wartości familyQuotaCoreCount.
Example : 4		 liczba całkowita
invalidReason
required		 Jeśli wartość false jest prawidłowa, pole zawiera przyczynę, dla którego zasobnik jest nieprawidłowy. Obecnie Nieaktywne i DisabledMachineType są jedynymi przyczynami.
Example : "DisabledMachineType"		 ciąg
lastCapacityFailure
required		 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.
Example : 180.0		 number
maxCoreCount
required		 Maksymalna liczba rdzeni, które mogą znajdować się w tym zasobniku, w tym limity globalne i węzłów. Zawsze wielokrotność parametru maxCount.
Example : 16		 liczba całkowita
maxCount
required		 Maksymalna liczba węzłów, które mogą znajdować się w tym zasobniku, w tym limity globalne i węzłów
Example : 4		 liczba całkowita
maxPlacementGroupCoreSize
required		 Maksymalna całkowita liczba rdzeni w grupie umieszczania dla tego zasobnika. Zawsze wielokrotność maxPlacementGroupSize.
Example : 64		 liczba całkowita
maxPlacementGroupSize
required		 Maksymalna całkowita liczba wystąpień w grupie umieszczania dla tego zasobnika.
Example : 16		 liczba całkowita
placementGroups
required		 Grupy umieszczania używane dla tej tablicy węzłów, jeśli istnieją.
Example : [ "object" ]		 < placementGroups> array
quotaCoreCount
required		 Liczba rdzeni, które można uruchomić dla tej rodziny w tym regionie. Ta liczba uwzględnia również regionalną liczbę rdzeni przydziału. Ta wartość może nie być liczbą całkowitą liczby przydziałuCount.
Example : 16		 liczba całkowita
quotaCount
required		 Liczba wystąpień, które można uruchomić, biorąc pod uwagę limit przydziałuCoreCount.
Example : 4		 liczba całkowita
regionalConsumedCoreCount
optional		 Liczba rdzeni, które są już używane w całym regionie.
Example : 2		 liczba całkowita
regionalQuotaCoreCount
optional		 Liczba rdzeni, które można uruchomić w tym regionie. Ta liczba może nie być liczbą całkowitą liczby regionalnejQuotaCount.
Example : 16		 liczba całkowita
regionalQuotaCount
optional		 Liczba wystąpień, które można uruchomić (podane regionalQuotaCoreCount)
Example : 4		 liczba całkowita
valid
required		 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.
Example : true		 boolean
virtualMachine
required		 Właściwości maszyn wirtualnych uruchamianych z tego zasobnika
Example : "object"		 virtualMachine

definition

Name Description Schema
machineType
required		 Rozmiar maszyny wirtualnej maszyny wirtualnej
Example : "A2"		 ciąg

placementGroups

Name Description Schema
activeCoreCount
required		 Liczba rdzeni w tym zestawie skalowania
Example : 16		 liczba całkowita
activeCount
required		 Liczba węzłów w tym zestawie skalowania
Example : 4		 liczba całkowita
name
required		 Unikatowy identyfikator tej grupy umieszczania
Example : "my-placement-group"		 ciąg

virtualMachine

Name Description Schema
gpuCount
required		 Liczba procesorów GPU tego typu maszyny
Example : 2		 liczba całkowita
infiniband
required		 Jeśli ta maszyna wirtualna obsługuje łączność InfiniBand
Example : true		 boolean
memory
required		 Pamięć RAM na tej maszynie wirtualnej w GB
Example : 7.5		 number
pcpuCount
required		 Liczba fizycznych procesorów CPU tego typu maszyny
Example : 16		 liczba całkowita
vcpuCount
required		 Liczba procesorów wirtualnych dla tego typu maszyny
Example : 32		 liczba całkowita
vcpuQuotaCount
optional		 Liczba procesorów wirtualnych używanych przez tę maszynę z limitu przydziału
Example : 2		 liczba całkowita

ClusterUsage

Informacje o użyciu i opcjonalnych kosztach dla klastra

Name Description Schema
usage
required		 Lista użycia według interwału czasu
Example : [ "object" ]		 < usage> array

usage

Name Description Schema
breakdown
required		 Podział użycia w tym interwale według kategorii "node" i "nodearray"
Example : [ "[clusterusageitem](#clusterusageitem)" ]		 < ClusterUsageItem> array
end
required		 Koniec interwału (wyłączny)
Example : "string"		 ciąg
start
required		 Początek interwału (włącznie)
Example : "string"		 ciąg
total
required		 Ogólne użycie tego klastra w tym interwale z kategorią "klaster"
Example : "[clusterusageitem](#clusterusageitem)"		 ClusterUsageItem

ClusterUsageItem

Name Description Schema
category
required		 "klaster" dla ogólnego użycia; "węzeł" dla jednego węzła głównego bez tablicy; "nodearray" dla całego węzłaarray
Example : "string"		 wyliczenie (klaster, węzeł, nodearray)
cost
optional		 Kwota naliczana za to użycie w dolarach amerykańskich i stawkach detalicznych. Uwaga: wszystkie kwoty kosztów są szacowane i nie odzwierciedlają rzeczywistego rachunku!
Example : 0.0		 number
details
optional		 Szczegóły rozmiaru maszyny wirtualnej używanego przez środowisko nodearray, w tym godziny, liczba rdzeni, priorytet regionu i system operacyjny.
Example : [ "object" ]		 < details> array
hours
required		 Liczba godzin użycia dla tej kategorii
Example : 0.0		 number
node
optional		 Nazwa węzła lub tablicy węzłów, dla których jest używana wartość (brak danych na poziomie klastra)
Example : "string"		 ciąg

details

Name Description Schema
core_count
optional		 Liczba rdzeni w tym rozmiarze maszyny wirtualnej
Example : 0.0		 number
cost
optional		 Koszt tego rozmiaru maszyny wirtualnej
Example : 0.0		 number
hours
optional		 Liczba godzin użycia dla tego rozmiaru maszyny wirtualnej
Example : 0.0		 number
os
optional		 Typ systemu operacyjnego
Example : "string"		 wyliczenie (Windows, Linux)
priority
optional		 Priorytet jednostki SKU maszyny wirtualnej
Example : "string"		 wyliczenie (regularne, spot)
region
optional		 Region, w którym tworzone jest wystąpienie rozmiaru maszyny wirtualnej
Example : "string"		 ciąg
vm_size
optional		 Rozmiar jednostki SKU maszyny wirtualnej
Example : "string"		 ciąg

Node

Rekord węzła.

Type : object

NodeCreationRequest

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

Name Description Schema
requestId
optional		 Opcjonalny unikatowy token dostarczony przez użytkownika, aby zapobiec zduplikowaniu operacji w przypadku błędów komunikacji sieciowej. Jeśli serwer odbiera żądanie z żądaniem zgodnym z requestId wcześniejszym żądaniem, ignoruje żądanie i zwraca błąd 409.
Example : "00000000-0000-0000-0000-000000000000"		 ciąg
sets
required		 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.
Example : [ "object" ]		 < sets> array

sets

Name Description Schema
count
required		 Liczba węzłów do utworzenia
Example : 1		 liczba całkowita
definition
optional		 Definicja zasobnika do użycia. Wywołanie interfejsu API stanu klastra zawiera tę definicję. Jeśli w wywołaniu stanu brakuje niektórych elementów lub całej właściwości zasobnika, zostanie użyty pierwszy zasobnik zgodny z podanymi elementami.
Example : "object"		 definition
nameFormat
optional		 Jeśli podasz tę wartość, węzły używają tej konwencji nazewnictwa zamiast standardowego nodearray-%d formatu
Example : "custom-name-%d"		 ciąg
nameOffset
optional		 Jeśli podasz tę właściwość za pomocą nameFormatpolecenia , właściwość zostanie przesunięty nodeindex dla nowych węzłów.
Example : 1		 liczba całkowita
nodeAttributes
optional		 Dodatkowe atrybuty ustawiane w każdym węźle w tym zestawie
Example : "[node](#node)"		 Node
nodearray
required		 Nazwa węzłów do uruchamiania nodearray z
Example : "execute"		 ciąg
placementGroupId
optional		 Jeśli podasz tę właściwość, węzły o tej samej wartości dla groupId wszystkich rozpoczynają się w tej samej grupie umieszczania.
Example : "string"		 ciąg

definition

Name Description Schema
machineType
optional		 Example : "A2" ciąg

NodeCreationResult

Name Description Schema
operationId
required		 Identyfikator operacji
Example : "00000000-0000-0000-0000-000000000000"		 ciąg
sets
required		 Tablica zestawów w takiej samej kolejności, jak w żądaniu
Example : [ "object" ]		 < sets> array

sets

Name Description Schema
added
required		 Liczba węzłów do dodania w zestawie
Example : 1		 liczba całkowita
message
optional		 Wyjaśnia, dlaczego system nie może dodać wszystkich żądanych węzłów, jeśli są obecne
Example : "string"		 ciąg

NodeList

Wyniki wyszukiwania węzła

Name Description Schema
nodes
required		 Węzły zwracane przez system
Example : [ "[node](#node)" ]		 < Node> array
operation
optional		 Jeśli zapytanie zawiera identyfikator operacji, to pole pokazuje stan tej operacji
Example : "[operationstatus](#operationstatus)"		 OperationStatus

NodeManagementRequest

Określa sposób wykonywania akcji w węzłach w klastrze. Węzły można określić na wiele sposobów. Jeśli dołączysz więcej niż jeden sposób, żądanie traktuje specyfikację jako związek.

Name Description Schema
filter
optional		 Wyrażenie filtru zgodne z węzłami. Należy pamiętać, że ciągi w wyrażeniu muszą być poprawnie cytowane.
Example : "State === \"Started\""		 ciąg
hostnames
optional		 Lista krótkich nazw hostów (bez domeny) do zarządzania
Example : [ "hostname1", "hostname2" ]		 <tablica ciągów >
ids
optional		 Lista identyfikatorów węzłów do zarządzania
Example : [ "id1", "id2" ]		 <tablica ciągów >
ip_addresses
optional		 Lista adresów IP do zarządzania
Example : [ "10.0.1.1", "10.1.1.2" ]		 <tablica ciągów >
names
optional		 Lista nazw węzłów do zarządzania
Example : [ "name1", "name2" ]		 <tablica ciągów >
requestId
optional		 Opcjonalny unikatowy token dostarczony przez użytkownika, aby zapobiec zduplikowaniu operacji w przypadku błędów komunikacji sieciowej. Jeśli serwer odbiera żądanie z elementem requestId zgodnym z wcześniejszym identyfikatorem żądania, ignoruje żądanie i zwraca błąd 409.
Example : "00000000-0000-0000-0000-000000000000"		 ciąg

NodeManagementResult

Name Description Schema
nodes
required		 Tablica informacji o każdym węźle zgodnym z filtrem w żądaniu zarządzania. Stan każdego węzła wskazuje, czy żądanie ma na nie wpływ.
Example : [ "object" ]		 < nodes> array
operationId
required		 Identyfikator tej operacji
Example : "00000000-0000-0000-0000-000000000000"		 ciąg

nodes

Name Description Schema
error
optional		 Jeśli stan to Błąd, komunikat o błędzie
Example : "This node must be terminated before it can be removed"		 ciąg
id
required		 Identyfikator węzła
Example : "id1"		 ciąg
name
required		 Nazwa węzła
Example : "name1"		 ciąg
status
optional		 Jeden z ok lub błąd
Example : "Error"		 wyliczenie (OK, błąd)

OperationStatus

Stan operacji węzła.

Name Description Schema
action
required		 Example : "string" enum (create)
startTime
required		 Po przesłaniu operacji
Example : "2020-01-01T12:34:56Z"		 string (date-time)
  • Last updated on