Dela via

Hämta tjänstbeskrivning

  • Artikel

Hämtar beskrivningen av en befintlig Service Fabric-tjänst.

Hämtar beskrivningen av en befintlig Service Fabric-tjänst. En tjänst måste skapas innan dess beskrivning kan hämtas.

Förfrågan

Metod URI för förfrågan
GET /Services/{serviceId}/$/GetDescription?api-version=6.0&timeout={timeout}

Parametrar

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

serviceId

Typ: sträng
Krävs: Ja

Tjänstens identitet. Det här ID:t är vanligtvis det fullständiga namnet på tjänsten utan URI-schemat fabric:. Från och med version 6.0 avgränsas hierarkiska namn med tecknet "~". Om tjänstnamnet till exempel är "fabric:/myapp/app1/svc1" skulle tjänstidentiteten vara "myapp~app1~svc1" i 6.0+ och "myapp/app1/svc1" i tidigare versioner.

api-version

Typ: sträng
Krävs: 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 dokumenteras i den här specifikationen.

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

timeout

Typ: heltal (int64)
Krävs: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Serverns tidsgräns 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) En lyckad åtgärd returnerar 200 statuskod.
 Tjänstbeskrivning
Alla andra statuskoder Det detaljerade felsvaret.
 FabricError