Získat seznam záloh aplikací

Článek
08/05/2023

Získá seznam záloh dostupných pro každý oddíl v této aplikaci.

Vrátí seznam záloh dostupných pro každý oddíl v této aplikaci Service Fabric. Server vytvoří výčet všech záloh dostupných v umístění zálohování nakonfigurované v zásadách zálohování. Umožňuje také filtrovat výsledek na základě počátečního a koncového data a času nebo jenom načíst nejnovější dostupnou zálohu pro každý oddíl.

Žádost

Metoda	Identifikátor URI žádosti
GET	`/Applications/{applicationId}/$/GetBackups?api-version=6.4&timeout={timeout}&Latest={Latest}&StartDateTimeFilter={StartDateTimeFilter}&EndDateTimeFilter={EndDateTimeFilter}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}`

Parametry

Název	Typ	Vyžadováno	Umístění
`applicationId`	řetězec	Yes	Cesta
`api-version`	řetězec	Ano	Dotaz
`timeout`	celé číslo (int64)	Ne	Dotaz
`Latest`	boolean	Ne	Dotaz
`StartDateTimeFilter`	string (datum a čas)	Ne	Dotaz
`EndDateTimeFilter`	string (datum a čas)	Ne	Dotaz
`ContinuationToken`	řetězec	No	Dotaz
`MaxResults`	celé číslo (int64)	Ne	Dotaz

`applicationId`

Typ: string
Povinné: Ano

Identita aplikace. Obvykle se jedná o úplný název aplikace bez schématu identifikátoru URI fabric:. Od verze 6.0 jsou hierarchické názvy oddělené znakem "~". Pokud je například název aplikace "fabric:/myapp/app1", bude identita aplikace ve verzi 6.0 nebo novější myapp~app1 a v předchozích verzích myapp/app1.

`api-version`

Typ: string
Povinné: Ano
Výchozí:6.4

Verze rozhraní API Tento parametr je povinný a jeho hodnota musí být 6,4.

Verze rozhraní SERVICE Fabric REST API je založená na verzi modulu runtime, ve které bylo rozhraní API zavedeno nebo změněno. Modul runtime Service Fabric podporuje více než jednu verzi rozhraní API. Tato verze je nejnovější podporovanou verzí rozhraní API. Pokud je předána nižší verze rozhraní API, vrácená odpověď se může lišit od odpovědi popsané v této specifikaci.

Modul runtime navíc přijímá všechny verze, které jsou vyšší než nejnovější podporovaná verze až do aktuální verze modulu runtime. Pokud je tedy nejnovější verze rozhraní API 6.0 a modul runtime je 6.1, modul runtime pro toto rozhraní API přijme verzi 6.1. Chování rozhraní API však bude podle zdokumentované verze 6.0.

`timeout`

Typ: celé číslo (int64)
Povinné: Ne
Výchozí:60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Časový limit serveru pro provedení operace v sekundách. Tento časový limit určuje dobu, po kterou je klient ochoten čekat na dokončení požadované operace. Výchozí hodnota tohoto parametru je 60 sekund.

`Latest`

Typ: logická
Povinné: Ne
Výchozí:false

Určuje, jestli se má získat pouze nejnovější dostupná záloha pro oddíl v zadaném časovém rozsahu.

`StartDateTimeFilter`

Typ: řetězec (datum a čas)
Povinné: Ne

Zadejte počáteční datum a čas, od kterého chcete vytvořit výčet záloh, ve formátu datetime. Datum a čas musí být zadán ve formátu ISO8601. Jedná se o volitelný parametr. Pokud není zadáno, zobrazí se výčet všech záloh od začátku.

`EndDateTimeFilter`

Typ: řetězec (datum a čas)
Povinné: Ne

Zadejte koncové datum a čas, do kterého chcete vytvořit výčet záloh, ve formátu datetime. Datum a čas musí být zadán ve formátu ISO8601. Jedná se o volitelný parametr. Pokud není zadaný, provede se výčet až do poslední zálohy.

`ContinuationToken`

Typ: string
Povinné: Ne

Parametr pokračovacího tokenu se používá k získání další sady výsledků. Token pokračování s neprázdnou hodnotou je součástí odpovědi rozhraní API, pokud se výsledky ze systému nevejdou do jedné odpovědi. Když se tato hodnota předá dalšímu volání rozhraní API, vrátí rozhraní API další sadu výsledků. Pokud nejsou k dispozici žádné další výsledky, znamená to, že pokračovací token neobsahuje hodnotu. Hodnota tohoto parametru by neměla být kódovaná adresa URL.

`MaxResults`

Typ: celé číslo (int64)
Povinné: Ne
Výchozí:0
InclusiveMinimum: 0

Maximální počet výsledků, které se mají vrátit jako součást stránkovaných dotazů. Tento parametr definuje horní mez počtu vrácených výsledků. Vrácené výsledky můžou být menší než zadané maximální výsledky, pokud se nevejdou do zprávy podle omezení maximální velikosti zprávy definované v konfiguraci. Pokud je tento parametr nula nebo není zadaný, stránkovaný dotaz obsahuje co nejvíce výsledků, které se vejdou do návratové zprávy.

Odpovědi

Stavový kód HTTP	Description	Schéma odpovědi
200 (OK)	Úspěšná operace vrátí stavový kód 200 a stránkovaný seznam informací o zálohách.	PagedBackupInfoList
Všechny ostatní stavové kódy	Podrobná odpověď na chybu.	Chyba infrastruktury

