取得屬性資訊清單

發行項
07/19/2023

取得指定名稱下所有 Service Fabric 屬性的相關資訊。

Service Fabric 名稱可以包含一或多個儲存自訂資訊的具名屬性。此作業會以分頁清單方式取得這些屬性的相關資訊。此資訊包含每個屬性的相關名稱、值及中繼資料。

要求

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

參數

名稱	類型	必要	Location
`nameId`	字串	是	路徑
`api-version`	字串	是	查詢
`IncludeValues`	boolean	No	查詢
`ContinuationToken`	字串	No	查詢
`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 版本。

`IncludeValues`

類型：布林值
必要：否
預設：false

允許指定是否要包含所傳回屬性的值。如果值應該與中繼資料一起傳回，即為 True；若只要傳回屬性中繼資料，則為 False。

`ContinuationToken`

類型：字串
必要：否

接續權杖參數可用來取得下一組結果。當來自系統的結果無法放入單一回應中時，API 的回應中會包含具有非空白值的接續權杖。當此值傳遞至下一個 API 呼叫時，API 會傳回下一組結果。如果沒有任何進一步的結果，接續權杖就不會包含值。此參數的值不能經過 URL 編碼。

`timeout`

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

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

回應

HTTP 狀態碼	描述	回應結構描述
200 (確定)	Service Fabric 屬性的分頁清單。	PagedPropertyInfoList
所有其他狀態碼	詳細的錯誤回應。	FabricError

範例

取得屬性資訊清單

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

要求

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

200 回應

主體

{
  "ContinuationToken": "PersistentQueueAppData$131439231986491349",
  "IsConsistent": true,
  "Properties": [
    {
      "Name": "CalculatorAppData",
      "Metadata": {
        "TypeId": "Int64",
        "CustomTypeId": "",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "5",
        "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
        "SequenceNumber": "10"
      }
    },
    {
      "Name": "PersistentQueueAppData",
      "Metadata": {
        "TypeId": "Binary",
        "CustomTypeId": "InitializationDataType",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "5",
        "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z",
        "SequenceNumber": "12"
      }
    }
  ]
}

取得具有值的屬性資訊清單

此範例示範如何取得指定名稱下的所有 Service Fabric 屬性及其值。

要求

GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True

200 回應

主體

{
  "ContinuationToken": "PersistentQueueAppData$131439231986491349",
  "IsConsistent": true,
  "Properties": [
    {
      "Name": "CalculatorAppData",
      "Value": {
        "Kind": "Int64",
        "Data": "4534"
      },
      "Metadata": {
        "TypeId": "Int64",
        "CustomTypeId": "",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "8",
        "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
        "SequenceNumber": "10"
      }
    },
    {
      "Name": "PersistentQueueAppData",
      "Value": {
        "Kind": "Binary",
        "Data": [
          "6",
          "7",
          "8",
          "9",
          "10"
        ]
      },
      "Metadata": {
        "TypeId": "Binary",
        "CustomTypeId": "InitializationDataType",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "5",
        "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z",
        "SequenceNumber": "12"
      }
    }
  ]
}

使用接續權杖的頁面

此範例示範如何使用 ContinuationToken 參數，逐頁查看指定 Service Fabric 名稱下屬性的相關資訊。此參數的值是從上一個查詢提供，在此案例中為上述範例。回應包含剩餘的兩個結果和空的 ContinuationToken。空的 ContinuationToken 表示無法使用其他結果。

要求

GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True&ContinuationToken=PersistentQueueAppData$131439231986491349

200 回應

主體

{
  "ContinuationToken": "",
  "IsConsistent": true,
  "Properties": [
    {
      "Name": "VolatileQueueAppData",
      "Value": {
        "Kind": "Double",
        "Data": "67.89"
      },
      "Metadata": {
        "TypeId": "Double",
        "CustomTypeId": "",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "8",
        "LastModifiedUtcTimestamp": "2017-07-17T04:01:19.049Z",
        "SequenceNumber": "8"
      }
    }
  ]
}