Lijst met toepassingstypegegevens ophalen op naam
Hiermee haalt u de lijst met toepassingstypen in het Service Fabric-cluster op die exact overeenkomen met de opgegeven naam.
Retourneert de informatie over de toepassingstypen die zijn ingericht of die worden ingericht in het Service Fabric-cluster. Deze resultaten zijn van toepassingstypen waarvan de naam exact overeenkomt met de naam die is opgegeven als de parameter en die voldoen aan de opgegeven queryparameters. Alle versies van het toepassingstype dat overeenkomt met de naam van het toepassingstype worden geretourneerd, waarbij elke versie wordt geretourneerd als één toepassingstype. Het antwoord bevat de naam, versie, status en andere details over het toepassingstype. Dit is een gepaginade query, wat betekent dat als niet alle toepassingstypen op een pagina passen, één pagina met resultaten wordt geretourneerd, evenals een vervolgtoken, dat kan worden gebruikt om de volgende pagina op te halen. Als er bijvoorbeeld 10 toepassingstypen zijn, maar een pagina alleen past bij de eerste drie toepassingstypen, of als het maximum aantal resultaten is ingesteld op 3, wordt er drie geretourneerd. Voor toegang tot de rest van de resultaten haalt u volgende pagina's op met behulp van het geretourneerde vervolgtoken in de volgende query. Er wordt een leeg vervolgtoken geretourneerd als er geen volgende pagina's zijn.
Aanvraag
| Methode | Aanvraag-URI |
|---|---|
| GET | /ApplicationTypes/{applicationTypeName}?api-version=6.0&ApplicationTypeVersion={ApplicationTypeVersion}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout} |
Parameters
| Naam | Type | Vereist | Locatie |
|---|---|---|---|
applicationTypeName |
tekenreeks | Ja | Pad |
api-version |
tekenreeks | Ja | Query’s uitvoeren |
ApplicationTypeVersion |
tekenreeks | No | Query’s uitvoeren |
ExcludeApplicationParameters |
booleaans | No | Query’s uitvoeren |
ContinuationToken |
tekenreeks | No | Query’s uitvoeren |
MaxResults |
geheel getal (int64) | Nee | Query’s uitvoeren |
timeout |
geheel getal (int64) | Nee | Query’s uitvoeren |
applicationTypeName
Type: tekenreeks
Vereist: Ja
De naam van het toepassingstype.
api-version
Type: tekenreeks
Vereist: Ja
Standaardinstelling: 6.0
De versie van de API. Deze parameter is vereist en de waarde moet '6.0' zijn.
Service Fabric REST API-versie is gebaseerd op de runtimeversie waarin de API is geïntroduceerd of is gewijzigd. Service Fabric-runtime ondersteunt meer dan één versie van de API. Dit is de meest recente ondersteunde versie van de API. Als een lagere API-versie wordt doorgegeven, kan het geretourneerde antwoord afwijken van het antwoord dat in deze specificatie wordt beschreven.
Bovendien accepteert de runtime elke versie die hoger is dan de meest recente ondersteunde versie tot de huidige versie van de runtime. Dus als de nieuwste API-versie 6.0 is, maar als de runtime 6.1 is, accepteert de runtime versie 6.1 voor die API om het schrijven van de clients gemakkelijker te maken. Het gedrag van de API is echter volgens de gedocumenteerde versie 6.0.
ApplicationTypeVersion
Type: tekenreeks
Vereist: Nee
De versie van het toepassingstype.
ExcludeApplicationParameters
Type: Booleaanse waarde
Vereist: Nee
Standaardinstelling: false
De vlag die aangeeft of toepassingsparameters worden uitgesloten van het resultaat.
ContinuationToken
Type: tekenreeks
Vereist: Nee
De parameter voor het vervolgtoken wordt gebruikt om de volgende set resultaten te verkrijgen. Een vervolgtoken met een niet-lege waarde wordt opgenomen in het antwoord van de API wanneer de resultaten van het systeem niet in één antwoord passen. Wanneer deze waarde wordt doorgegeven aan de volgende API-aanroep, retourneert de API de volgende set resultaten. Als er geen verdere resultaten zijn, bevat het vervolgtoken geen waarde. De waarde van deze parameter mag geen URL-codering hebben.
MaxResults
Type: geheel getal (int64)
Vereist: Nee
Standaardinstelling: 0
InclusiefMinimum: 0
Het maximum aantal resultaten dat moet worden geretourneerd als onderdeel van de gepaginade query's. Deze parameter definieert de bovengrens voor het aantal geretourneerde resultaten. De geretourneerde resultaten kunnen kleiner zijn dan de opgegeven maximumresultaten als ze niet in het bericht passen volgens de beperkingen voor de maximale berichtgrootte die in de configuratie zijn gedefinieerd. Als deze parameter nul is of niet is opgegeven, bevat de gepaginade query zoveel mogelijk resultaten die in het retourbericht passen.
timeout
Type: geheel getal (int64)
Vereist: Nee
Standaardinstelling: 60
InclusiefMaximum: 4294967295
InclusiefMinimum: 1
De servertime-out voor het uitvoeren van de bewerking in seconden. Deze time-out geeft de tijdsduur aan die de client bereid is te wachten tot de aangevraagde bewerking is voltooid. De standaardwaarde voor deze parameter is 60 seconden.
Antwoorden
| HTTP-statuscode | Beschrijving | Antwoordschema |
|---|---|---|
| 200 (OK) | Lijst met toepassingstypen in het cluster. |
PagedApplicationTypeInfoList |
| Alle andere statuscodes | Het gedetailleerde foutantwoord. |
FabricError |