Hämta programinformation

  • Artikel

Hämtar information om ett Service Fabric-program.

Returnerar information om programmet som skapades eller som håller på att skapas i Service Fabric-klustret och vars namn matchar det som anges som parametern. Svaret innehåller namn, typ, status, parametrar och annan information om programmet.

Förfrågan

Metod URI för förfrågan
GET /Applications/{applicationId}?api-version=6.0&ExcludeApplicationParameters={ExcludeApplicationParameters}&timeout={timeout}

Parametrar

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

applicationId

Typ: sträng
Obligatoriskt: Ja

Programmets identitet. Detta är vanligtvis det fullständiga namnet på programmet utan URI-schemat "fabric:". Från och med version 6.0 avgränsas hierarkiska namn med tecknet "~". Om programnamnet till exempel är "fabric:/myapp/app1" skulle programidentiteten vara "myapp~app1" i 6.0+ och "myapp/app1" i tidigare versioner.

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.

ExcludeApplicationParameters

Typ: booleskt
Obligatoriskt: Nej
Standard: false

Flaggan som anger om programparametrar ska undantas från resultatet.

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 programmet.
 ApplicationInfo
204 (NoContent) Ett tomt svar returneras om det angivna applicationId inte hittas i klustret.
Alla andra statuskoder Det detaljerade felsvaret.
 FabricError

Exempel

Hämta ett specifikt program efter program-ID

Det här exemplet visar hur du hämtar information om ett program med dess identifierare. Om programmet hittas returneras information om det med 200 statuskod. Om programmet inte hittas returneras tomt innehåll med statuskoden 204.

Förfrågan

GET http://localhost:19080/Applications/samples~CalculatorApp?api-version=6.0

200-svar

Brödtext
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0",
  "Status": "Ready",
  "Parameters": [
    {
      "Key": "CalculatorAppParameter1",
      "Value": "314"
    },
    {
      "Key": "CalculatorAppParameter2",
      "Value": "271"
    }
  ],
  "HealthState": "Ok",
  "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
}

204-svar

Brödtext

Svarstexten är tom.