共用方式為

取得屬性資訊

  • 發行項

取得指定的 Service Fabric 屬性。

取得指定名稱下指定的 Service Fabric 屬性。 這一律會同時傳回值和中繼資料。

要求

方法 要求 URI
GET /Names/{nameId}/$/GetProperty?api-version=6.0&PropertyName={PropertyName}&timeout={timeout}

參數

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

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 版本。

PropertyName

類型：字串
必要：是

指定要取得之屬性的名稱。

timeout

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

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

回應

HTTP 狀態碼 描述 回應結構描述
200 (確定) Service Fabric 屬性的詳細資料。
 PropertyInfo
所有其他狀態碼 詳細的錯誤回應。
 FabricError

範例

取得屬性資訊

此範例示範如何取得指定名稱下的 Service Fabric 屬性。

要求

GET http://localhost:19080/Names/samples/apps/$/GetProperty?api-version=6.0&PropertyName=AppData

200 回應

主體
{
  "Name": "CalculatorAppData",
  "Value": {
    "Kind": "String",
    "Data": "1+2=3"
  },
  "Metadata": {
    "TypeId": "String",
    "CustomTypeId": "EquationType",
    "Parent": "fabric:/samples/apps",
    "SizeInBytes": "12",
    "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
    "SequenceNumber": "12"
  }
}