Hämta informationslista för programtyp efter namn
Hämtar listan över programtyper i Service Fabric-klustret som matchar exakt det angivna namnet.
Returnerar information om de programtyper som etableras eller håller på att etableras i Service Fabric-klustret. Dessa resultat är av programtyper vars namn matchar exakt det som anges som parametern och som överensstämmer med de angivna frågeparametrarna. Alla versioner av programtypen som matchar namnet på programtypen returneras, och varje version returneras som en programtyp. Svaret innehåller namn, version, status och annan information om programtypen. Det här är en växlingsfråga, vilket innebär att om inte alla programtyper får plats på en sida returneras en sida med resultat samt en fortsättningstoken som kan användas för att hämta nästa sida. Om det till exempel finns 10 programtyper men en sida bara passar de tre första programtyperna, eller om maxresultatet är inställt på 3, returneras tre. Om du vill komma åt resten av resultaten hämtar du efterföljande sidor med hjälp av den returnerade fortsättningstoken i nästa fråga. En tom fortsättningstoken returneras om det inte finns några efterföljande sidor.
Förfrågan
| Metod | URI för förfrågan |
|---|---|
| GET | /ApplicationTypes/{applicationTypeName}?api-version=6.0&ApplicationTypeVersion={ApplicationTypeVersion}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout} |
Parametrar
| Namn | Typ | Obligatorisk | Location |
|---|---|---|---|
applicationTypeName |
sträng | Ja | Sökväg |
api-version |
sträng | Ja | Söka i data |
ApplicationTypeVersion |
sträng | No | Söka i data |
ExcludeApplicationParameters |
boolean | No | Söka i data |
ContinuationToken |
sträng | No | Söka i data |
MaxResults |
heltal (int64) | No | Söka i data |
timeout |
heltal (int64) | No | Söka i data |
applicationTypeName
Typ: sträng
Krävs: Ja
Namnet på programtypen.
api-version
Typ: sträng
Krävs: 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 dokumenteras i den här specifikationen.
Dessutom accepterar körningen alla versioner som är högre än den senaste versionen som stöds upp till den aktuella versionen av körningen. Så om den senaste API-versionen är 6.0, men om körningen är 6.1, accepterar körningen version 6.1 för det API:et för att göra det enklare att skriva klienterna. Beteendet för API:et är dock enligt den dokumenterade 6.0-versionen.
ApplicationTypeVersion
Typ: sträng
Krävs: Nej
Programtypens version.
ExcludeApplicationParameters
Typ: booleskt värde
Krävs: Nej
Standard: false
Flaggan som anger om programparametrar ska undantas från resultatet.
ContinuationToken
Typ: sträng
Krävs: Nej
Parametern fortsättningstoken används för att hämta nästa resultatuppsättning. 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.
MaxResults
Typ: heltal (int64)
Krävs: Nej
Standard: 0
InclusiveMinimum: 0
Det maximala antalet resultat som ska returneras som en del av de växlingsade frågorna. Den här parametern definierar den övre gränsen för antalet returnerade resultat. Resultatet som returneras kan vara mindre än det angivna maximala resultatet om de inte får plats i meddelandet enligt de maximala storleksbegränsningarna för meddelanden som definierats i konfigurationen. Om den här parametern är noll eller inte anges innehåller den växlingsfråga så många resultat som möjligt som får plats i returmeddelandet.
timeout
Typ: heltal (int64)
Krävs: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Serverns tidsgräns 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) | Lista över programtyper i klustret. |
PagedApplicationTypeInfoList |
| Alla andra statuskoder | Det detaljerade felsvaret. |
FabricError |