Obtenir la liste d’informations sur les propriétés
Permet d’obtenir des informations sur toutes les propriétés Service Fabric sous un nom donné.
Un nom Service Fabric peut avoir une ou plusieurs propriétés nommées qui stockent des informations personnalisées. Cette opération obtient les informations sur ces propriétés dans une liste paginée. Les informations comprennent le nom, la valeur et les métadonnées de chacune des propriétés.
Requête
| Méthode | URI de demande |
|---|---|
| GET | /Names/{nameId}/$/GetProperties?api-version=6.0&IncludeValues={IncludeValues}&ContinuationToken={ContinuationToken}&timeout={timeout} |
Paramètres
| Nom | Type | Obligatoire | Emplacement |
|---|---|---|---|
nameId |
string | Oui | Chemin d’accès |
api-version |
string | Oui | Requête |
IncludeValues |
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.
IncludeValues
Type : booléen
Obligatoire : Non
Par défaut : false
Permet de spécifier s’il faut inclure les valeurs des propriétés retournées. True si les valeurs doivent être retournées avec les métadonnées ; False pour retourner uniquement les métadonnées de propriété.
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 propriétés Service Fabric. |
PagedPropertyInfoList |
| Tous les autres codes status | Réponse d’erreur détaillée. |
FabricError |
Exemples
Obtenir la liste d’informations sur les propriétés
Cet exemple montre comment obtenir toutes les propriétés Service Fabric sous un nom donné.
Requête
GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0
Réponse 200
Corps
{
"ContinuationToken": "PersistentQueueAppData$131439231986491349",
"IsConsistent": true,
"Properties": [
{
"Name": "CalculatorAppData",
"Metadata": {
"TypeId": "Int64",
"CustomTypeId": "",
"Parent": "fabric:/samples/apps",
"SizeInBytes": "5",
"LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
"SequenceNumber": "10"
}
},
{
"Name": "PersistentQueueAppData",
"Metadata": {
"TypeId": "Binary",
"CustomTypeId": "InitializationDataType",
"Parent": "fabric:/samples/apps",
"SizeInBytes": "5",
"LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z",
"SequenceNumber": "12"
}
}
]
}
Obtenir la liste d’informations sur les propriétés avec des valeurs
Cet exemple montre comment obtenir toutes les propriétés Service Fabric et leurs valeurs sous un nom donné.
Requête
GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True
Réponse 200
Corps
{
"ContinuationToken": "PersistentQueueAppData$131439231986491349",
"IsConsistent": true,
"Properties": [
{
"Name": "CalculatorAppData",
"Value": {
"Kind": "Int64",
"Data": "4534"
},
"Metadata": {
"TypeId": "Int64",
"CustomTypeId": "",
"Parent": "fabric:/samples/apps",
"SizeInBytes": "8",
"LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
"SequenceNumber": "10"
}
},
{
"Name": "PersistentQueueAppData",
"Value": {
"Kind": "Binary",
"Data": [
"6",
"7",
"8",
"9",
"10"
]
},
"Metadata": {
"TypeId": "Binary",
"CustomTypeId": "InitializationDataType",
"Parent": "fabric:/samples/apps",
"SizeInBytes": "5",
"LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z",
"SequenceNumber": "12"
}
}
]
}
Page utilisant un jeton de continuation
Cet exemple montre comment parcourir les informations sur les propriétés 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/apps/$/GetProperties?api-version=6.0&IncludeValues=True&ContinuationToken=PersistentQueueAppData$131439231986491349
Réponse 200
Corps
{
"ContinuationToken": "",
"IsConsistent": true,
"Properties": [
{
"Name": "VolatileQueueAppData",
"Value": {
"Kind": "Double",
"Data": "67.89"
},
"Metadata": {
"TypeId": "Double",
"CustomTypeId": "",
"Parent": "fabric:/samples/apps",
"SizeInBytes": "8",
"LastModifiedUtcTimestamp": "2017-07-17T04:01:19.049Z",
"SequenceNumber": "8"
}
}
]
}