Udostępnij za pośrednictwem

Prześlij właściwość Batch

  • Artykuł

Przesyła partię właściwości.

Przesyła partię operacji właściwości. Wszystkie lub żadne operacje nie zostaną zatwierdzone.

Żądanie

Metoda Identyfikator URI żądania
POST /Names/{nameId}/$/GetProperties/$/SubmitBatch?api-version=6.0&timeout={timeout}

Parametry

Nazwa Typ Wymagane Lokalizacja
nameId ciąg Tak Ścieżka
api-version ciąg Tak Zapytanie
timeout liczba całkowita (int64) Nie Zapytanie
PropertyBatchDescriptionList PropertyBatchDescriptionList Tak Treść

nameId

Typ: ciąg
Wymagane: Tak

Nazwa usługi Service Fabric bez schematu identyfikatora URI "fabric:".

api-version

Typ: ciąg
Wymagane: Tak
Ustawienie domyślne: 6.0

Wersja interfejsu API. Ten parametr jest wymagany, a jego wartość musi mieć wartość "6.0".

Wersja interfejsu API REST usługi Service Fabric jest oparta na wersji środowiska uruchomieniowego, w której wprowadzono lub zmieniono interfejs API. Środowisko uruchomieniowe usługi Service Fabric obsługuje więcej niż jedną wersję interfejsu API. Jest to najnowsza obsługiwana wersja interfejsu API. Jeśli zostanie przekazana niższa wersja interfejsu API, zwrócona odpowiedź może być inna niż ta udokumentowana w tej specyfikacji.

Ponadto środowisko uruchomieniowe akceptuje każdą wersję, która jest wyższa niż najnowsza obsługiwana wersja do bieżącej wersji środowiska uruchomieniowego. Jeśli więc najnowsza wersja interfejsu API to 6.0, ale jeśli środowisko uruchomieniowe ma wartość 6.1, aby ułatwić pisanie klientów, środowisko uruchomieniowe zaakceptuje wersję 6.1 dla tego interfejsu API. Jednak zachowanie interfejsu API będzie zgodnie z udokumentowaną wersją 6.0.

timeout

Typ: liczba całkowita (int64)
Wymagane: Nie
Ustawienie domyślne: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Limit czasu serwera na potrzeby wykonywania operacji w sekundach. Ten limit czasu określa czas trwania, przez który klient chce poczekać na ukończenie żądanej operacji. Wartość domyślna tego parametru to 60 sekund.

PropertyBatchDescriptionList

Typ: PropertyBatchDescriptionList
Wymagane: Tak

Opisuje operacje wsadowe właściwości do przesłania.

Odpowiedzi

Kod stanu HTTP Opis Response Schema
200 (OK) Pomyślna odpowiedź oznacza, że partia właściwości powiodła się.
 SuccessfulPropertyBatchInfo
409 (Konflikt) Odpowiedź 409 oznacza, że jedna z operacji wsadowych właściwości nie powiodła się i zawiera więcej informacji o niepowodzeniu. Żadna z operacji nie została zatwierdzona.
 FailedPropertyBatchInfo
Wszystkie inne kody stanu Szczegółowa odpowiedź na błąd.
 FabricError

Przykłady

Operacja wsadowa właściwości

W tym przykładzie pokazano, jak przesłać partię właściwości. Ta partia gwarantuje, że właściwość istnieje, sprawdza, czy właściwość ma oczekiwany numer sekwencji, i edytuje właściwość tylko wtedy, gdy poprzednie warunki się powiedzie. Następnie wykonuje operację pobierania, aby pobrać bieżące informacje właściwości. Jeśli wszystkie operacje kończą się powodzeniem, partia zostanie zatwierdzona w sposób transakcyjny i zostanie zwrócona odpowiedź o powodzeniu z kodem stanu 200. Jeśli partia zakończy się niepowodzeniem, zostanie zwrócona odpowiedź, która nie powiodła się z kodem stanu 409. Poniższa odpowiedź nie powiodła się, ponieważ właściwość nie ma oczekiwanego numeru sekwencji.

Żądanie

POST http://localhost:19080/Names/samples/apps/$/GetProperties/$/SubmitBatch?api-version=6.0
Treść
{
  "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
    }
  ]
}

200 Odpowiedź

Treść
{
  "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"
      }
    }
  }
}

409 Odpowiedź

Treść
{
  "Kind": "Failed",
  "ErrorMessage": "FABRIC_E_PROPERTY_CHECK_FAILED",
  "OperationIndex": "1"
}