Skicka egenskapsbatch
Skickar en egenskapsbatch.
Skickar en batch med egenskapsåtgärder. Antingen kommer alla eller ingen av åtgärderna att checkas in.
Förfrågan
Metod | URI för förfrågan |
---|---|
POST | /Names/{nameId}/$/GetProperties/$/SubmitBatch?api-version=6.0&timeout={timeout} |
Parametrar
Namn | Typ | Obligatorisk | Location |
---|---|---|---|
nameId |
sträng | Ja | Sökväg |
api-version |
sträng | Ja | Söka i data |
timeout |
heltal (int64) | No | Söka i data |
PropertyBatchDescriptionList |
PropertyBatchDescriptionList | Yes | Brödtext |
nameId
Typ: sträng
Krävs: Ja
Service Fabric-namnet utan URI-schemat fabric:.
api-version
Typ: sträng
Krävs: Ja
Standard: 6.0
Versionen av API:et. Den här parametern krävs och dess värde måste vara "6.0".
Service Fabric REST API-versionen baseras på körningsversionen där API:et introducerades eller ändrades. Service Fabric Runtime stöder mer än en version av API:et. Det här är den senaste versionen av API:et som stöds. Om en lägre API-version skickas kan det returnerade svaret skilja sig från det som dokumenteras i den här specifikationen.
Dessutom accepterar körningen alla versioner som är högre än den senaste versionen som stöds upp till den aktuella versionen av körningen. Så om den senaste API-versionen är 6.0, men om körningen är 6.1, accepterar körningen version 6.1 för det API:et för att göra det enklare att skriva klienterna. Beteendet för API:et är dock enligt den dokumenterade 6.0-versionen.
timeout
Typ: heltal (int64)
Krävs: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Serverns tidsgräns för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta på att den begärda åtgärden ska slutföras. Standardvärdet för den här parametern är 60 sekunder.
PropertyBatchDescriptionList
Typ: PropertyBatchDescriptionList
Krävs: Ja
Beskriver de batchåtgärder för egenskapen som ska skickas.
Svar
HTTP-statuskod | Description | Svarsschema |
---|---|---|
200 (OK) | Ett lyckat svar innebär att egenskapsbatchen lyckades. |
SuccessfulPropertyBatchInfo |
409 (konflikt) | Ett 409-svar innebär att en av egenskapsbatchåtgärderna misslyckades och innehåller mer information om felet. Ingen av åtgärderna har utförts. |
FailedPropertyBatchInfo |
Alla andra statuskoder | Det detaljerade felsvaret. |
FabricError |
Exempel
Batchåtgärd för egenskap
Det här exemplet visar hur du skickar en egenskapsbatch. Den här batchen säkerställer att det finns en egenskap, kontrollerar att egenskapen har det förväntade sekvensnumret och redigerar endast egenskapen om de tidigare villkoren lyckas. Den utför sedan en get-åtgärd för att hämta egenskapens aktuella information. Om alla åtgärder lyckas genomförs batchen på ett transaktionellt sätt och ett lyckat svar returneras med statuskoden 200. Om batchen misslyckas returneras ett misslyckat svar med statuskoden 409. Det misslyckade svaret nedan visar batchfel eftersom egenskapen inte har förväntat sekvensnummer.
Förfrågan
POST http://localhost:19080/Names/samples/apps/$/GetProperties/$/SubmitBatch?api-version=6.0
Brödtext
{
"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 Svar
Brödtext
{
"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 Svar
Brödtext
{
"Kind": "Failed",
"ErrorMessage": "FABRIC_E_PROPERTY_CHECK_FAILED",
"OperationIndex": "1"
}