Získat seznam zálohování služebGet Service Backup List

Získá seznam záloh k dispozici pro každý oddíl v této službě.Gets the list of backups available for every partition in this service.

Vrátí seznam záloh, které jsou k dispozici pro každý oddíl v této službě Service Fabric.Returns a list of backups available for every partition in this Service Fabric service. Server vyjmenovává všechny zálohy, které jsou k dispozici v úložišti záloh nakonfigurovaných v zásadách zálohování.The server enumerates all the backups available in the backup store configured in the backup policy. Umožňuje také filtrování výsledku na základě počátečního a koncového data nebo pouze načítání nejnovější dostupné zálohy pro každý oddíl.It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.

ŽádostRequest

MetodaMethod Identifikátor URI žádostiRequest URI
GETGET /Services/{serviceId}/$/GetBackups?api-version=6.4&timeout={timeout}&Latest={Latest}&StartDateTimeFilter={StartDateTimeFilter}&EndDateTimeFilter={EndDateTimeFilter}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}

ParametryParameters

Name (Název)Name TypType Požaduje seRequired UmístěníLocation
serviceId řetězecstring AnoYes CestaPath
api-version řetězecstring AnoYes DotazQuery
timeout celé číslo (int64)integer (int64) NeNo DotazQuery
Latest Booleanboolean NeNo DotazQuery
StartDateTimeFilter řetězec (datum-čas)string (date-time) NeNo DotazQuery
EndDateTimeFilter řetězec (datum-čas)string (date-time) NeNo DotazQuery
ContinuationToken řetězecstring NeNo DotazQuery
MaxResults celé číslo (int64)integer (int64) NeNo DotazQuery

serviceId

Typ: řetězecType: string
Povinné: AnoRequired: Yes

Identita služby.The identity of the service. Toto ID je obvykle úplný název služby bez schématu IDENTIFIKÁTOR URI .)This ID is typically the full name of the service without the 'fabric:' URI scheme. Počínaje verzí 6.0 jsou hierarchické názvy odděleny znakem "~".Starting from version 6.0, hierarchical names are delimited with the "~" character. Například pokud název služby je "fabric:/myapp/app1/svc1", identita služby by "myapp~app1~svc1" v 6.0+ a "myapp/app1/svc1" v předchozích verzích.For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.


api-version

Typ: řetězecType: string
Povinné: AnoRequired: Yes
Výchozí :6.4Default: 6.4

Verze rozhraní API.The version of the API. Tento parametr je povinný a jeho hodnota musí být "6.4".This parameter is required and its value must be '6.4'.

Service Fabric REST API verze je založena na verzi runtime, ve kterém bylo rozhraní API zavedeno nebo bylo změněno.Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime podporuje více než jednu verzi rozhraní API.Service Fabric runtime supports more than one version of the API. Tato verze je nejnovější podporovanou verzí rozhraní API.This version is the latest supported version of the API. Pokud je předána nižší verze rozhraní API, vrácená odpověď se může lišit od odpovědi zdokumentované v této specifikaci.If a lower API version is passed, the returned response may be different from the one documented in this specification.

Modul runtime navíc přijímá všechny verze, která je vyšší než nejnovější podporovaná verze až po aktuální verzi modulu runtime.Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. Pokud je tedy nejnovější verze rozhraní API 6.0 a doba runtime je 6.1, runtime přijme verzi 6.1 pro toto rozhraní API.So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. Chování rozhraní API však bude podle zdokumentované verze 6.0.However the behavior of the API will be as per the documented 6.0 version.


timeout

Typ: celé číslo (int64)Type: integer (int64)
Povinné: NeRequired: No
Výchozí :60Default: 60
InclusiveMaximum:4294967295InclusiveMaximum: 4294967295
InclusiveMinimum:1InclusiveMinimum: 1

Časový rozsah serveru pro provedení operace v sekundách.The server timeout for performing the operation in seconds. Tento časový limit určuje dobu trvání, po kterou je klient ochoten čekat na dokončení požadované operace.This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. Výchozí hodnota tohoto parametru je 60 sekund.The default value for this parameter is 60 seconds.


Latest

Typ: logickáType: boolean
Povinné: NeRequired: No
Výchozí :falseDefault: false

Určuje, zda má být pro oddíl k dispozici pouze nejnovější záloha pro zadaný časový rozsah.Specifies whether to get only the most recent backup available for a partition for the specified time range.


StartDateTimeFilter

Typ: řetězec (datum-čas)Type: string (date-time)
Povinné: NeRequired: No

Zadejte počáteční čas data, od kterého chcete vytvořit výčet záloh ve formátu datetime.Specify the start date time from which to enumerate backups, in datetime format. Datum musí být zadáno ve formátu ISO8601.The date time must be specified in ISO8601 format. Toto je volitelný parametr.This is an optional parameter. Pokud není zadán, všechny zálohy od začátku jsou uvedeny.If not specified, all backups from the beginning are enumerated.


