Pobieranie kopii zapasowych wszystkich jednostek według zasad

  • Artykuł

Pobiera listę jednostek kopii zapasowych skojarzonych z tą zasadą.

Zwraca listę aplikacji, usługi lub partycji usługi Service Fabric skojarzonych z zasadami tworzenia kopii zapasowych.

Żądanie

Metoda Identyfikator URI żądania
GET /BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntities?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parametry

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

backupPolicyName

Typ: ciąg
Wymagane: Tak

Nazwa zasad kopii zapasowych.

api-version

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

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

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. Ta wersja jest najnowszą obsługiwaną wersją 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, a środowisko uruchomieniowe to 6.1, środowisko uruchomieniowe zaakceptuje wersję 6.1 dla tego interfejsu API. Jednak zachowanie interfejsu API będzie zgodnie z udokumentowaną wersją 6.0.

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) Pomyślna operacja zwróci kod stanu 200 oraz stronicowana lista jednostek usługi Service Fabric skojarzonych z tą zasadą.
 PagedBackupEntityList
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ć listę jednostek kopii zapasowych, które są obecnie skojarzone z zasadami tworzenia kopii zapasowych. Liczba wyników na stronie jest ograniczona do maksymalnie dwóch przy użyciu parametru MaxResult.

Żądanie

GET http://localhost:19080/BackupRestore/BackupPolicies/DailyAzureBackupPolicy/$/GetBackupEnabledEntities?api-version=6.4&MaxResults=2

Odpowiedź 200

Treść
{
  "ContinuationToken": "fabric:/DemoApp",
  "Items": [
    {
      "EntityKind": "Application",
      "ApplicationName": "fabric:/CalcApp"
    },
    {
      "EntityKind": "Application",
      "ApplicationName": "fabric:/DemoApp"
    }
  ]
}

Strona używająca tokenu kontynuacji

W tym przykładzie pokazano, jak uzyskać listę jednostek kopii zapasowych, które są obecnie skojarzone z zasadami tworzenia kopii zapasowych. W tym przykładzie użyto parametru ContinuationToken. Wartość tego parametru jest dostarczana z poprzedniego zapytania; w tym przypadku przykład pokazany powyżej. Odpowiedź zawiera pozostałe wyniki i pusty token ContinuationToken. Pusty token ContinuationToken wskazuje, że dodatkowe wyniki nie są dostępne.

Żądanie

GET http://localhost:19080/BackupRestore/BackupPolicies/DailyAzureBackupPolicy/$/GetBackupEnabledEntities?api-version=6.4&ContinuationToken=fabric:/DemoApp&MaxResults=2

Odpowiedź 200

Treść
{
  "ContinuationToken": "",
  "Items": [
    {
      "EntityKind": "Service",
      "ServiceName": "fabric:/VotingApp/VotingActorService"
    }
  ]
}