Pobieranie listy informacji o węźle
Pobiera listę węzłów w klastrze usługi Service Fabric.
Odpowiedź zawiera nazwę, stan, identyfikator, kondycję, czas pracy i inne szczegóły dotyczące węzłów.
Żądanie
Metoda | Identyfikator URI żądania |
---|---|
GET | /Nodes?api-version=6.3&ContinuationToken={ContinuationToken}&NodeStatusFilter={NodeStatusFilter}&MaxResults={MaxResults}&timeout={timeout} |
Parametry
Nazwa | Typ | Wymagane | Lokalizacja |
---|---|---|---|
api-version |
ciąg | Tak | Zapytanie |
ContinuationToken |
ciąg | Nie | Zapytanie |
NodeStatusFilter |
ciąg (wyliczenie) | Nie | Zapytanie |
MaxResults |
liczba całkowita (int64) | Nie | Zapytanie |
timeout |
liczba całkowita (int64) | Nie | Zapytanie |
api-version
Typ: ciąg
Wymagane: Tak
Ustawienie domyślne: 6.3
Wersja interfejsu API. Ten parametr jest wymagany, a jego wartość musi mieć wartość "6,3".
Wersja interfejsu API REST usługi Service Fabric jest oparta na wersji środowiska uruchomieniowego, w której wprowadzono lub zmieniono interfejs API. Środowisko uruchomieniowe usługi Service Fabric obsługuje więcej niż jedną wersję interfejsu API. Ta wersja jest najnowszą obsługiwaną wersją interfejsu API. Jeśli zostanie przekazana niższa wersja interfejsu API, zwrócona odpowiedź może być inna niż ta udokumentowana w tej specyfikacji.
Ponadto środowisko uruchomieniowe akceptuje każdą wersję, która jest wyższa niż najnowsza obsługiwana wersja do bieżącej wersji środowiska uruchomieniowego. Jeśli więc najnowsza wersja interfejsu API to 6.0, a środowisko uruchomieniowe to 6.1, środowisko uruchomieniowe zaakceptuje wersję 6.1 dla tego interfejsu API. Jednak zachowanie interfejsu API będzie zgodnie z udokumentowaną wersją 6.0.
ContinuationToken
Typ: ciąg
Wymagane: Nie
Parametr tokenu kontynuacji służy do uzyskiwania następnego zestawu wyników. Token kontynuacji z wartością niepustą jest uwzględniany w odpowiedzi interfejsu API, gdy wyniki z systemu nie mieszczą się w jednej odpowiedzi. Po przekazaniu tej wartości do następnego wywołania interfejsu API interfejs API interfejs API zwraca następny zestaw wyników. Jeśli nie ma dalszych wyników, token kontynuacji nie zawiera wartości. Wartość tego parametru nie powinna być zakodowana pod adresem URL.
NodeStatusFilter
Typ: ciąg (wyliczenie)
Wymagane: Nie
Ustawienie domyślne: default
Umożliwia filtrowanie węzłów na podstawie parametru NodeStatus. Zostaną zwrócone tylko węzły pasujące do określonej wartości filtru. Wartość filtru może być jedną z następujących wartości. Możliwe wartości to: "default", "all", "up", "down", "enabling", "disabled", "unknown", "removed"
MaxResults
Typ: liczba całkowita (int64)
Wymagane: Nie
Ustawienie domyślne: 0
InclusiveMinimum: 0
Maksymalna liczba wyników, które mają zostać zwrócone w ramach stronicowanych zapytań. Ten parametr definiuje górną granicę liczby zwróconych wyników. Zwrócone wyniki mogą być mniejsze niż określone maksymalne wyniki, jeśli nie mieszczą się w komunikacie zgodnie z maksymalnymi ograniczeniami rozmiaru komunikatów zdefiniowanymi w konfiguracji. Jeśli ten parametr ma wartość zero lub nie został określony, stronicowane zapytanie zawiera jak najwięcej wyników, które można dopasować do komunikatu zwracanego.
timeout
Typ: liczba całkowita (int64)
Wymagane: Nie
Ustawienie domyślne: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Limit czasu serwera na potrzeby wykonywania operacji w sekundach. Ten limit czasu określa czas trwania, przez który klient chce poczekać na ukończenie żądanej operacji. Wartość domyślna tego parametru to 60 sekund.
Odpowiedzi
Kod stanu HTTP | Opis | Response Schema |
---|---|---|
200 (OK) | Lista węzłów w klastrze. |
PagedNodeInfoList |
Wszystkie inne kody stanu | Szczegółowa odpowiedź na błąd. |
FabricError |
Przykłady
Pobieranie informacji o wszystkich węzłach
W tym przykładzie pokazano, jak uzyskać informacje o wszystkich węzłach w klastrze, gdy informacje pasują do pojedynczego komunikatu odpowiedzi bez konieczności stronicowania za pomocą parametru ContinuationToken.
Żądanie
GET http://localhost:19080/Nodes?api-version=6.3
200 Odpowiedź
Treść
{
"ContinuationToken": "",
"Items": [
{
"Name": "_Node_1",
"IpAddressOrFQDN": "10.0.0.5",
"Type": "testnode",
"CodeVersion": "6.3.139.9494",
"ConfigVersion": "5",
"NodeStatus": "Up",
"NodeUpTimeInSeconds": "15275",
"HealthState": "Ok",
"IsSeedNode": true,
"UpgradeDomain": "1",
"FaultDomain": "fd:/1",
"Id": {
"Id": "ebd986a1134b3643a8117fb41b259bf"
},
"InstanceId": "131738274982501335",
"NodeDeactivationInfo": {
"NodeDeactivationIntent": "Invalid",
"NodeDeactivationStatus": "None",
"NodeDeactivationTask": [],
"PendingSafetyChecks": []
},
"IsStopped": false,
"NodeDownTimeInSeconds": "0",
"NodeUpAt": "2018-06-18T20:31:39.842Z",
"NodeDownAt": "2018-06-18T20:31:37.374Z"
},
{
"Name": "_Node_0",
"IpAddressOrFQDN": "10.0.0.4",
"Type": "testnode",
"CodeVersion": "6.3.139.9494",
"ConfigVersion": "5",
"NodeStatus": "Up",
"NodeUpTimeInSeconds": "18742",
"HealthState": "Ok",
"IsSeedNode": true,
"UpgradeDomain": "0",
"FaultDomain": "fd:/0",
"Id": {
"Id": "2acb9f55540659b1c95f27cc128ab326"
},
"InstanceId": "131738240209152398",
"NodeDeactivationInfo": {
"NodeDeactivationIntent": "Invalid",
"NodeDeactivationStatus": "None",
"NodeDeactivationTask": [],
"PendingSafetyChecks": []
},
"IsStopped": false,
"NodeDownTimeInSeconds": "0",
"NodeUpAt": "2018-06-18T19:33:52.944Z",
"NodeDownAt": "2018-06-18T19:33:39.514Z"
},
{
"Name": "_Node_4",
"IpAddressOrFQDN": "10.0.0.8",
"Type": "testnode",
"CodeVersion": "6.3.139.9494",
"ConfigVersion": "5",
"NodeStatus": "Up",
"NodeUpTimeInSeconds": "101168",
"HealthState": "Ok",
"IsSeedNode": true,
"UpgradeDomain": "4",
"FaultDomain": "fd:/4",
"Id": {
"Id": "ba9383d728221add7fa996bf67b757fb"
},
"InstanceId": "131737415865259763",
"NodeDeactivationInfo": {
"NodeDeactivationIntent": "Invalid",
"NodeDeactivationStatus": "None",
"NodeDeactivationTask": [],
"PendingSafetyChecks": []
},
"IsStopped": false,
"NodeDownTimeInSeconds": "0",
"NodeUpAt": "2018-06-17T20:40:07.378Z",
"NodeDownAt": "2018-06-17T20:33:11.877Z"
},
{
"Name": "_Node_3",
"IpAddressOrFQDN": "10.0.0.7",
"Type": "testnode",
"CodeVersion": "6.3.139.9494",
"ConfigVersion": "5",
"NodeStatus": "Up",
"NodeUpTimeInSeconds": "15236",
"HealthState": "Ok",
"IsSeedNode": true,
"UpgradeDomain": "3",
"FaultDomain": "fd:/3",
"Id": {
"Id": "d6a18a0935a3e39aeae2a049eb97255d"
},
"InstanceId": "131738275300526952",
"NodeDeactivationInfo": {
"NodeDeactivationIntent": "Invalid",
"NodeDeactivationStatus": "None",
"NodeDeactivationTask": [],
"PendingSafetyChecks": []
},
"IsStopped": false,
"NodeDownTimeInSeconds": "0",
"NodeUpAt": "2018-06-18T20:32:18.884Z",
"NodeDownAt": "2018-06-18T20:31:59.128Z"
},
{
"Name": "_Node_2",
"IpAddressOrFQDN": "10.0.0.6",
"Type": "testnode",
"CodeVersion": "6.3.139.9494",
"ConfigVersion": "5",
"NodeStatus": "Up",
"NodeUpTimeInSeconds": "19440",
"HealthState": "Ok",
"IsSeedNode": true,
"UpgradeDomain": "2",
"FaultDomain": "fd:/2",
"Id": {
"Id": "f2af91e5e9c8254dedb75b1424a9e3fc"
},
"InstanceId": "131738233282843485",
"NodeDeactivationInfo": {
"NodeDeactivationIntent": "Invalid",
"NodeDeactivationStatus": "None",
"NodeDeactivationTask": [],
"PendingSafetyChecks": []
},
"IsStopped": false,
"NodeDownTimeInSeconds": "0",
"NodeUpAt": "2018-06-18T19:22:15.272Z",
"NodeDownAt": "2018-06-18T19:22:02.74Z"
}
]
}
Ogranicz maksymalne wyniki
W tym przykładzie pokazano, jak uzyskać informacje o węzłach w klastrze, gdy liczba zwróconych wyników jest ograniczona przez parametr MaxResults.
Żądanie
GET http://localhost:19080/Nodes?api-version=6.3&MaxResults=2
200 Odpowiedź
Treść
{
"ContinuationToken": "2acb9f55540659b1c95f27cc128ab326",
"Items": [
{
"Name": "_testnode_1",
"IpAddressOrFQDN": "10.0.0.5",
"Type": "testnode",
"CodeVersion": "6.3.139.9494",
"ConfigVersion": "5",
"NodeStatus": "Up",
"NodeUpTimeInSeconds": "102016",
"HealthState": "Ok",
"IsSeedNode": true,
"UpgradeDomain": "1",
"FaultDomain": "fd:/1",
"Id": {
"Id": "ebd986a1134b3643a8117fb41b259bf"
},
"InstanceId": "131738274982501335",
"NodeDeactivationInfo": {
"NodeDeactivationIntent": "Invalid",
"NodeDeactivationStatus": "None",
"NodeDeactivationTask": [],
"PendingSafetyChecks": []
},
"IsStopped": false,
"NodeDownTimeInSeconds": "0",
"NodeUpAt": "2018-06-18T20:31:39.842Z",
"NodeDownAt": "2018-06-18T20:31:37.374Z"
},
{
"Name": "_testnode_0",
"IpAddressOrFQDN": "10.0.0.4",
"Type": "testnode",
"CodeVersion": "6.3.139.9494",
"ConfigVersion": "5",
"NodeStatus": "Up",
"NodeUpTimeInSeconds": "105483",
"HealthState": "Ok",
"IsSeedNode": true,
"UpgradeDomain": "0",
"FaultDomain": "fd:/0",
"Id": {
"Id": "2acb9f55540659b1c95f27cc128ab326"
},
"InstanceId": "131738240209152398",
"NodeDeactivationInfo": {
"NodeDeactivationIntent": "Invalid",
"NodeDeactivationStatus": "None",
"NodeDeactivationTask": [],
"PendingSafetyChecks": []
},
"IsStopped": false,
"NodeDownTimeInSeconds": "0",
"NodeUpAt": "2018-06-18T19:33:52.944Z",
"NodeDownAt": "2018-06-18T19:33:39.514Z"
}
]
}
Strona korzystająca z tokenu kontynuacji
W tym przykładzie pokazano, jak uzyskać informacje o węzłach w klastrze, które są wyświetlane na stronie sekwencyjnej przy użyciu parametru ContinuationToken.
Żądanie
GET http://localhost:19080/Nodes?api-version=6.3&ContinuationToken=2acb9f55540659b1c95f27cc128ab326
200 Odpowiedź
Treść
{
"ContinuationToken": "",
"Items": [
{
"Name": "_Node_4",
"IpAddressOrFQDN": "10.0.0.8",
"Type": "testnode",
"CodeVersion": "6.3.139.9494",
"ConfigVersion": "5",
"NodeStatus": "Up",
"NodeUpTimeInSeconds": "101547",
"HealthState": "Ok",
"IsSeedNode": true,
"UpgradeDomain": "4",
"FaultDomain": "fd:/4",
"Id": {
"Id": "ba9383d728221add7fa996bf67b757fb"
},
"InstanceId": "131737415865259763",
"NodeDeactivationInfo": {
"NodeDeactivationIntent": "Invalid",
"NodeDeactivationStatus": "None",
"NodeDeactivationTask": [],
"PendingSafetyChecks": []
},
"IsStopped": false,
"NodeDownTimeInSeconds": "0",
"NodeUpAt": "2018-06-17T20:40:07.378Z",
"NodeDownAt": "2018-06-17T20:33:11.877Z"
},
{
"Name": "_Node_3",
"IpAddressOrFQDN": "10.0.0.7",
"Type": "testnode",
"CodeVersion": "6.3.139.9494",
"ConfigVersion": "5",
"NodeStatus": "Up",
"NodeUpTimeInSeconds": "15615",
"HealthState": "Ok",
"IsSeedNode": true,
"UpgradeDomain": "3",
"FaultDomain": "fd:/3",
"Id": {
"Id": "d6a18a0935a3e39aeae2a049eb97255d"
},
"InstanceId": "131738275300526952",
"NodeDeactivationInfo": {
"NodeDeactivationIntent": "Invalid",
"NodeDeactivationStatus": "None",
"NodeDeactivationTask": [],
"PendingSafetyChecks": []
},
"IsStopped": false,
"NodeDownTimeInSeconds": "0",
"NodeUpAt": "2018-06-18T20:32:18.884Z",
"NodeDownAt": "2018-06-18T20:31:59.128Z"
},
{
"Name": "_Node_2",
"IpAddressOrFQDN": "10.0.0.6",
"Type": "testnode",
"CodeVersion": "6.3.139.9494",
"ConfigVersion": "5",
"NodeStatus": "Up",
"NodeUpTimeInSeconds": "19819",
"HealthState": "Ok",
"IsSeedNode": true,
"UpgradeDomain": "2",
"FaultDomain": "fd:/2",
"Id": {
"Id": "f2af91e5e9c8254dedb75b1424a9e3fc"
},
"InstanceId": "131738233282843485",
"NodeDeactivationInfo": {
"NodeDeactivationIntent": "Invalid",
"NodeDeactivationStatus": "None",
"NodeDeactivationTask": [],
"PendingSafetyChecks": []
},
"IsStopped": false,
"NodeDownTimeInSeconds": "0",
"NodeUpAt": "2018-06-18T19:22:15.272Z",
"NodeDownAt": "2018-06-18T19:22:02.74Z"
}
]
}