Dapatkan Daftar Kebijakan Pencadangan

Mendapatkan semua kebijakan pencadangan yang dikonfigurasi.

Dapatkan daftar semua kebijakan pencadangan yang dikonfigurasi.

Minta

Metode	URI Permintaan
GET	/BackupRestore/BackupPolicies?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parameter

Nama	Jenis	Diperlukan	Lokasi
api-version	string	Ya	Kueri
ContinuationToken	string	Tidak	Kueri
MaxResults	bilangan bulat (int64)	Tidak	Kueri
timeout	bilangan bulat (int64)	Tidak	Kueri

---

api-version

Jenis: string
Diperlukan: Ya
Default: 6.4

Versi API. Parameter ini diperlukan dan nilainya harus '6.4'.

Versi REST API Service Fabric didasarkan pada versi runtime tempat API diperkenalkan atau diubah. Runtime Service Fabric mendukung lebih dari satu versi API. Versi ini adalah versi API terbaru yang didukung. Jika versi API yang lebih rendah diteruskan, respons yang dikembalikan mungkin berbeda dari yang di dokumentasikan dalam spesifikasi ini.

Selain itu, runtime menerima versi apa pun yang lebih tinggi dari versi terbaru yang didukung hingga versi runtime saat ini. Jadi, jika versi API terbaru adalah 6.0 dan runtime adalah 6.1, runtime akan menerima versi 6.1 untuk API tersebut. Namun perilaku API akan sesuai dengan versi 6.0 yang di dokumentasikan.

---

ContinuationToken

Jenis: string
Diperlukan: Tidak

Parameter token kelanjutan digunakan untuk mendapatkan serangkaian hasil berikutnya. Token kelanjutan dengan nilai tidak kosong disertakan dalam respons API ketika hasil dari sistem tidak sesuai dalam respons tunggal. Ketika nilai ini diteruskan ke panggilan API berikutnya, API mengembalikan serangkaian hasil berikutnya. Jika tidak ada hasil lebih lanjut, maka token kelanjutan tidak berisi nilai. Nilai parameter ini tidak boleh dikodekan URL.

---

MaxResults

Jenis: bilangan bulat (int64)
Diperlukan: Tidak
Default: 0
InclusiveMinimum: 0

Jumlah maksimum hasil yang akan dikembalikan sebagai bagian dari kueri halaman. Parameter ini menentukan batas atas pada jumlah hasil yang dikembalikan. Hasil yang dikembalikan dapat kurang dari hasil maksimum yang ditentukan jika tidak cocok dalam pesan berdasarkan pembatasan ukuran pesan maksimum yang ditentukan dalam konfigurasi. Jika parameter ini nol atau tidak ditentukan, kueri halaman mencakup hasil sebanyak mungkin yang cocok dalam pesan kembali.

---

timeout

Jenis: bilangan bulat (int64)
Diperlukan: Tidak
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Batas waktu server untuk melakukan operasi dalam hitungan detik. Batas waktu ini menentukan durasi waktu klien bersedia menunggu operasi yang diminta selesai. Nilai default untuk parameter ini adalah 60 detik.

Respons

Kode Status HTTP	Deskripsi	Skema Respons
200 (OK)	Operasi yang berhasil akan mengembalikan 200 kode status dan daftar halaman kebijakan pencadangan.	PagedBackupPolicyDescriptionList
Semua kode status lainnya	Respons kesalahan terperinci.	FabricError

Contoh

Batasi hasil maksimum

Contoh ini menunjukkan cara mendapatkan daftar kebijakan pencadangan. Jumlah hasil dalam halaman dibatasi hingga maksimum empat menggunakan parameter MaxResult.

Minta

GET http://localhost:19080/BackupRestore/BackupPolicies?api-version=6.4&MaxResults=4

Respons 200

Isi

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

Halaman menggunakan token kelanjutan

Contoh ini menunjukkan cara mendapatkan daftar kebijakan pencadangan. Jumlah hasil dalam halaman dibatasi hingga maksimum tiga menggunakan parameter MaxResult. Contoh ini menggunakan parameter ContinuationToken. Nilai parameter ini disediakan dari kueri sebelumnya; dalam hal ini contoh yang ditunjukkan di atas. Respons berisi hasil yang tersisa dan ContinuationToken kosong. ContinuationToken kosong menunjukkan bahwa hasil tambahan tidak tersedia.

Minta

GET http://localhost:19080/BackupRestore/BackupPolicies?api-version=6.4&ContinuationToken=FileShare10MinBackupPolicy&MaxResults=3

Respons 200

Isi

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