Liste mit Unternamensinformationen abrufen

  • Artikel

Listet alle Service Fabric-Namen unter einem angegebenen Namen auf.

Listet alle Service Fabric-Namen unter einem angegebenen Namen auf. Wenn die Unternamen nicht in eine Seite passen, wird eine Seite mit Ergebnissen sowie ein Fortsetzungstoken zurückgegeben, das zum Abrufen der nächsten Seite verwendet werden kann. Das Abfragen eines Namens, der nicht vorhanden ist, schlägt fehl.

Anforderung

Methode Anforderungs-URI
GET /Names/{nameId}/$/GetSubNames?api-version=6.0&Recursive={Recursive}&ContinuationToken={ContinuationToken}&timeout={timeout}

Parameter

Name type Erforderlich Standort
nameId Zeichenfolge Ja Pfad
api-version Zeichenfolge Ja Abfrage
Recursive boolean Nein Abfrage
ContinuationToken Zeichenfolge Nein Abfrage
timeout ganze Zahl (int64) Nein Abfrage

nameId

Typ: Zeichenfolge
Erforderlich: Ja

Der Service Fabric-Name ohne das URI-Schema 'fabric:'.

api-version

Typ: Zeichenfolge
Erforderlich: Ja
Standard:

Die Version der API. Dieser Parameter ist erforderlich, und sein Wert muss "6.0" sein.

Die Rest-API-Version von Service Fabric basiert auf der Laufzeitversion, in der die API eingeführt oder geändert wurde. Die Service Fabric-Runtime unterstützt mehrere Versionen der API. Dies ist die neueste unterstützte Version der API. Wenn eine niedrigere API-Version übergeben wird, unterscheidet sich die zurückgegebene Antwort möglicherweise von der in dieser Spezifikation dokumentierten.

Darüber hinaus akzeptiert die Runtime jede Version, die höher als die neueste unterstützte Version bis zur aktuellen Version der Runtime ist. Wenn also die neueste API-Version 6.0 ist, aber die Runtime 6.1 ist, akzeptiert die Runtime version 6.1 für diese API, um das Schreiben der Clients zu vereinfachen. Das Verhalten der API entspricht jedoch der dokumentierten Version 6.0.

Recursive

Typ: boolean
Erforderlich: Nein
Standard:

Ermöglicht die Angabe, dass die durchgeführte Suche rekursiv sein soll.

ContinuationToken

Typ: Zeichenfolge
Erforderlich: Nein

Der Parameter „continuation-token“ (Fortsetzungstoken) wird dazu verwendet, den nächsten Satz von Ergebnissen abzurufen. Ein Fortsetzungstoken mit einem nicht leeren Wert wird in die Antwort der API eingefügt, wenn die Ergebnisse aus dem System nicht in eine einzige Antwort passen. Wird dieser Wert an den nächsten API-Aufruf übergeben, gibt die API den nächsten Satz von Ergebnissen zurück. Gibt es keine weiteren Ergebnisse, enthält das Fortsetzungstoken keinen Wert. Der Wert dieses Parameters darf nicht als URL codiert sein.

timeout

Typ: integer (int64)
Erforderlich: Nein
Standard:
InclusiveMaximum: 4294967295
InklusiveMinimum: 1

Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden.

Antworten

HTTP-Statuscode BESCHREIBUNG Antwortschema
200 (OK) Eine ausgelagerte Liste von Service Fabric-Namen.
 PagedSubNameInfoList
Alle anderen status Codes Die detaillierte Fehlerantwort.
 FabricError

Beispiele

Abrufen von Unternamen

In diesem Beispiel wird gezeigt, wie Informationen zu allen Unternamen eines bestimmten Service Fabric-Namens abgerufen werden.

Anforderung

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

Antwort 200

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

Rekursive Suche nach Unternamen

In diesem Beispiel wird gezeigt, wie Sie rekursiv Informationen zu allen untergeordneten Unternamen eines bestimmten Service Fabric-Namens abrufen.

Anforderung

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

Antwort 200

Text
{
  "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"
  ]
}

Seite mit Fortsetzungstoken

In diesem Beispiel wird gezeigt, wie Sie die Informationen zu Unternamen unter einem bestimmten Service Fabric-Namen mithilfe des Parameters ContinuationToken durchblättern. Der Wert dieses Parameters wird aus der vorherigen Abfrage bereitgestellt, in diesem Fall im oben gezeigten Beispiel. Die Antwort enthält die verbleibenden beiden Ergebnisse und ein leeres ContinuationToken. Das leere ContinuationToken gibt an, dass keine zusätzlichen Ergebnisse verfügbar sind.

Anforderung

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

Antwort 200

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