Yedekleme İlkesi Listesini Al
Yapılandırılan tüm yedekleme ilkelerini alır.
Yapılandırılan tüm yedekleme ilkelerinin listesini alın.
İstek
Yöntem | İstek URI'si |
---|---|
GET | /BackupRestore/BackupPolicies?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout} |
Parametreler
Ad | Tür | Gerekli | Konum |
---|---|---|---|
api-version |
string | Yes | Sorgu |
ContinuationToken |
dize | No | Sorgu |
MaxResults |
integer (int64) | No | Sorgu |
timeout |
integer (int64) | No | Sorgu |
api-version
Tür: dize
Gerekli: Evet
Varsayılan: 6.4
API'nin sürümü. Bu parametre gereklidir ve değeri '6.4' olmalıdır.
Service Fabric REST API sürümü, API'nin tanıtıldığı veya değiştirildiği çalışma zamanı sürümünü temel alır. Service Fabric çalışma zamanı API'nin birden fazla sürümünü destekler. Bu sürüm, API'nin desteklenen en son sürümüdür. Daha düşük bir API sürümü geçirilirse, döndürülen yanıt bu belirtimde belgelenen yanıttan farklı olabilir.
Ayrıca çalışma zamanı, çalışma zamanının geçerli sürümüne kadar desteklenen en son sürümden daha yüksek olan tüm sürümleri kabul eder. Dolayısıyla en son API sürümü 6.0 ve çalışma zamanı 6.1 ise çalışma zamanı bu API için 6.1 sürümünü kabul eder. Ancak API'nin davranışı, belgelenen 6.0 sürümüne göre olacaktır.
ContinuationToken
Tür: dize
Gerekli: Hayır
Devamlılık belirteci parametresi, sonraki sonuç kümesini almak için kullanılır. Sistemden alınan sonuçlar tek bir yanıta sığmadığında API'nin yanıtına boş olmayan bir değer içeren bir devamlılık belirteci eklenir. Bu değer bir sonraki API çağrısına geçirildiğinde, API bir sonraki sonuç kümesini döndürür. Başka sonuç yoksa, devamlılık belirteci bir değer içermez. Bu parametrenin değeri URL kodlanmış olmamalıdır.
MaxResults
Tür: tamsayı (int64)
Gerekli: Hayır
Varsayılan: 0
InclusiveMinimum: 0
Disk belleğine alınan sorguların bir parçası olarak döndürülecek en fazla sonuç sayısı. Bu parametre, döndürülen sonuç sayısı üzerindeki üst sınırı tanımlar. Döndürülen sonuçlar, yapılandırmada tanımlanan maksimum ileti boyutu kısıtlamalarına göre iletiye sığmamaları durumunda belirtilen en yüksek sonuçlardan küçük olabilir. Bu parametre sıfırsa veya belirtilmezse, sayfalanan sorgu dönüş iletisine sığacak kadar çok sonuç içerir.
timeout
Tür: tamsayı (int64)
Gerekli: Hayır
Varsayılan: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
İşlemi saniyeler içinde gerçekleştirmek için sunucu zaman aşımı. Bu zaman aşımı, istemcinin istenen işlemin tamamlanmasını beklemeye istekli olduğu süreyi belirtir. Bu parametre için varsayılan değer 60 saniyedir.
Yanıtlar
HTTP Durum Kodu | Description | Yanıt Şeması |
---|---|---|
200 (Tamam) | Başarılı bir işlem 200 durum kodu ve disk belleğine alınmış yedekleme ilkeleri listesi döndürür. |
PagedBackupPolicyDescriptionList |
Diğer tüm durum kodları | Ayrıntılı hata yanıtı. |
Doku Oluşturucu |
Örnekler
Maksimum sonuçları sınırla
Bu örnekte yedekleme ilkelerinin listesini alma işlemi gösterilmektedir. MaxResult parametresi kullanılarak sayfadaki sonuç sayısı en fazla dört ile sınırlıdır.
İstek
GET http://localhost:19080/BackupRestore/BackupPolicies?api-version=6.4&MaxResults=4
200 Yanıt
Gövde
{
"ContinuationToken": "FileShare10MinBackupPolicy",
"Items": [
{
"Name": "DailyAzureBackupPolicy",
"AutoRestoreOnDataLoss": false,
"MaxIncrementalBackups": "3",
"Schedule": {
"ScheduleKind": "TimeBased",
"ScheduleFrequencyType": "Daily",
"RunTimes": [
"0001-01-01T09:00:00Z",
"0001-01-01T17:00:00Z"
]
},
"Storage": {
"StorageKind": "AzureBlobStore",
"FriendlyName": "Azure_storagesample",
"ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<PutYourAccountKeyHere>",
"ContainerName": "BackupContainer"
},
"RetentionPolicy": {
"RetentionPolicyType": "Basic",
"MinimumNumberOfBackups": "30",
"RetentionDuration": "P29D"
}
},
{
"Name": "DailyAzureMIBackupPolicy",
"AutoRestoreOnDataLoss": false,
"MaxIncrementalBackups": "3",
"Schedule": {
"ScheduleKind": "TimeBased",
"ScheduleFrequencyType": "Daily",
"RunTimes": [
"0001-01-01T09:00:00Z",
"0001-01-01T17:00:00Z"
]
},
"Storage": {
"StorageKind": "ManagedIdentityAzureBlobStore",
"FriendlyName": "AzureMI_storagesample",
"BlobServiceUri": "https://managedidentitytest.blob.core.windows.net/",
"ContainerName": "BackupContainer",
"ManagedIdentityType": "Cluster"
},
"RetentionPolicy": {
"RetentionPolicyType": "Basic",
"MinimumNumberOfBackups": "30",
"RetentionDuration": "P29D"
}
},
{
"Name": "SampleDsmsBackupPolicy",
"AutoRestoreOnDataLoss": false,
"MaxIncrementalBackups": "3",
"Schedule": {
"ScheduleKind": "TimeBased",
"ScheduleFrequencyType": "Daily",
"RunTimes": [
"0001-01-01T09:00:00Z",
"0001-01-01T17:00:00Z"
]
},
"Storage": {
"StorageKind": "DsmsAzureBlobStore",
"FriendlyName": "DsmsAzure_storagesample",
"StorageCredentialsSourceLocation": "https://sample-dsms.dsms.core.winows.net/dsms/samplecredentiallocation/storageaccounts/samplestorageac/servicefabricbackup/samplebackup",
"ContainerName": "BackupContainer"
},
"RetentionPolicy": {
"RetentionPolicyType": "Basic",
"MinimumNumberOfBackups": "10",
"RetentionDuration": "P3M"
}
},
{
"Name": "FileShare10MinBackupPolicy",
"AutoRestoreOnDataLoss": false,
"MaxIncrementalBackups": "3",
"Schedule": {
"ScheduleKind": "FrequencyBased",
"Interval": "PT10M"
},
"Storage": {
"StorageKind": "FileShare",
"FriendlyName": "FileShare_myshare",
"Path": "\\\\myshare\\backupshare",
"PrimaryUserName": "backupaccount",
"PrimaryPassword": "****"
},
"RetentionPolicy": {
"RetentionPolicyType": "Basic",
"MinimumNumberOfBackups": "20",
"RetentionDuration": "P20D"
}
}
]
}
Devamlılık belirtecini kullanan sayfa
Bu örnekte yedekleme ilkelerinin listesini alma işlemi gösterilmektedir. MaxResult parametresi kullanılarak sayfadaki sonuç sayısı en fazla üç ile sınırlıdır. Bu örnekte ContinuationToken parametresi kullanılır. Bu parametrenin değeri önceki sorgudan sağlanır; bu durumda, yukarıda gösterilen örnek. Yanıt, kalan sonuçları ve boş bir ContinuationToken içerir. Boş ContinuationToken, ek sonuçların kullanılamadığını gösterir.
İstek
GET http://localhost:19080/BackupRestore/BackupPolicies?api-version=6.4&ContinuationToken=FileShare10MinBackupPolicy&MaxResults=3
200 Yanıt
Gövde
{
"ContinuationToken": "",
"Items": [
{
"AutoRestoreOnDataLoss": false,
"Name": "SampleBackupPolicy",
"MaxIncrementalBackups": "5",
"Schedule": {
"ScheduleKind": "FrequencyBased",
"Interval": "PT4H5M"
},
"Storage": {
"Path": "\\\\myshare\\BackupStore",
"PrimaryUserName": "myuser1",
"PrimaryPassword": "****",
"SecondaryUserName": "myuser2",
"SecondaryPassword": "****",
"StorageKind": "FileShare",
"FriendlyName": ""
},
"RetentionPolicy": {
"RetentionPolicyType": "Basic",
"MinimumNumberOfBackups": "0",
"RetentionDuration": "P20D"
}
}
]
}