Udostępnij za pośrednictwem

Pobieranie listy informacji o typie aplikacji

  • Artykuł

Pobiera listę typów aplikacji w klastrze usługi Service Fabric.

Zwraca informacje o typach aplikacji, które są aprowidowane lub w procesie aprowizowania w klastrze usługi Service Fabric. Każda wersja typu aplikacji jest zwracana jako jeden typ aplikacji. Odpowiedź zawiera nazwę, wersję, stan i inne szczegóły dotyczące typu aplikacji. Jest to zapytanie stronicowane, co oznacza, że jeśli nie wszystkie typy aplikacji mieszczą się na stronie, zwracana jest jedna strona wyników, a także token kontynuacji, którego można użyć do pobrania następnej strony. Jeśli na przykład istnieje 10 typów aplikacji, ale strona pasuje tylko do pierwszych trzech typów aplikacji lub jeśli maksymalna liczba wyników jest ustawiona na 3, zwracana jest trzy. Aby uzyskać dostęp do pozostałych wyników, pobierz kolejne strony przy użyciu zwróconego tokenu kontynuacji w następnym zapytaniu. Pusty token kontynuacji jest zwracany, jeśli nie ma żadnych kolejnych stron.

Żądanie

Metoda Identyfikator URI żądania
GET /ApplicationTypes?api-version=6.0&ApplicationTypeDefinitionKindFilter={ApplicationTypeDefinitionKindFilter}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parametry

Nazwa Typ Wymagane Lokalizacja
api-version ciąg Tak Zapytanie
ApplicationTypeDefinitionKindFilter liczba całkowita Nie Zapytanie
ExcludeApplicationParameters boolean Nie Zapytanie
ContinuationToken ciąg Nie Zapytanie
MaxResults liczba całkowita (int64) Nie Zapytanie
timeout liczba całkowita (int64) Nie Zapytanie

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.

ApplicationTypeDefinitionKindFilter

Typ: liczba całkowita
Wymagane: Nie
Ustawienie domyślne: 0

Służy do filtrowania według właściwości ApplicationTypeDefinitionKind, który jest mechanizmem używanym do definiowania typu aplikacji usługi Service Fabric.

  • Wartość domyślna — wartość domyślna, która wykonuje tę samą funkcję co wybranie opcji "Wszystko". Wartość to 0.
  • Wszystkie — filtr pasujący do danych wejściowych z dowolną wartością ApplicationTypeDefinitionKind. Wartość to 65535.
  • ServiceFabricApplicationPackage — filtr zgodny z danymi wejściowymi z wartością ApplicationTypeDefinitionKind ServiceFabricApplicationPackage. Wartość to 1.
  • Compose — filtr zgodny z danymi wejściowymi z wartością ApplicationTypeDefinitionKind Compose. Wartość to 2.

ExcludeApplicationParameters

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

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

ContinuationToken

Typ: ciąg
Wymagane: Nie

Parametr tokenu kontynuacji służy do uzyskiwania następnego zestawu wyników. Token kontynuacji z niepustą wartością jest uwzględniany w odpowiedzi interfejsu API, gdy wyniki z systemu nie mieszczą się w jednej odpowiedzi. Po przekazaniu tej wartości do następnego wywołania interfejsu API interfejs API zwraca następny zestaw wyników. Jeśli nie ma dalszych wyników, token kontynuacji nie zawiera wartości. Wartość tego parametru nie powinna być zakodowana w adresie URL.

MaxResults

Typ: liczba całkowita (int64)
Wymagane: Nie
Ustawienie domyślne: 0
InclusiveMinimum: 0

Maksymalna liczba wyników do zwrócenia w ramach stronicowanych zapytań. Ten parametr definiuje górną granicę liczby zwróconych wyników. Zwrócone wyniki mogą być mniejsze niż określone maksymalne wyniki, jeśli nie mieszczą się w komunikacie zgodnie z maksymalnymi ograniczeniami rozmiaru komunikatu zdefiniowanymi w konfiguracji. Jeśli ten parametr ma wartość zero lub nie zostanie określony, stronicowane zapytanie zawiera jak najwięcej wyników, które mieszczą się w komunikacie zwrotnym.

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) Lista typów aplikacji w klastrze.
 PagedApplicationTypeInfoList
Wszystkie inne kody stanu Szczegółowa odpowiedź na błąd.
 Błąd sieci szkieletowej

Przykłady

Ogranicz maksymalne wyniki

W tym przykładzie pokazano, jak uzyskać informacje o typach aplikacji, które są aprowizowane lub aprowizowane w klastrze. Liczba wyników na stronie jest ograniczona do maksymalnie pięciu przy użyciu parametru MaxResult.

Żądanie

GET http://localhost:19080/ApplicationTypes?api-version=6.0&MaxResults=5

200 Odpowiedź

Treść
{
  "ContinuationToken": "PersistentQueueApp+2.0",
  "Items": [
    {
      "Name": "CalculatorApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "ServiceInstanceCount",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "CalculatorApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "ServiceInstanceCount",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "GatewayApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "GatewayPort",
          "Value": "8505"
        },
        {
          "Key": "ServiceInstanceCount",
          "Value": "1000"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    }
  ]
}

Strona korzystająca z tokenu kontynuacji

W tym przykładzie pokazano, jak stronicować informacje o typach aplikacji, które są aprowizowane lub aprowizowane w klastrze przy użyciu parametru ContinuationToken. Wartość tego parametru jest dostarczana z poprzedniego zapytania, w tym przypadku przykład pokazany powyżej. Odpowiedź zawiera pozostałe dwa wyniki i pusty ciąg ContinuationToken. Pusty ciąg ContinuationToken wskazuje, że dodatkowe wyniki nie są dostępne.

Żądanie

GET http://localhost:19080/ApplicationTypes?api-version=6.0&ContinuationToken=PersistentQueueApp+2.0&MaxResults=5

200 Odpowiedź

Treść
{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "VolatileQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    }
  ]
}

Wykluczanie parametrów aplikacji z wyniku

W tym przykładzie pokazano, jak wykluczyć parametr aplikacji w wyniku podczas uzyskiwania informacji o typach aplikacji, które są aprowizowane lub aprowizowane w klastrze.

Żądanie

GET http://localhost:19080/ApplicationTypes?api-version=6.0&ExcludeApplicationParameters=True

200 Odpowiedź

Treść
{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "CalculatorApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "CalculatorApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "GatewayApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    }
  ]
}