Partager via

Obtenir la liste d’informations de sous-nom

  • Article

Énumère tous les noms Service Fabric sous un nom donné.

Énumère tous les noms Service Fabric sous un nom donné. Si les sous-noms ne tiennent pas dans une page, une page de résultats est retournée, ainsi qu’un jeton de continuation, qui peut être utilisé pour obtenir la page suivante. L’interrogation d’un nom qui n’existe pas échoue.

Requête

Méthode URI de demande
GET /Names/{nameId}/$/GetSubNames?api-version=6.0&Recursive={Recursive}&ContinuationToken={ContinuationToken}&timeout={timeout}

Paramètres

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

nameId

Type : chaîne
Obligatoire : Oui

Nom Service Fabric sans le schéma d’URI 'fabric:'.

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.

Recursive

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

Permet de spécifier que la recherche effectuée doit être récursive.

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.

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 paginée des noms Service Fabric.
 PagedSubNameInfoList
Tous les autres codes status Réponse d’erreur détaillée.
 FabricError

Exemples

Obtenir les sous-noms

Cet exemple montre comment obtenir des informations sur tous les sous-noms d’un nom Service Fabric donné.

Requête

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0

Réponse 200

Corps
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/CalculatorApp",
    "fabric:/samples/mynames"
  ]
}

Recherche récursive dans les sous-noms

Cet exemple montre comment obtenir de manière récursive des informations sur tous les sous-noms enfants d’un nom Service Fabric donné.

Requête

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True

Réponse 200

Corps
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/apps",
    "fabric:/samples/data",
    "fabric:/samples/CalculatorApp",
    "fabric:/samples/CalculatorApp/CalculatorService",
    "fabric:/samples/CalculatorApp/CalculatorService/Name-1",
    "fabric:/samples/CalculatorApp/CalculatorService/Name-2",
    "fabric:/samples/mynames/name-1"
  ]
}

Page utilisant un jeton de continuation

Cet exemple montre comment parcourir les informations sur les sous-noms sous un nom Service Fabric donné à 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 les deux résultats restants et une continuationToken vide. La valeur ContinuationToken vide indique que des résultats supplémentaires ne sont pas disponibles.

Requête

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True&ContinuationToken=fabric:/samples/apps/PersistentQueueApp$131439231986491349

Réponse 200

Corps
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/apps/VolatileQueueApp",
    "fabric:/samples/apps/NotepadApp"
  ]
}