Udostępnij za pośrednictwem

Uzyskiwanie informacji o aplikacji

  • Artykuł

Pobiera informacje o aplikacji usługi Service Fabric.

Zwraca informacje o aplikacji, która została utworzona lub w procesie tworzenia w klastrze usługi Service Fabric i których nazwa jest zgodna z nazwą określoną jako parametr. Odpowiedź zawiera nazwę, typ, stan, parametry i inne szczegóły dotyczące aplikacji.

Żądanie

Metoda Identyfikator URI żądania
GET /Applications/{applicationId}?api-version=6.0&ExcludeApplicationParameters={ExcludeApplicationParameters}&timeout={timeout}

Parametry

Nazwa Typ Wymagane Lokalizacja
applicationId ciąg Tak Ścieżka
api-version ciąg Tak Zapytanie
ExcludeApplicationParameters boolean Nie Zapytanie
timeout liczba całkowita (int64) Nie Zapytanie

applicationId

Typ: ciąg
Wymagane: Tak

Tożsamość aplikacji. Zazwyczaj jest to pełna nazwa aplikacji bez schematu identyfikatora URI "fabric:". Począwszy od wersji 6.0, nazwy hierarchiczne są rozdzielane znakiem "~". Jeśli na przykład nazwa aplikacji to "fabric:/myapp/app1", tożsamość aplikacji będzie miała wartość "myapp~app1" w wersji 6.0+ i "myapp/app1" w poprzednich wersjach.

api-version

Typ: ciąg
Wymagane: Tak
Ustawienie domyślne: 6.0

Wersja interfejsu API. Ten parametr jest wymagany, a jego wartość musi mieć wartość "6.0".

Wersja interfejsu API REST usługi Service Fabric jest oparta na wersji środowiska uruchomieniowego, w której wprowadzono lub zmieniono interfejs API. Środowisko uruchomieniowe usługi Service Fabric obsługuje więcej niż jedną wersję interfejsu API. Jest to najnowsza obsługiwana wersja interfejsu API. Jeśli zostanie przekazana niższa wersja interfejsu API, zwrócona odpowiedź może być inna niż ta udokumentowana w tej specyfikacji.

Ponadto środowisko uruchomieniowe akceptuje wszystkie wersje wyższe niż najnowsza obsługiwana wersja do bieżącej wersji środowiska uruchomieniowego. Jeśli więc najnowsza wersja interfejsu API to 6.0, ale jeśli środowisko uruchomieniowe ma wartość 6.1, aby ułatwić pisanie klientów, środowisko uruchomieniowe zaakceptuje wersję 6.1 dla tego interfejsu API. Jednak zachowanie interfejsu API będzie zgodnie z udokumentowaną wersją 6.0.

ExcludeApplicationParameters

Typ: wartość logiczna
Wymagane: Nie
Ustawienie domyślne: false

Flaga określająca, czy parametry aplikacji zostaną wykluczone z wyniku.

timeout

Typ: liczba całkowita (int64)
Wymagane: Nie
Ustawienie domyślne: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Limit czasu serwera na potrzeby wykonywania operacji w sekundach. Ten limit czasu określa czas trwania, przez który klient chce poczekać na ukończenie żądanej operacji. Wartość domyślna tego parametru to 60 sekund.

Odpowiedzi

Kod stanu HTTP Opis Response Schema
200 (OK) Informacje o aplikacji.
 Informacje o aplikacji
204 (NoContent) Pusta odpowiedź jest zwracana, jeśli określony identyfikator applicationId nie zostanie znaleziony w klastrze.
Wszystkie inne kody stanu Szczegółowa odpowiedź na błąd.
 Błąd sieci szkieletowej

Przykłady

Pobieranie określonej aplikacji według identyfikatora aplikacji

W tym przykładzie pokazano, jak uzyskać informacje o aplikacji przy użyciu identyfikatora. Jeśli aplikacja zostanie znaleziona, informacje o niej są zwracane z kodem stanu 200. Jeśli aplikacja nie zostanie znaleziona, zostanie zwrócona pusta zawartość z kodem stanu 204.

Żądanie

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

Odpowiedź 200

Treść
{
  "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"
}

Odpowiedź 204

Treść

Treść odpowiedzi jest pusta.