Partager via

Obtenir des informations sur les propriétés

  • Article

Permet d’obtenir la propriété Service Fabric spécifiée.

Obtient la propriété Service Fabric spécifiée sous un nom donné. Retourne toujours à la fois la valeur et les métadonnées.

Requête

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

Paramètres

Nom Type Obligatoire Emplacement
nameId string Oui Chemin d’accès
api-version string Oui Requête
PropertyName string Oui 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.

PropertyName

Type : chaîne
Obligatoire : Oui

Spécifie le nom de la propriété à obtenir.

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) Détails sur la propriété Service Fabric.
 Propertyinfo
Tous les autres codes status Réponse d’erreur détaillée.
 FabricError

Exemples

Obtenir des informations sur la propriété

Cet exemple montre comment obtenir une propriété Service Fabric sous un nom donné.

Requête

GET http://localhost:19080/Names/samples/apps/$/GetProperty?api-version=6.0&PropertyName=AppData

Réponse 200

Corps
{
  "Name": "CalculatorAppData",
  "Value": {
    "Kind": "String",
    "Data": "1+2=3"
  },
  "Metadata": {
    "TypeId": "String",
    "CustomTypeId": "EquationType",
    "Parent": "fabric:/samples/apps",
    "SizeInBytes": "12",
    "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
    "SequenceNumber": "12"
  }
}