Informatie over geïmplementeerde toepassingen ophalen
Hiermee haalt u de informatie op over een toepassing die is geïmplementeerd op een Service Fabric-knooppunt.
Deze query retourneert informatie over de systeemtoepassing als de opgegeven toepassings-id voor de systeemtoepassing is. Resultaten omvatten geïmplementeerde toepassingen in actieve, activerende en downloadstatussen. Voor deze query is vereist dat de naam van het knooppunt overeenkomt met een knooppunt in het cluster. De query mislukt als de opgegeven knooppuntnaam niet verwijst naar actieve Service Fabric-knooppunten in het cluster.
Aanvraag
Methode | Aanvraag-URI |
---|---|
GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState} |
Parameters
Naam | Type | Vereist | Locatie |
---|---|---|---|
nodeName |
tekenreeks | Ja | Pad |
applicationId |
tekenreeks | Ja | Pad |
api-version |
tekenreeks | Ja | Query’s uitvoeren |
timeout |
geheel getal (int64) | Nee | Query’s uitvoeren |
IncludeHealthState |
booleaans | No | Query’s uitvoeren |
nodeName
Type: tekenreeks
Vereist: Ja
De naam van het knooppunt.
applicationId
Type: tekenreeks
Vereist: Ja
De identiteit van de toepassing. Dit is doorgaans de volledige naam van de toepassing zonder het URI-schema 'fabric:'.
Vanaf versie 6.0 worden hiërarchische namen gescheiden door het teken '~'.
Als de toepassingsnaam bijvoorbeeld 'fabric:/myapp/app1' is, is de toepassingsidentiteit 'myapp~app1' in 6.0+ en 'myapp/app1' in eerdere versies.
api-version
Type: tekenreeks
Vereist: Ja
Standaardinstelling: 6.1
De versie van de API. Deze parameter is vereist en de waarde moet '6.1' zijn.
Service Fabric REST API-versie is gebaseerd op de runtimeversie waarin de API is geïntroduceerd of gewijzigd. Service Fabric-runtime ondersteunt meer dan één versie van de API. Dit is de nieuwste 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.
Daarnaast 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 eenvoudiger te maken om de clients te schrijven. Het gedrag van de API is echter volgens de gedocumenteerde versie 6.0.
timeout
Type: geheel getal (int64)
Vereist: Nee
Standaardinstelling: 60
InclusiveMaximum: 4294967295
InclusiefMinimum: 1
De time-out van de server voor het uitvoeren van de bewerking in seconden. Deze time-out geeft de tijdsduur aan die de client bereid is te wachten totdat de aangevraagde bewerking is voltooid. De standaardwaarde voor deze parameter is 60 seconden.
IncludeHealthState
Type: booleaanse waarde
Vereist: Nee
Standaardinstelling: false
Neem de status van een entiteit op.
Als deze parameter onwaar is of niet is opgegeven, is de geretourneerde status 'Onbekend'.
Als de query is ingesteld op true, gaat de query parallel met het knooppunt en de health system-service voordat de resultaten worden samengevoegd.
Als gevolg hiervan is de query duurder en kan het langer duren.
Antwoorden
HTTP-statuscode | Beschrijving | Antwoordschema |
---|---|---|
200 (OK) | Een geslaagde bewerking retourneert de statuscode 200 en de informatie over de geïmplementeerde toepassing. |
DeployedApplicationInfo |
204 (NoContent) | Er wordt een leeg antwoord geretourneerd als de opgegeven toepassing niet is geïmplementeerd op het knooppunt. |
|
Alle andere statuscodes | Het gedetailleerde foutantwoord. |
FabricError |
Voorbeelden
Een specifieke geïmplementeerde toepassing ophalen op toepassings-id en de status opnemen in het resultaat
In dit voorbeeld ziet u hoe u met behulp van een toepassings-id informatie kunt ophalen over een toepassing die op een opgegeven knooppunt is geïmplementeerd. Als de toepassing wordt gevonden, wordt de informatie geretourneerd met statuscode 200. Er wordt een leeg antwoord met statuscode 204 geretourneerd als de opgegeven toepassing niet is geïmplementeerd op het knooppunt.
Aanvraag
GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/samples~CalculatorApp?api-version=6.1&IncludeHealthState=True
200-antwoord
Hoofdtekst
{
"Id": "samples~CalculatorApp",
"Name": "fabric:/samples/CalculatorApp",
"TypeName": "CalculatorApp",
"TypeVersion": "1.0.0",
"Status": "Active",
"WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work",
"LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log",
"TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp",
"HealthState": "Ok"
}
204-antwoord
Hoofdtekst
De hoofdtekst van het antwoord is leeg.