Delen via

Lijst met toepassingsgegevens ophalen

  • Artikel

Hiermee haalt u de lijst op met toepassingen die in het Service Fabric-cluster zijn gemaakt en die overeenkomen met de opgegeven filters.

Hiermee haalt u de informatie op over de toepassingen die zijn gemaakt of die worden gemaakt in het Service Fabric-cluster en die overeenkomen met de opgegeven filters. Het antwoord bevat de naam, het type, de status, de parameters en andere details van de toepassing. Als de toepassingen niet op een pagina passen, wordt één pagina met resultaten geretourneerd, evenals een vervolgtoken, dat kan worden gebruikt om de volgende pagina op te halen. Filters ApplicationTypeName en ApplicationDefinitionKindFilter kunnen niet tegelijkertijd worden opgegeven.

Aanvraag

Methode Aanvraag-URI
GET /Applications?api-version=6.1&ApplicationDefinitionKindFilter={ApplicationDefinitionKindFilter}&ApplicationTypeName={ApplicationTypeName}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parameters

Naam Type Vereist Locatie
api-version tekenreeks Ja Query’s uitvoeren
ApplicationDefinitionKindFilter geheel getal Nee Query’s uitvoeren
ApplicationTypeName 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

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.

ApplicationDefinitionKindFilter

Type: geheel getal
Vereist: Nee
Standaardinstelling: 0

Wordt gebruikt om te filteren op ApplicationDefinitionKind. Dit is het mechanisme dat wordt gebruikt om een Service Fabric-toepassing te definiëren.

  • Standaard: standaardwaarde, waarmee dezelfde functie wordt uitgevoerd als het selecteren van 'Alles'. De waarde is 0.
  • Alle: filter dat overeenkomt met invoer met een ApplicationDefinitionKind-waarde. De waarde is 65535.
  • ServiceFabricApplicationDescription: filter dat invoer overeenkomt met de waarde ServiceFabricApplicationDescription van ApplicationDefinitionKind. De waarde is 1.
  • Compose: filter dat overeenkomt met invoer met de waarde Compose van ApplicationDefinitionKind. De waarde is 2.

ApplicationTypeName

Type: tekenreeks
Vereist: Nee

De naam van het toepassingstype dat wordt gebruikt om de toepassingen te filteren waarvoor query's moeten worden uitgevoerd. Deze waarde mag niet de versie van het toepassingstype bevatten.

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 vervolgtokenparameter 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 niet worden gecodeerd met een URL.

MaxResults

Type: geheel getal (int64)
Vereist: Nee
Standaardinstelling: 0
InclusiefMinimum: 0

Het maximum aantal resultaten dat moet worden geretourneerd als onderdeel van de paginaquery'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 maximale berichtgrootte die in de configuratie zijn gedefinieerd. Als deze parameter nul is of niet is opgegeven, bevat de wisselquery zoveel mogelijk resultaten die in het retourbericht passen.

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.

Antwoorden

HTTP-statuscode Beschrijving Antwoordschema
200 (OK) Lijst met toepassingen die in het cluster zijn gemaakt.
 PagedApplicationInfoList
Alle andere statuscodes Het gedetailleerde foutantwoord.
 FabricError

Voorbeelden

Maximum aantal resultaten beperken

In dit voorbeeld ziet u hoe u informatie over toepassingen in het cluster kunt ophalen. Het aantal resultaten op een pagina is beperkt tot maximaal twee met behulp van de parameter MaxResult.

Aanvraag

GET http://localhost:19080/Applications?api-version=6.1&MaxResults=2

200-antwoord

Hoofdtekst
{
  "ContinuationToken": "fabric:/samples/PQueueApp1",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}

Pagina met vervolgtoken

In dit voorbeeld ziet u hoe u door de informatie over toepassingen in het cluster bladert met behulp van de parameter ContinuationToken. De waarde van deze parameter wordt opgegeven uit de vorige query, in dit geval het bovenstaande voorbeeld. Het antwoord bevat het resterende resultaat en een leeg ContinuationToken. Het lege ContinuationToken geeft aan dat er geen aanvullende resultaten beschikbaar zijn.

Aanvraag

GET http://localhost:19080/Applications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1&MaxResults=2

200-antwoord

Hoofdtekst
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}