Delen via

Lijst met toepassingstypegegevens ophalen

  • Artikel

Hiermee haalt u de lijst met toepassingstypen in het Service Fabric-cluster op.

Retourneert de informatie over de toepassingstypen die zijn ingericht of die worden ingericht in het Service Fabric-cluster. Elke versie van een toepassingstype 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 tien 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. Als u toegang wilt krijgen 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?api-version=6.0&ApplicationTypeDefinitionKindFilter={ApplicationTypeDefinitionKindFilter}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parameters

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

ApplicationTypeDefinitionKindFilter

Type: geheel getal
Vereist: Nee
Standaardinstelling: 0

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

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

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 toepassingstypen in het cluster.
 PagedApplicationTypeInfoList
Alle andere statuscodes Het gedetailleerde foutantwoord.
 FabricError

Voorbeelden

Maximum aantal resultaten beperken

In dit voorbeeld ziet u hoe u informatie kunt ophalen over toepassingstypen die zijn ingericht of worden ingericht in het cluster. Het aantal resultaten op een pagina is beperkt tot maximaal vijf met de parameter MaxResult.

Aanvraag

GET http://localhost:19080/ApplicationTypes?api-version=6.0&MaxResults=5

200-antwoord

Hoofdtekst
{
  "ContinuationToken": "PersistentQueueApp+2.0",
  "Items": [
    {
      "Name": "CalculatorApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "ServiceInstanceCount",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "CalculatorApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "ServiceInstanceCount",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "GatewayApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "GatewayPort",
          "Value": "8505"
        },
        {
          "Key": "ServiceInstanceCount",
          "Value": "1000"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    }
  ]
}

Pagina met vervolgtoken

In dit voorbeeld ziet u hoe u door de informatie bladert over toepassingstypen die zijn ingericht of worden ingericht in het cluster 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 de resterende twee resultaten en een leeg ContinuationToken. Het lege ContinuationToken geeft aan dat er geen aanvullende resultaten beschikbaar zijn.

Aanvraag

GET http://localhost:19080/ApplicationTypes?api-version=6.0&ContinuationToken=PersistentQueueApp+2.0&MaxResults=5

200-antwoord

Hoofdtekst
{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "VolatileQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    }
  ]
}

Toepassingsparameters uitsluiten van het resultaat

In dit voorbeeld ziet u hoe u de toepassingsparameter in het resultaat kunt uitsluiten bij het ophalen van de informatie over toepassingstypen die zijn ingericht of worden ingericht in het cluster.

Aanvraag

GET http://localhost:19080/ApplicationTypes?api-version=6.0&ExcludeApplicationParameters=True

200-antwoord

Hoofdtekst
{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "CalculatorApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "CalculatorApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "GatewayApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    }
  ]
}