Abrufen von Eigenschafteninformationen

  • Artikel

Ruft die angegebene Service Fabric-Eigenschaft ab.

Ruft die angegebene Service Fabric-Eigenschaft unter einem bestimmten Namen ab. Dieser Befehl gibt immer einen Wert und Metadaten zurück.

Anforderung

Methode Anforderungs-URI
GET /Names/{nameId}/$/GetProperty?api-version=6.0&PropertyName={PropertyName}&timeout={timeout}

Parameter

Name type Erforderlich Standort
nameId Zeichenfolge Ja Pfad
api-version Zeichenfolge Ja Abfrage
PropertyName Zeichenfolge Ja Abfrage
timeout ganze Zahl (int64) Nein Abfrage

nameId

Typ: Zeichenfolge
Erforderlich: Ja

Der Service Fabric-Name ohne das URI-Schema 'fabric:'.

api-version

Typ: Zeichenfolge
Erforderlich: Ja
Standard:

Die Version der API. Dieser Parameter ist erforderlich, und sein Wert muss "6.0" sein.

Die Rest-API-Version von Service Fabric basiert auf der Laufzeitversion, in der die API eingeführt oder geändert wurde. Die Service Fabric-Runtime unterstützt mehrere Versionen der API. Dies ist die neueste unterstützte Version der API. Wenn eine niedrigere API-Version übergeben wird, unterscheidet sich die zurückgegebene Antwort möglicherweise von der in dieser Spezifikation dokumentierten.

Darüber hinaus akzeptiert die Runtime jede Version, die höher als die neueste unterstützte Version bis zur aktuellen Version der Runtime ist. Wenn also die neueste API-Version 6.0 ist, aber die Runtime 6.1 ist, akzeptiert die Runtime version 6.1 für diese API, um das Schreiben der Clients zu vereinfachen. Das Verhalten der API entspricht jedoch der dokumentierten Version 6.0.

PropertyName

Typ: Zeichenfolge
Erforderlich: Ja

Gibt den Namen der abzurufenden Eigenschaft ab.

timeout

Typ: integer (int64)
Erforderlich: Nein
Standard:
InclusiveMaximum: 4294967295
InklusiveMinimum: 1

Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden.

Antworten

HTTP-Statuscode BESCHREIBUNG Antwortschema
200 (OK) Details zur Service Fabric-Eigenschaft.
 Propertyinfo
Alle anderen status Codes Die detaillierte Fehlerantwort.
 FabricError

Beispiele

Abrufen von Eigenschafteninformationen

In diesem Beispiel wird gezeigt, wie Sie eine Service Fabric-Eigenschaft unter einem bestimmten Namen abrufen.

Anforderung

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

Antwort 200

Text
{
  "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"
  }
}