Udostępnij za pośrednictwem

Pobieranie listy informacji o nazwie podrzędnej

  • Artykuł

Wylicza wszystkie nazwy usługi Service Fabric pod daną nazwą.

Wylicza wszystkie nazwy usługi Service Fabric pod daną nazwą. Jeśli podnazwy nie mieszczą się na stronie, zostanie zwrócona jedna strona wyników, a także token kontynuacji, którego można użyć do pobrania następnej strony. Wykonywanie zapytania o nazwę, która nie istnieje, zakończy się niepowodzeniem.

Żądanie

Metoda Identyfikator URI żądania
GET /Names/{nameId}/$/GetSubNames?api-version=6.0&Recursive={Recursive}&ContinuationToken={ContinuationToken}&timeout={timeout}

Parametry

Nazwa Typ Wymagane Lokalizacja
nameId ciąg Tak Ścieżka
api-version ciąg Tak Zapytanie
Recursive boolean Nie Zapytanie
ContinuationToken ciąg Nie Zapytanie
timeout liczba całkowita (int64) Nie Zapytanie

nameId

Typ: ciąg
Wymagane: Tak

Nazwa usługi Service Fabric bez schematu identyfikatora URI "fabric:".

api-version

Typ: ciąg
Wymagane: Tak
Ustawienie domyślne: 6.0

Wersja interfejsu API. Ten parametr jest wymagany, a jego wartość musi mieć wartość "6.0".

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. Jest to najnowsza obsługiwana wersja 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 wszystkie wersje wyższe niż najnowsza obsługiwana wersja do bieżącej wersji środowiska uruchomieniowego. Jeśli więc najnowsza wersja interfejsu API to 6.0, ale jeśli środowisko uruchomieniowe ma wartość 6.1, aby ułatwić pisanie klientów, środowisko uruchomieniowe zaakceptuje wersję 6.1 dla tego interfejsu API. Jednak zachowanie interfejsu API będzie zgodnie z udokumentowaną wersją 6.0.

Recursive

Typ: wartość logiczna
Wymagane: Nie
Ustawienie domyślne: false

Umożliwia określenie, że wykonywane wyszukiwanie powinno być rekursywne.

ContinuationToken

Typ: ciąg
Wymagane: Nie

Parametr tokenu kontynuacji służy do uzyskiwania następnego zestawu wyników. Token kontynuacji z niepustą wartością 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 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 w adresie URL.

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) Stronicowana lista nazw usługi Service Fabric.
 PagedSubNameInfoList
Wszystkie inne kody stanu Szczegółowa odpowiedź na błąd.
 Błąd sieci szkieletowej

Przykłady

Uzyskiwanie nazw podrzędnych

W tym przykładzie pokazano, jak uzyskać informacje o wszystkich nazwach podrzędnych danej nazwy usługi Service Fabric.

Żądanie

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0

Odpowiedź 200

Treść
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/CalculatorApp",
    "fabric:/samples/mynames"
  ]
}

Rekursywnie wyszukuj podnazwy

W tym przykładzie pokazano, jak rekursywnie uzyskać informacje o wszystkich podrzędnych nazwach podrzędnych danej nazwy usługi Service Fabric.

Żądanie

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True

Odpowiedź 200

Treść
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/apps",
    "fabric:/samples/data",
    "fabric:/samples/CalculatorApp",
    "fabric:/samples/CalculatorApp/CalculatorService",
    "fabric:/samples/CalculatorApp/CalculatorService/Name-1",
    "fabric:/samples/CalculatorApp/CalculatorService/Name-2",
    "fabric:/samples/mynames/name-1"
  ]
}

Strona używająca tokenu kontynuacji

W tym przykładzie pokazano, jak stronicować informacje o nazwach podrzędnych w ramach danej nazwy usługi Service Fabric przy użyciu parametru ContinuationToken. Wartość tego parametru jest dostarczana z poprzedniego zapytania, w tym przypadku przykład pokazany powyżej. Odpowiedź zawiera pozostałe dwa wyniki i pusty token ContinuationToken. Pusty token ContinuationToken wskazuje, że dodatkowe wyniki nie są dostępne.

Żądanie

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True&ContinuationToken=fabric:/samples/apps/PersistentQueueApp$131439231986491349

Odpowiedź 200

Treść
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/apps/VolatileQueueApp",
    "fabric:/samples/apps/NotepadApp"
  ]
}