プロパティ情報を取得する

  • [アーティクル]

指定した Service Fabric プロパティを取得します。

指定した名前の下にある指定した Service Fabric プロパティを取得します。 メタデータと値の両方が常に返ります。

Request

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

パラメーター

名前 Type 必須 場所
nameId string はい パス
api-version string はい クエリ
PropertyName 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 バージョンに従います。

PropertyName

型: string
必須: はい

取得するプロパティの名前を指定します。

timeout

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

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

応答

HTTP 状態コード 説明 応答スキーマ
200 (OK) 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"
  }
}