Partager via

Obtenir les informations sur l’application

  • Article

Permet d’obtenir des informations sur une application Service Fabric.

Renvoie les informations sur l’application qui a été créée ou en cours de création dans le cluster Service Fabric et dont le nom correspond à celui spécifié comme paramètre. La réponse comprend le nom, le type, l’état, les paramètres et d’autres détails sur l’application.

Requête

Méthode URI de demande
GET /Applications/{applicationId}?api-version=6.0&ExcludeApplicationParameters={ExcludeApplicationParameters}&timeout={timeout}

Paramètres

Nom Type Obligatoire Emplacement
applicationId string Oui Chemin d’accès
api-version string Oui Requête
ExcludeApplicationParameters boolean Non Requête
timeout entier (int64) Non Requête

applicationId

Type : chaîne
Obligatoire : Oui

Identité de l’application. Il s’agit généralement du nom complet de l’application, sans « fabric ». Schéma d’URI. Depuis la version 6.0, les noms hiérarchiques sont séparés par le caractère « ~ ». Par exemple, si une application est nommée « fabric://mon_app/app1 », son identité est « mon_app~app1 » dans les versions 6.0 et supérieures, et « mon_app/app1 » dans les versions précédentes.

api-version

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

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

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 d’API inférieure est transmise, 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 si 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 en fonction de la version 6.0 documentée.

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.

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) Informations sur l’application.
 ApplicationInfo
204 (NoContent) Une réponse vide est retournée si l’id d’application spécifié est introuvable dans le cluster.
Tous les autres codes status Réponse d’erreur détaillée.
 FabricError

Exemples

Obtenir une application spécifique par ID d’application

Cet exemple montre comment obtenir des informations sur une application à l’aide de son identificateur. Si l’application est trouvée, les informations la concernant sont retournées avec 200 status code. Si l’application est introuvable, le contenu vide est retourné avec le code 204 status.

Requête

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

Réponse 200

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

Réponse 204

Corps

Le corps de la réponse est vide.