プロパティ情報リストの取得

指定した名前の下にあるすべての Service Fabric プロパティに関する情報を取得します。

Service Fabric 名には、カスタム情報を格納している 1 つまたは複数の名前付きプロパティを指定できます。 この操作は、これらのプロパティに関する情報をページ単位の一覧で取得します。 情報には、各プロパティに関する名前、値、メタデータが含まれます。

Request

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

パラメーター

名前	Type	必須	場所
nameId	string	はい	パス
api-version	string	はい	クエリ
IncludeValues	boolean	いいえ	クエリ
ContinuationToken	string	いいえ	クエリ
timeout	integer (int64)	いいえ	クエリ

---

nameId

型: string
必須: はい

"fabric:" URI スキームを除いた Service Fabric の名前。

---

api-version

型: string
必須: はい
既定値:

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

型: ブール値
必須: いいえ
既定値:

返されるプロパティの値を含めるかどうかを指定できます。 メタデータと共に値を返す場合は true、プロパティのメタデータのみを返す場合は false。

---

ContinuationToken

型: string
必須: いいえ

継続トークンのパラメーターは、次の結果セットを取得するために使用されます。 システムからの結果が 1 つの応答に収まらない場合は、空以外の値を持つ継続トークンが API の応答に含まれます。 この値が次の API 呼び出しに渡されると、API が次の結果セットを返します。 それ以上の結果がない場合は、継続トークンに値が含まれません。 このパラメーターの値を URL にエンコードすることはできません。

---

timeout

型: integer (int64)
必須: いいえ
既定値:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。

応答

HTTP 状態コード	説明	応答スキーマ
200 (OK)	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 名の下にあるプロパティに関する情報をページングする方法を示します。 このパラメーターの値は、前のクエリ (この場合は上に示した例) から提供されます。 応答には、残りの 2 つの結果と空の 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"
      }
    }
  ]
}