Partager via

Obtenir la liste d’informations sur le type d’application

  • Article

Permet d’obtenir la liste des types d’applications du cluster Service Fabric.

Renvoie les informations sur les types d’application qui sont approvisionnés ou en cours d’approvisionnement dans le cluster Service Fabric. Chaque version d’un type d’application est retournée en tant que type d’une application. La réponse comprend le nom, la version, l’état et d’autres informations sur le type d’application. Il s’agit d’une requête paginée, ce qui signifie que 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. Par exemple, s’il existe 10 types d’application mais qu’une page ne peut en contenir que les trois premiers, ou si le maximum de résultats est défini sur 3, alors la valeur 3 est retournée. Pour accéder au reste des résultats, récupérez les pages suivantes en utilisant le jeton de liaison renvoyé dans la requête suivante. Un jeton de liaison vide est renvoyé s’il n’existe aucune autre page.

Requête

Méthode URI de demande
GET /ApplicationTypes?api-version=6.0&ApplicationTypeDefinitionKindFilter={ApplicationTypeDefinitionKindFilter}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Paramètres

Nom Type Obligatoire Emplacement
api-version string Oui Requête
ApplicationTypeDefinitionKindFilter entier 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.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 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.

ApplicationTypeDefinitionKindFilter

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

Utilisé pour filtrer sur ApplicationTypeDefinitionKind, qui est le mécanisme utilisé pour définir un type d’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 ApplicationTypeDefinitionKind. La valeur est égale à 65535.
  • ServiceFabricApplicationPackage : filtre qui correspond à l’entrée avec la valeur ApplicationTypeDefinitionKind ServiceFabricApplicationPackage. La valeur est égale à 1.
  • Compose : filtre qui correspond à l’entrée avec la valeur ApplicationTypeDefinitionKind Compose. La valeur est égale à 2.

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 types d’applications dans le cluster.
 PagedApplicationTypeInfoList
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 types d’applications qui sont provisionnés ou en cours d’approvisionnement dans le cluster. Le nombre de résultats dans une page est limité à cinq à l’aide du paramètre MaxResult.

Requête

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

Réponse 200

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

Page utilisant le jeton de continuation

Cet exemple montre comment parcourir les informations sur les types d’application qui sont provisionnés ou en cours d’approvisionnement dans le cluster à l’aide du paramètre ContinuationToken. La valeur de ce paramètre est fournie à partir de la requête précédente, en l’occurrence l’exemple ci-dessus. La réponse contient les deux résultats restants 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/ApplicationTypes?api-version=6.0&ContinuationToken=PersistentQueueApp+2.0&MaxResults=5

Réponse 200

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

Exclure les paramètres d’application du résultat

Cet exemple montre comment exclure le paramètre d’application dans le résultat lors de l’obtention des informations sur les types d’application qui sont provisionnés ou en cours d’approvisionnement dans le cluster.

Requête

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

Réponse 200

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