Obtenir la liste d’état du déploiement compose

  • Article

Permet d’obtenir la liste des déploiements compose créés dans le cluster Service Fabric.

Permet d’obtenir l’état des déploiements compose créés ou qui sont en cours de création dans le cluster Service Fabric. La réponse comprend le nom, l’état et d’autres détails sur les déploiements compose. Si la liste des déploiements ne tient pas sur une page, une page de résultats est renvoyée, ainsi qu’un jeton de liaison qui peut être utilisé pour accéder à la page suivante.

Requête

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

Paramètres

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

api-version

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

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

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 status des déploiements de composition dans le cluster.
 PagedComposeDeploymentStatusInfoList
Tous les autres codes status Réponse d’erreur détaillée.
 FabricError