Dela via

Hämta informationslista för undernamn

  • Artikel

Räknar upp alla Service Fabric-namn under ett givet namn.

Räknar upp alla Service Fabric-namn under ett givet namn. Om undernamnen inte får plats på en sida returneras en resultatsida samt en fortsättningstoken som kan användas för att hämta nästa sida. Det går inte att köra frågor mot ett namn som inte finns.

Förfrågan

Metod URI för förfrågan
GET /Names/{nameId}/$/GetSubNames?api-version=6.0&Recursive={Recursive}&ContinuationToken={ContinuationToken}&timeout={timeout}

Parametrar

Namn Typ Obligatorisk Location
nameId sträng Ja Sökväg
api-version sträng Ja Söka i data
Recursive boolean No Söka i data
ContinuationToken sträng No Söka i data
timeout heltal (int64) No Söka i data

nameId

Typ: sträng
Obligatoriskt: Ja

Service Fabric-namnet utan URI-schemat fabric:.

api-version

Typ: sträng
Obligatoriskt: Ja
Standard: 6.0

Versionen av API:et. Den här parametern krävs och dess värde måste vara "6.0".

Service Fabric REST API-versionen baseras på körningsversionen där API:et introducerades eller ändrades. Service Fabric Runtime stöder mer än en version av API:et. Det här är den senaste versionen av API:et som stöds. Om en lägre API-version skickas kan det returnerade svaret skilja sig från det som beskrivs i den här specifikationen.

Dessutom accepterar körningen alla versioner som är högre än den senaste versionen som stöds fram till den aktuella versionen av körningen. Så om den senaste API-versionen är 6.0, men om körningen är 6.1, för att göra det enklare att skriva klienterna, accepterar körningen version 6.1 för det API:et. Beteendet för API:et kommer dock att vara enligt den dokumenterade 6.0-versionen.

Recursive

Typ: booleskt
Obligatoriskt: Nej
Standard: false

Tillåter att du anger att sökningen som utförs ska vara rekursiv.

ContinuationToken

Typ: sträng
Obligatoriskt: Nej

Parametern fortsättningstoken används för att hämta nästa uppsättning resultat. En fortsättningstoken med ett icke-tomt värde ingår i API:ets svar när resultatet från systemet inte får plats i ett enda svar. När det här värdet skickas till nästa API-anrop returnerar API:et nästa uppsättning resultat. Om det inte finns några ytterligare resultat innehåller fortsättningstoken inget värde. Värdet för den här parametern ska inte vara URL-kodat.

timeout

Typ: heltal (int64)
Obligatoriskt: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Serverns timeout för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta på att den begärda åtgärden ska slutföras. Standardvärdet för den här parametern är 60 sekunder.

Svar

HTTP-statuskod Description Svarsschema
200 (OK) En sidlista med Service Fabric-namn.
 PagedSubNameInfoList
Alla andra statuskoder Det detaljerade felsvaret.
 FabricError

Exempel

Hämta undernamn

Det här exemplet visar hur du hämtar information om alla undernamn för ett givet Service Fabric-namn.

Förfrågan

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

200-svar

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

Sök igenom undernamn rekursivt

Det här exemplet visar hur du rekursivt hämtar information om alla underordnade undernamn för ett givet Service Fabric-namn.

Förfrågan

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

200-svar

Brödtext
{
  "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"
  ]
}

Sida med fortsättningstoken

Det här exemplet visar hur du bläddrar igenom informationen om undernamn under ett angivet Service Fabric-namn med hjälp av parametern ContinuationToken. Värdet för den här parametern anges från föregående fråga, i det här fallet exemplet som visas ovan. Svaret innehåller de återstående två resultaten och en tom ContinuationToken. Den tomma ContinuationToken anger att ytterligare resultat inte är tillgängliga.

Förfrågan

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

200-svar

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