Delen via

Toepassingsgegevens ophalen

  • Artikel

Hiermee haalt u informatie op over een Service Fabric-toepassing.

Retourneert de informatie over de toepassing die is gemaakt of wordt gemaakt in het Service Fabric-cluster en waarvan de naam overeenkomt met de toepassing die is opgegeven als de parameter. Het antwoord bevat de naam, het type, de status, parameters en andere details van de toepassing.

Aanvraag

Methode Aanvraag-URI
GET /Applications/{applicationId}?api-version=6.0&ExcludeApplicationParameters={ExcludeApplicationParameters}&timeout={timeout}

Parameters

Naam Type Vereist Locatie
applicationId tekenreeks Ja Pad
api-version tekenreeks Ja Query’s uitvoeren
ExcludeApplicationParameters booleaans No Query’s uitvoeren
timeout geheel getal (int64) Nee Query’s uitvoeren

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 naam van de toepassing 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.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.

ExcludeApplicationParameters

Type: Booleaanse waarde
Vereist: Nee
Standaardinstelling: false

De vlag die aangeeft of toepassingsparameters worden uitgesloten van het resultaat.

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) Informatie over de toepassing.
 ApplicationInfo
204 (NoContent) Er wordt een leeg antwoord geretourneerd als de opgegeven applicationId niet wordt gevonden in het cluster.
Alle andere statuscodes Het gedetailleerde foutantwoord.
 FabricError

Voorbeelden

Een specifieke toepassing ophalen op basis van toepassings-id

In dit voorbeeld ziet u hoe u informatie over een toepassing opvragen met behulp van de id. Als de toepassing wordt gevonden, wordt informatie over de toepassing geretourneerd met statuscode 200. Als de toepassing niet wordt gevonden, wordt lege inhoud geretourneerd met statuscode 204.

Aanvraag

GET http://localhost:19080/Applications/samples~CalculatorApp?api-version=6.0

200-antwoord

Hoofdtekst
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0",
  "Status": "Ready",
  "Parameters": [
    {
      "Key": "CalculatorAppParameter1",
      "Value": "314"
    },
    {
      "Key": "CalculatorAppParameter2",
      "Value": "271"
    }
  ],
  "HealthState": "Ok",
  "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
}

204-antwoord

Hoofdtekst

De hoofdtekst van het antwoord is leeg.