Hämta egenskapsinformation

  • Artikel

Hämtar den angivna Service Fabric-egenskapen.

Hämtar den angivna Service Fabric-egenskapen under ett angivet namn. Detta returnerar alltid både värde och metadata.

Förfrågan

Metod URI för förfrågan
GET /Names/{nameId}/$/GetProperty?api-version=6.0&PropertyName={PropertyName}&timeout={timeout}

Parametrar

Namn Typ Obligatorisk Location
nameId sträng Ja Sökväg
api-version sträng Ja Söka i data
PropertyName sträng Ja Söka i data
timeout heltal (int64) No Söka i data

nameId

Typ: sträng
Obligatoriskt: Ja

Service Fabric-namnet utan URI-schemat fabric:.

api-version

Typ: sträng
Obligatoriskt: Ja
Standard: 6.0

Versionen av API:et. Den här parametern krävs och dess värde måste vara "6.0".

Service Fabric REST API-versionen baseras på körningsversionen där API:et introducerades eller ändrades. Service Fabric Runtime stöder mer än en version av API:et. Det här är den senaste versionen av API:et som stöds. Om en lägre API-version skickas kan det returnerade svaret skilja sig från det som beskrivs i den här specifikationen.

Dessutom accepterar körningen alla versioner som är högre än den senaste versionen som stöds fram till den aktuella versionen av körningen. Så om den senaste API-versionen är 6.0, men om körningen är 6.1, för att göra det enklare att skriva klienterna, accepterar körningen version 6.1 för det API:et. Beteendet för API:et kommer dock att vara enligt den dokumenterade 6.0-versionen.

PropertyName

Typ: sträng
Obligatoriskt: Ja

Anger namnet på egenskapen som ska hämtas.

timeout

Typ: heltal (int64)
Obligatoriskt: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Serverns timeout för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta på att den begärda åtgärden ska slutföras. Standardvärdet för den här parametern är 60 sekunder.

Svar

HTTP-statuskod Description Svarsschema
200 (OK) Information om egenskapen Service Fabric.
 PropertyInfo
Alla andra statuskoder Det detaljerade felsvaret.
 FabricError

Exempel

Hämta egenskapsinformation

Det här exemplet visar hur du hämtar en Service Fabric-egenskap under ett visst namn.

Förfrågan

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

200-svar

Brödtext
{
  "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"
  }
}