Get Property Info List

Ruft Informationen zu allen Service Fabric-Eigenschaften unter einem bestimmten Namen ab.

Ein Service Fabric-Name kann eine oder mehrere benannte Eigenschaften haben, in denen benutzerdefinierten Informationen gespeichert sind. Dieser Vorgang ruft die Informationen zu diesen Eigenschaften in einer seitenbasierte Liste ab. Zu diesen Informationen zählen Name, Wert und Metadaten der einzelnen Eigenschaften.

Anforderung

Methode	Anforderungs-URI
GET	/Names/{nameId}/$/GetProperties?api-version=6.0&IncludeValues={IncludeValues}&ContinuationToken={ContinuationToken}&timeout={timeout}

Parameter

Name	type	Erforderlich	Standort
nameId	Zeichenfolge	Ja	Pfad
api-version	Zeichenfolge	Ja	Abfrage
IncludeValues	boolean	Nein	Abfrage
ContinuationToken	Zeichenfolge	Nein	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.

---

IncludeValues

Typ: boolean
Erforderlich: Nein
Standard:

Ermöglicht die Angabe, ob die Werte der zurückgegebenen Eigenschaften eingeschlossen werden sollen. Mit „true“ wird festgelegt, dass die Werte mit den Metadaten zurückgegeben werden sollen, während „false“ angibt, dass nur Eigenschaftsmetadaten zurückgeben werden sollen.

---

ContinuationToken

Typ: Zeichenfolge
Erforderlich: Nein

Der Parameter „continuation-token“ (Fortsetzungstoken) wird dazu verwendet, den nächsten Satz von Ergebnissen abzurufen. Ein Fortsetzungstoken mit einem nicht leeren Wert wird in die Antwort der API eingefügt, wenn die Ergebnisse aus dem System nicht in eine einzige Antwort passen. Wird dieser Wert an den nächsten API-Aufruf übergeben, gibt die API den nächsten Satz von Ergebnissen zurück. Gibt es keine weiteren Ergebnisse, enthält das Fortsetzungstoken keinen Wert. Der Wert dieses Parameters darf nicht als URL codiert sein.

---

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)	Eine ausgelagerte Liste der Service Fabric-Eigenschaften.	PagedPropertyInfoList
Alle anderen status Codes	Die detaillierte Fehlerantwort.	FabricError

Beispiele

Liste mit Eigenschafteninformationen abrufen

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

Anforderung

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

Antwort 200

Text

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

Abrufen einer Liste mit Eigenschafteninformationen mit Werten

In diesem Beispiel wird gezeigt, wie Alle Service Fabric-Eigenschaften und deren Werte unter einem angegebenen Namen abgerufen werden.

Anforderung

GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True

Antwort 200

Text

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

Seite mit Fortsetzungstoken

In diesem Beispiel wird gezeigt, wie Sie die Informationen zu Eigenschaften unter einem bestimmten Service Fabric-Namen mithilfe des Parameters ContinuationToken durchblättern. Der Wert dieses Parameters wird aus der vorherigen Abfrage bereitgestellt, in diesem Fall im oben gezeigten Beispiel. Die Antwort enthält die verbleibenden beiden Ergebnisse und ein leeres ContinuationToken. Das leere ContinuationToken gibt an, dass keine zusätzlichen Ergebnisse verfügbar sind.

Anforderung

GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True&ContinuationToken=PersistentQueueAppData$131439231986491349

Antwort 200

Text

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