Recevoir des informations sur l’application

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 Path
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 ».

Service Fabric version de l’API REST est basée sur la version du runtime dans laquelle l’API a été introduite ou a été modifiée. Service Fabric Runtime 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 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 qui est supérieure à la version la plus récente 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 acceptera la version 6,1 pour cette API. Toutefois, le comportement de l’API sera conforme à 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: entier (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’applicationId spécifié est introuvable dans le cluster.
Tous les autres codes d’État 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 le concernant sont renvoyées avec le code d’état 200. Si l’application est introuvable, le contenu vide est retourné avec le code d’État 204.

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.