Submit 屬性 Batch

發行項
08/05/2023

提交屬性批次。

提交屬性作業的批次。將會認可所有或沒有任何作業。

要求

方法	要求 URI
POST	`/Names/{nameId}/$/GetProperties/$/SubmitBatch?api-version=6.0&timeout={timeout}`

參數

名稱	類型	必要	Location
`nameId`	字串	是	路徑
`api-version`	字串	是	查詢
`timeout`	整數 (int64)	No	查詢
`PropertyBatchDescriptionList`	PropertyBatchDescriptionList	是	body

`nameId`

類型：字串
必要：是

不含 'fabric:' URI 配置的 Service Fabric 名稱。

`api-version`

類型：字串
必要：是
預設：6.0

API 的版本。這是必要參數，其值必須是 '6.0'。

Service Fabric REST API 版本是以導入或變更 API 的執行時間版本為基礎。 Service Fabric 執行時間支援多個版本的 API。這是 API 的最新支援版本。如果傳遞較低的 API 版本，傳回的回應可能與此規格中所述的回應不同。

此外，執行時間會接受高於最新支援版本的任何版本，最高為目前版本的執行時間。因此，如果最新的 API 版本是 6.0，但如果執行時間是 6.1，為了更容易撰寫用戶端，執行時間將會接受該 API 6.1 版。不過，API 的行為會根據記載的 6.0 版本。

`timeout`

類型：整數 (int64)
必要：否
預設：60
InclusiveMaximum： 4294967295
InclusiveMinimum： 1

用來執行作業的伺服器逾時 (以秒為單位)。此逾時指定了用戶端願意等候要求作業完成的持續時間。這個參數的預設值是 60 秒。

`PropertyBatchDescriptionList`

類型： PropertyBatchDescriptionList
必要：是

描述要提交的屬性批次作業。

回應

HTTP 狀態碼	描述	回應結構描述
200 (確定)	成功的回應表示屬性批次成功。	SuccessfulPropertyBatchInfo
409 (衝突)	409 回應表示其中一個屬性批次作業失敗，並包含失敗的詳細資訊。未認可任何作業。	FailedPropertyBatchInfo
所有其他狀態碼	詳細的錯誤回應。	FabricError

範例

屬性批次作業

此範例示範如何提交屬性批次。此批次可確保屬性存在、檢查屬性是否具有預期的序號，並且只有在先前的條件成功時才編輯屬性。然後，它會執行取得作業，以取得屬性的目前資訊。如果所有作業都成功，批次會以交易方式認可，並以 200 狀態碼傳回成功回應。如果批次失敗，則會以 409 狀態碼傳回失敗的回應。下列失敗回應會顯示批次失敗，因為屬性沒有預期的序號。

要求

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

主體

{
  "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 回應

主體

{
  "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 回應

主體

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

共用方式為