Partager via

Obtenir la liste d’informations sur l’application

  • Article

Permet d’obtenir la liste des applications créées dans le cluster Service Fabric qui correspondent aux filtres spécifiés.

Permet d’obtenir les informations sur les applications qui ont été créées ou sont en cours de création dans le cluster Service Fabric et qui correspondent aux filtres spécifiés. La réponse comprend le nom, le type, l’état, les paramètres et d’autres détails sur l’application. Si les applications ne tiennent pas dans une page, une page de résultats est renvoyée, ainsi que d’un jeton de liaison, qui peut être utilisé pour obtenir la page suivante. Les filtres ApplicationTypeName et ApplicationDefinitionKindFilter ne peuvent pas être spécifiés en même temps.

Requête

Méthode URI de demande
GET /Applications?api-version=6.1&ApplicationDefinitionKindFilter={ApplicationDefinitionKindFilter}&ApplicationTypeName={ApplicationTypeName}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Paramètres

Nom Type Obligatoire Emplacement
api-version string Oui Requête
ApplicationDefinitionKindFilter entier Non Requête
ApplicationTypeName string Non Requête
ExcludeApplicationParameters boolean Non Requête
ContinuationToken string Non Requête
MaxResults integer (int64) Non Requête
timeout integer (int64) Non Requête

api-version

Type : chaîne
Obligatoire : Oui
Par défaut : 6.1

Version de l’API. Ce paramètre est obligatoire et sa valeur doit être « 6.1 ».

La version de l’API REST Service Fabric est basée sur la version du runtime dans laquelle l’API a été introduite ou a été modifiée. Le runtime Service Fabric prend en charge plusieurs versions de l’API. Il s’agit de la dernière version prise en charge de l’API. Si une version inférieure de l’API est passée, la réponse retournée peut être différente de celle documentée dans cette spécification.

En outre, le runtime accepte toute version supérieure à la dernière version prise en charge jusqu’à la version actuelle du runtime. Par conséquent, si la dernière version de l’API est 6.0, mais que le runtime est 6.1, afin de faciliter l’écriture des clients, le runtime accepte la version 6.1 pour cette API. Toutefois, le comportement de l’API sera conformément à la version 6.0 documentée.

ApplicationDefinitionKindFilter

Type : entier
Obligatoire : Non
Par défaut : 0

Permet de filtrer sur ApplicationDefinitionKind, qui est le mécanisme utilisé pour définir une application Service Fabric.

  • Par défaut : valeur par défaut, qui exécute la même fonction que la sélection de « Tout ». La valeur est égale à 0.
  • All : filtre qui correspond à l’entrée avec n’importe quelle valeur ApplicationDefinitionKind. La valeur est égale à 65535.
  • ServiceFabricApplicationDescription : filtre qui correspond à l’entrée avec la valeur ApplicationDefinitionKind ServiceFabricApplicationDescription. La valeur est égale à 1.
  • Compose : filtre qui correspond à l’entrée avec la valeur ApplicationDefinitionKind Compose. La valeur est égale à 2.

ApplicationTypeName

Type : chaîne
Obligatoire : Non

Nom du type d’application utilisé pour filtrer les applications à interroger. Cette valeur ne doit pas contenir la version du type d’application.

ExcludeApplicationParameters

Type : booléen
Obligatoire : Non
Par défaut : false

Indicateur qui spécifie si les paramètres de l’application doivent être exclus du résultat.

ContinuationToken

Type : chaîne
Obligatoire : Non

Le paramètre de jeton de liaison permet d’obtenir le jeu de résultats suivant. Un jeton de liaison avec une valeur non vide est inclus dans la réponse de l’API quand les résultats du système ne tiennent pas dans une seule réponse. Lorsque cette valeur est transmise à l’appel d’API suivant, l’API retourne le jeu de résultats suivant. S’il n’existe pas de résultats supplémentaires, le jeton de liaison ne contient pas de valeur. La valeur de ce paramètre ne doit pas être codée URL.

MaxResults

Type : integer (int64)
Obligatoire : Non
Par défaut : 0
InclusiveMinimum : 0

Nombre maximal de résultats à renvoyer dans le cadre des requêtes paginées. Ce paramètre définit la limite supérieure du nombre de résultats renvoyés. Le nombre de résultats renvoyés peut être inférieur au nombre maximal de résultats spécifié s’ils ne tiennent pas dans le message conformément aux restrictions de taille maximale définies dans la configuration. Si ce paramètre est défini sur zéro ou n’est pas spécifié, la requête paginée comprend le nombre maximal de résultats pouvant tenir dans le message renvoyé.

timeout

Type : integer (int64)
Obligatoire : Non
Par défaut : 60
InclusiveMaximum : 4294967295
InclusiveMinimum : 1

Délai d’attente du serveur pour l’exécution de l’opération en secondes. Il spécifie la durée pendant laquelle le client attend la fin de l’opération demandée. La valeur par défaut de ce paramètre est de 60 secondes.

Réponses

Code d’état HTTP Description Schéma de réponse
200 (OK) Liste des applications créées dans le cluster.
 PagedApplicationInfoList
Tous les autres codes status Réponse d’erreur détaillée.
 FabricError

Exemples

Limiter le nombre maximal de résultats

Cet exemple montre comment obtenir des informations sur les applications sur le cluster. Le nombre de résultats dans une page est limité à un maximum de deux à l’aide du paramètre MaxResult.

Requête

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

Réponse 200

Corps
{
  "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"
    }
  ]
}

Page utilisant un jeton de continuation

Cet exemple montre comment parcourir les informations sur les applications sur le cluster à l’aide du paramètre ContinuationToken. La valeur de ce paramètre est fournie à partir de la requête précédente, dans ce cas l’exemple ci-dessus. La réponse contient le résultat restant et un ContinuationToken vide. La valeur ContinuationToken vide indique que des résultats supplémentaires ne sont pas disponibles.

Requête

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

Réponse 200

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