Odeslat dávku vlastností

  • Článek

Odešle dávku vlastností.

Odešle dávku operací vlastností. Potvrdí se buď všechny operace, nebo žádná z nich.

Žádost

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

Parametry

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

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.

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.

PropertyBatchDescriptionList

Typ: PropertyBatchDescriptionList
Povinné: Ano

Popisuje dávkové operace vlastností, které mají být odeslány.

Odpovědi

Stavový kód HTTP Description Schéma odpovědi
200 (OK) Úspěšná odpověď znamená, že dávka vlastností byla úspěšná.
 SuccessfulPropertyBatchInfo
409 (Konflikt) Odpověď 409 znamená, že jedna z operací dávky vlastností selhala a obsahuje další informace o selhání. Žádná z operací nebyla potvrzena.
 FailedPropertyBatchInfo
Všechny ostatní stavové kódy Podrobná chybová odpověď.
 Chyba infrastruktury

Příklady

Dávková operace vlastností

Tento příklad ukazuje, jak odeslat dávku vlastností. Tato dávka zajišťuje, že vlastnost existuje, kontroluje, zda má očekávané pořadové číslo, a upravuje vlastnost pouze v případě, že předchozí podmínky jsou úspěšné. Pak provede operaci get, která získá aktuální informace o vlastnosti. Pokud jsou všechny operace úspěšné, dávka se potvrdí transakčním způsobem a vrátí se úspěšná odpověď se stavovým kódem 200. Pokud dávka selže, vrátí se neúspěšná odpověď se stavovým kódem 409. Následující neúspěšná odpověď ukazuje selhání dávky, protože vlastnost nemá očekávané pořadové číslo.

Žádost

POST http://localhost:19080/Names/samples/apps/$/GetProperties/$/SubmitBatch?api-version=6.0
Text
{
  "Operations": [
    {
      "Kind": "CheckExists",
      "PropertyName": "PersistentQueueAppData",
      "Exists": true
    },
    {
      "Kind": "CheckSequence",
      "PropertyName": "PersistentQueueAppData",
      "SequenceNumber": "12"
    },
    {
      "Kind": "Put",
      "PropertyName": "PersistentQueueAppData",
      "Value": {
        "Kind": "Binary",
        "Data": [
          "1",
          "2",
          "3",
          "4",
          "5"
        ]
      },
      "CustomTypeId": "InitializationData"
    },
    {
      "Kind": "Get",
      "PropertyName": "PersistentQueueAppData",
      "IncludeValue": false
    }
  ]
}

Odpověď 200

Text
{
  "Kind": "Successful",
  "Properties": {
    "3": {
      "Name": "PersistentQueueAppData",
      "Metadata": {
        "TypeId": "Binary",
        "CustomTypeId": "InitializationData",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "5",
        "LastModifiedUtcTimestamp": "2017-07-17T05:01:19.049Z",
        "SequenceNumber": "13"
      }
    }
  }
}

Odpověď 409

Text
{
  "Kind": "Failed",
  "ErrorMessage": "FABRIC_E_PROPERTY_CHECK_FAILED",
  "OperationIndex": "1"
}