EndDateTimeFilter

Typ: řetězec (datum-čas)Type: string (date-time)
Povinné: NeRequired: No

Zadejte čas koncového data, do kterého chcete vytvořit výčet záloh ve formátu datetime.Specify the end date time till which to enumerate backups, in datetime format. Datum musí být zadáno ve formátu ISO8601.The date time must be specified in ISO8601 format. Toto je volitelný parametr.This is an optional parameter. Pokud není zadán, výčet se provádí až do poslední zálohy.If not specified, enumeration is done till the most recent backup.


ContinuationToken

Typ: řetězecType: string
Povinné: NeRequired: No

Parametr tokenu pokračování se používá k získání další sady výsledků.The continuation token parameter is used to obtain next set of results. Token pokračování s neprázdnou hodnotou je zahrnut v odpovědi rozhraní API, pokud se výsledky ze systému nevejdou do jediné odpovědi.A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. Když je tato hodnota předána dalšímu volání rozhraní API, rozhraní API vrátí další sadu výsledků.When this value is passed to the next API call, the API returns next set of results. Pokud neexistují žádné další výsledky, pak token pokračování neobsahuje hodnotu.If there are no further results, then the continuation token does not contain a value. Hodnota tohoto parametru by neměla být kódována adresou URL.The value of this parameter should not be URL encoded.


MaxResults

Typ: celé číslo (int64)Type: integer (int64)
Povinné: NeRequired: No
Výchozí :0Default: 0
InclusiveMinimum:0InclusiveMinimum: 0

Maximální počet výsledků, které mají být vráceny jako součást stránkovaných dotazů.The maximum number of results to be returned as part of the paged queries. Tento parametr definuje horní mez počtu vrácených výsledků.This parameter defines the upper bound on the number of results returned. Vrácené výsledky mohou 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.The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. Pokud je tento parametr nula nebo není zadán, stránkovaný dotaz obsahuje co nejvíce výsledků, které se vejdou do vrácené zprávy.If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.

OdezvyResponses

Stavový kód HTTPHTTP Status Code PopisDescription Schéma odpovědiResponse Schema
200 (OK)200 (OK) Úspěšná operace vrátí stavový kód 200 a stránkovaný seznam informací o zálohování.A successful operation will return 200 status code and a paged list of backup information.
Seznam PagedBackupInfoListPagedBackupInfoList
Všechny ostatní stavové kódyAll other status codes Podrobná odpověď na chybu.The detailed error response.
FabricErrorFabricError

PříkladyExamples

Získejte zálohy aplikací v časovém rozsahuGet application backups within a time range

Tento příklad ukazuje, jak získat seznam záloh služby v časovém rozsahu.This example shows how to get list of service backups within a time range.

ŽádostRequest

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

200 Odpověď200 Response

TěloBody
{
  "ContinuationToken": "",
  "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
    },
    {
      "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
    }
  ]
}

Získejte nejnovější zálohováníGet latest backup

Tento příklad ukazuje, jak získat nejnovější zálohu pro každý oddíl v rámci služby.This example shows how to get the latest backup for each partition within a service.

ŽádostRequest

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

200 Odpověď200 Response

TěloBody
{
  "ContinuationToken": "",
  "Items": [
    {
      "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": "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í výsledkyLimit maximum results

Tento příklad ukazuje, jak získat seznam záloh služby.This example shows how to get list of service backups. Počet výsledků na stránce je omezen na maximálně dva pomocí MaxResult parametr.The number of results in a page are limited to maximum of two using the MaxResult parameter.

ŽádostRequest

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

200 Odpověď200 Response

TěloBody
{
  "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í tokenu pokračováníPage using continuation token

Tento příklad ukazuje, jak získat seznam záloh služby.This example shows how to get list of service backups. Počet výsledků na stránce je omezen na maximálně dva pomocí MaxResult parametr.The number of results in a page are limited to maximum of two using the MaxResult parameter. Tento příklad používá ContinuationToken parametr.This example uses the ContinuationToken parameter. Hodnota tohoto parametru je k dispozici z předchozího dotazu; v tomto případě výše uvedený příklad.The value of this parameter is provided from the previous query; in this case the example shown above. Odpověď obsahuje zbývající výsledky a prázdný ContinuationToken.The response contains the remaining results and an empty ContinuationToken. Prázdný ContinuationToken označuje, že další výsledky nejsou k dispozici.The empty ContinuationToken indicates that additional results are not available.

ŽádostRequest

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

200 Odpověď200 Response

TěloBody
{
  "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
    }
  ]
}