Příklady

Získání záloh aplikací v časovém rozsahu

Tento příklad ukazuje, jak získat seznam záloh aplikací v rámci časového rozsahu.

Žádost

GET http://localhost:19080/Applications/CalcApp/$/GetBackups?api-version=6.4&StartDateTimeFilter=2018-01-01T00:00:00Z&EndDateTimeFilter=2018-01-01T23:59:59Z

Odpověď: 200

Text

{
  "ContinuationToken": "",
  "Items": [
    {
      "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
      "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
      },
      "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip",
      "BackupType": "Full",
      "ServiceManifestVersion": "1.0.0",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "261",
      "CreationTimeUtc": "2018-01-01T09:00:55Z",
      "FailureError": null
    },
    {
      "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
      "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceManifestVersion": "1.0.0",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
      },
      "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
      "BackupType": "Incremental",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "446",
      "CreationTimeUtc": "2018-01-01T17:01:02Z",
      "FailureError": null
    },
    {
      "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
      "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "ServiceManifestVersion": "1.0.0",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
      },
      "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip",
      "BackupType": "Full",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "161",
      "CreationTimeUtc": "2018-01-01T09:01:02Z",
      "FailureError": null
    },
    {
      "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
      "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "ServiceManifestVersion": "1.0.0",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
      },
      "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
      "BackupType": "Incremental",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "246",
      "CreationTimeUtc": "2018-01-01T17:00:34Z",
      "FailureError": null
    }
  ]
}

Získání nejnovější zálohy

Tento příklad ukazuje, jak získat nejnovější zálohu pro každý oddíl v rámci aplikace.

Žádost

GET http://localhost:19080/Applications/CalcApp/$/GetBackups?api-version=6.4&Latest=True

Odpověď: 200

Text

{
  "ContinuationToken": "",
  "Items": [
    {
      "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
      "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "ServiceManifestVersion": "1.0.0",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
      },
      "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
      "BackupType": "Incremental",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "446",
      "CreationTimeUtc": "2018-01-01T17:01:02Z",
      "FailureError": null
    },
    {
      "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
      "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceManifestVersion": "1.0.0",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
      },
      "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
      "BackupType": "Incremental",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "246",
      "CreationTimeUtc": "2018-01-01T17:00:34Z",
      "FailureError": null
    }
  ]
}

Omezit maximální počet výsledků

Tento příklad ukazuje, jak získat seznam záloh aplikací. Počet výsledků na stránce je omezen maximálně na dva pomocí parametru MaxResult.

Žádost

GET http://localhost:19080/Applications/CalcApp/$/GetBackups?api-version=6.4&MaxResults=2

Odpověď: 200

Text

{
  "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
  "Items": [
    {
      "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
      "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceManifestVersion": "1.0.0",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
      },
      "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip",
      "BackupType": "Full",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "261",
      "CreationTimeUtc": "2018-01-01T09:00:55Z",
      "FailureError": null
    },
    {
      "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
      "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceManifestVersion": "1.0.0",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
      },
      "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
      "BackupType": "Incremental",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "446",
      "CreationTimeUtc": "2018-01-01T17:01:02Z",
      "FailureError": null
    }
  ]
}

Stránka pomocí pokračovacího tokenu

Tento příklad ukazuje, jak získat seznam záloh aplikací. Počet výsledků na stránce je omezen maximálně na dva pomocí parametru MaxResult. Tento příklad používá parametr ContinuationToken. Hodnota tohoto parametru je zadaná z předchozího dotazu; v tomto případě výše uvedený příklad. Odpověď obsahuje zbývající výsledky a prázdný text ContinuationToken. Prázdný ContinuationToken označuje, že další výsledky nejsou k dispozici.

Žádost

GET http://localhost:19080/Applications/CalcApp/$/GetBackups?api-version=6.4&ContinuationToken=fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd&MaxResults=2

Odpověď: 200

Text

{
  "ContinuationToken": "",
  "Items": [
    {
      "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
      "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceManifestVersion": "1.0.0",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
      },
      "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip",
      "BackupType": "Full",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "161",
      "CreationTimeUtc": "2018-01-01T09:01:02Z",
      "FailureError": null
    },
    {
      "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
      "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
      "ApplicationName": "fabric:/CalcApp",
      "ServiceManifestVersion": "1.0.0",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionInformation": {
        "LowKey": "-9223372036854775808",
        "HighKey": "9223372036854775807",
        "ServicePartitionKind": "Int64Range",
        "Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
      },
      "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
      "BackupType": "Incremental",
      "EpochOfLastBackupRecord": {
        "DataLossVersion": "131462452931584510",
        "ConfigurationVersion": "8589934592"
      },
      "LsnOfLastBackupRecord": "246",
      "CreationTimeUtc": "2018-01-01T17:00:34Z",
      "FailureError": null
    }
  ]
}

Sdílet prostřednictvím

Získat seznam záloh aplikací

Žádost

Parametry

`applicationId`

`api-version`

`timeout`

`Latest`

`StartDateTimeFilter`

`EndDateTimeFilter`

`ContinuationToken`

`MaxResults`

Odpovědi

Příklady

Získání záloh aplikací v časovém rozsahu

Žádost

Odpověď: 200

Text

Získání nejnovější zálohy

Žádost

Odpověď: 200

Text

Omezit maximální počet výsledků

Žádost

Odpověď: 200

Text

Stránka pomocí pokračovacího tokenu

Žádost

Odpověď: 200

Text

Další materiály