Cloud Backup API, gRPC: PolicyService.Get
Get specific policy.
gRPC request
rpc Get (GetPolicyRequest) returns (Policy)
GetPolicyRequest
{
"policyId": "string"
}
Field |
Description |
policyId |
string Required field. Policy ID. |
Policy
{
"id": "string",
"name": "string",
"createdAt": "google.protobuf.Timestamp",
"updatedAt": "google.protobuf.Timestamp",
"enabled": "bool",
"settings": {
"compression": "Compression",
"format": "Format",
"multiVolumeSnapshottingEnabled": "bool",
"preserveFileSecuritySettings": "bool",
"reattempts": {
"enabled": "bool",
"interval": {
"type": "Type",
"count": "int64"
},
"maxAttempts": "int64"
},
"silentModeEnabled": "bool",
"splitting": {
"size": "int64"
},
"vmSnapshotReattempts": {
"enabled": "bool",
"interval": {
"type": "Type",
"count": "int64"
},
"maxAttempts": "int64"
},
"vss": {
"enabled": "bool",
"provider": "VSSProvider"
},
"archive": {
"name": "string"
},
"performanceWindow": {
"enabled": "bool"
},
"retention": {
"rules": [
{
"backupSet": [
"RepeatePeriod"
],
// Includes only one of the fields `maxAge`, `maxCount`
"maxAge": {
"type": "Type",
"count": "int64"
},
"maxCount": "int64"
// end of the list of possible fields
}
],
"beforeBackup": "bool"
},
"scheduling": {
"backupSets": [
{
// Includes only one of the fields `time`, `sinceLastExecTime`
"time": {
"weekdays": [
"Day"
],
"repeatAt": [
{
"hour": "int64",
"minute": "int64"
}
],
"repeatEvery": {
"type": "Type",
"count": "int64"
},
"timeFrom": {
"hour": "int64",
"minute": "int64"
},
"timeTo": {
"hour": "int64",
"minute": "int64"
},
"monthdays": [
"int64"
],
"includeLastDayOfMonth": "bool",
"months": [
"int64"
],
"type": "RepeatePeriod"
},
"sinceLastExecTime": {
"delay": {
"type": "Type",
"count": "int64"
}
},
// end of the list of possible fields
"type": "Type"
}
],
"enabled": "bool",
"maxParallelBackups": "int64",
"randMaxDelay": {
"type": "Type",
"count": "int64"
},
"scheme": "Scheme",
"weeklyBackupDay": "Day"
},
"cbt": "ChangedBlockTracking",
"fastBackupEnabled": "bool",
"quiesceSnapshottingEnabled": "bool"
},
"folderId": "string"
}
Field |
Description |
id |
string Required field. Policy ID. |
name |
string Required field. Policy name. |
createdAt |
|
updatedAt |
|
enabled |
bool If this field is true, it means that the policy is enabled. |
settings |
Set of policy settings |
folderId |
string ID of the folder that the policy belongs to. |
PolicySettings
Set of policy settings
Field |
Description |
compression |
enum Compression Required field. Archive compression level.
|
format |
enum Format Required field. Format of the Cyberprotect backup archive.
|
multiVolumeSnapshottingEnabled |
bool If true, snapshots of multiple volumes will be taken simultaneously. |
preserveFileSecuritySettings |
bool If true, the file security settings will be preserved. |
reattempts |
Required field. Configuration of retries on recoverable errors during the backup operations like reconnection to destination. No attempts to fix recoverable errors will be made if retry configuration is not set. |
silentModeEnabled |
bool If true, a user interaction will be avoided when possible. Equals to false if value is not specified. |
splitting |
Required field. Determines the size to split backups on. Splitting is not performed if value is not specified. |
vmSnapshotReattempts |
Required field. Configuration of retries on errors during the creation of the virtual machine snapshot. No attempts to fix recoverable errors will be made if retry configuration is not set. |
vss |
VolumeShadowCopyServiceSettings Required field. Settings for the Volume Shadow Copy Service (VSS) provider. If not set, no VSS provider is used. |
archive |
The archive properties. |
performanceWindow |
Required field. Time windows for performance limitations of backup and storage maintenance operations. |
retention |
Required field. Configuration of backup retention rules. |
scheduling |
Required field. Configuration of the backup schedule. |
cbt |
enum ChangedBlockTracking Required field. A configuration of Changed Block Tracking (CBT).
|
fastBackupEnabled |
bool If true, determines whether a file has changed by the file size and timestamp. Otherwise, the entire file contents are compared to those stored in the backup. |
quiesceSnapshottingEnabled |
bool If true, a quiesced snapshot of the virtual machine will be taken. |
RetriesConfiguration
Field |
Description |
enabled |
bool If true, enables retry on errors. |
interval |
Required field. An interval between retry attempts. |
maxAttempts |
int64 Max number of retry attempts. Operation will be considered as failed |
Interval
Field |
Description |
type |
enum Type Required field. A type of the interval.
|
count |
int64 The amount of value specified in |
Splitting
Field |
Description |
size |
int64 The size of split backup file in bytes. |
VolumeShadowCopyServiceSettings
Settings for Volume Shadow Copy Services which allows to notify
VSS-aware applications that backup is about to start. This will
ensure the consistent state of all data used by the applications.
Field |
Description |
enabled |
bool If true, the VSS will be enabled. |
provider |
enum VSSProvider Required field. A type of VSS provider to use in backup.
|
ArchiveProperties
Field |
Description |
name |
string The name of the generated archive. The name may use the following variables: |
PerformanceWindow
Field |
Description |
enabled |
bool If true, the time windows will be enabled. |
Retention
Field |
Description |
rules[] |
A list of retention rules. |
beforeBackup |
bool If true, retention rules will be applied before backup is finished. |
RetentionRule
Field |
Description |
backupSet[] |
enum RepeatePeriod A list of backup sets where rules are effective.
|
maxAge |
Includes only one of the fields |
maxCount |
int64 Includes only one of the fields |
Scheduling
Field |
Description |
backupSets[] |
A list of schedules with backup sets that compose the whole scheme. |
enabled |
bool If true, the backup schedule will be enabled. |
maxParallelBackups |
int64 Max number of backup processes allowed to run in parallel. Unlimited if not set. |
randMaxDelay |
Required field. Configuration of the random delay between the execution of parallel tasks. |
scheme |
enum Scheme Required field. A backup scheme. Available values:
|
weeklyBackupDay |
enum Day Required field. A day of week to start weekly backups.
|
BackupSet
Field |
Description |
time |
Includes only one of the fields |
sinceLastExecTime |
Includes only one of the fields |
type |
enum Type BackupSet type -- one of incr, full, differential or auto.
|
Time
Field |
Description |
weekdays[] |
enum Day Days in a week to perform a backup.
|
repeatAt[] |
Time to repeat the backup. |
repeatEvery |
Frequency of backup repetition. |
timeFrom |
The start time of the backup time interval. |
timeTo |
The end time of the backup time interval. |
monthdays[] |
int64 Days in a month to perform a backup. |
includeLastDayOfMonth |
bool If set to true, last day of month will activate |
months[] |
int64 Set of values. Allowed values form 1 to 12. |
type |
enum RepeatePeriod Required field. Possible types:
|
TimeOfDay
Field |
Description |
hour |
int64 Hours. |
minute |
int64 Minutes. |
SinceLastExecTime
Field |
Description |
delay |
Required field. The interval between backups. |