Sdílet prostřednictvím

Získat seznam informací o vlastnosti

  • Článek

Získá informace o všech vlastnostech Service Fabric pod daným názvem.

Název Service Fabric může mít jednu nebo více pojmenovaných vlastností, které ukládají vlastní informace. Tato operace získá informace o těchto vlastnostech ve stránkovaném seznamu. Informace zahrnují název, hodnotu a metadata o jednotlivých vlastnostech.

Žádost

Metoda Identifikátor URI žádosti
GET /Names/{nameId}/$/GetProperties?api-version=6.0&IncludeValues={IncludeValues}&ContinuationToken={ContinuationToken}&timeout={timeout}

Parametry

Název Typ Vyžadováno Umístění
nameId řetězec Yes Cesta
api-version řetězec Ano Dotaz
IncludeValues boolean Ne Dotaz
ContinuationToken řetězec No Dotaz
timeout integer (int64) Ne Dotaz

nameId

Typ: řetězec
Povinné: Ano

Název Service Fabric bez schématu identifikátoru URI "fabric:".

api-version

Typ: řetězec
Povinné: Ano
Výchozí:6.0

Verze rozhraní API. Tento parametr je povinný a jeho hodnota musí být 6.0.

Verze rozhraní REST API Service Fabric je založená na verzi modulu runtime, ve které bylo rozhraní API zavedeno nebo změněno. Modul runtime Service Fabric podporuje více než jednu verzi rozhraní API. Toto je nejnovější podporovaná verze rozhraní API. Pokud se předá nižší verze rozhraní API, může se vrácená odpověď lišit od odpovědi popsané v této specifikaci.

Modul runtime navíc přijímá všechny verze, které jsou vyšší než nejnovější podporovaná verze až do aktuální verze modulu runtime. Pokud je tedy nejnovější verze rozhraní API 6.0, ale modul runtime je 6.1, aby se usnadnil zápis klientů, modul runtime pro toto rozhraní API přijme verzi 6.1. Chování rozhraní API však bude podle zdokumentované verze 6.0.

IncludeValues

Typ: boolean
Povinné: Ne
Výchozí:false

Umožňuje určit, zda mají být zahrnuty hodnoty vrácených vlastností. True Pokud hodnoty by měly být vráceny s metadaty; False, pokud chcete vrátit pouze metadata vlastností.

ContinuationToken

Typ: řetězec
Povinné: Ne

Parametr tokenu pokračování se používá k získání další sady výsledků. Pokračovací token s neprázdnou hodnotou se zahrne do odpovědi rozhraní API v případech, kdy se výsledky ze systému nevejdou do jedné odpovědi. Když se tato hodnota předá dalšímu volání rozhraní API, vrátí rozhraní API další sadu výsledků. Pokud nejsou k dispozici žádné další výsledky, znamená to, že pokračovací token neobsahuje hodnotu. Hodnota tohoto parametru by neměla být zakódovaná adresa URL.

timeout

Typ: integer (int64)
Povinné: Ne
Výchozí:60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Časový limit serveru pro provedení operace v sekundách. Tento časový limit určuje dobu, po kterou je klient ochoten čekat na dokončení požadované operace. Výchozí hodnota tohoto parametru je 60 sekund.

Odpovědi

Stavový kód HTTP Description Schéma odpovědi
200 (OK) Stránkovaný seznam vlastností Service Fabric.
 PagedPropertyInfoList
Všechny ostatní stavové kódy Podrobná chybová odpověď.
 Chyba infrastruktury

Příklady

Získání seznamu informací o vlastnosti

Tento příklad ukazuje, jak získat všechny vlastnosti Service Fabric pod daným názvem.

Žádost

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

Odpověď 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"
      }
    }
  ]
}

Získání seznamu informací o vlastnosti s hodnotami

Tento příklad ukazuje, jak získat všechny vlastnosti Service Fabric a jejich hodnoty pod daným názvem.

Žádost

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

Odpověď 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"
      }
    }
  ]
}

Stránka s využitím pokračovacího tokenu

Tento příklad ukazuje, jak procházet informace o vlastnostech pod daným názvem Service Fabric pomocí parametru ContinuationToken. Hodnota tohoto parametru je zadaná z předchozího dotazu, v tomto případě z výše uvedeného příkladu. Odpověď obsahuje zbývající dva výsledky a prázdný ContinuationToken. Prázdný token ContinuationToken označuje, že další výsledky nejsou k dispozici.

Žádost

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

Odpověď 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"
      }
    }
  ]
}