Read
GET v1/protection_schedules
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsObjectName |
| description | NsDescription |
| volcoll_or_prottmpl_type | NsProtectionPolicyType |
| volcoll_or_prottmpl_id | NsObjectID |
| period | NsUnsignedLong |
| period_unit | NsPeriodUnit |
| at_time | NsTimeOfDay |
| until_time | NsTimeOfDay |
| days | NsDays |
| num_retain | NsUnsignedLong |
| downstream_partner_name | NsObjectName |
| downstream_partner_id | NsOptionalObjectID |
| upstream_partner_name | NsObjectName |
| upstream_partner_id | NsObjectID |
| replicate_every | NsUnsignedLong |
| num_retain_replica | NsUnsignedLong |
| repl_alert_thres | NsTime |
| snap_verify | NsBoolean |
| skip_db_consistency_check | NsBoolean |
| disable_appsync | NsBoolean |
| schedule_type | NsScheduleType |
| creation_time | NsTime |
| last_modified | NsTime |
| last_replicated_snapcoll_name | NsObjectName |
| last_replicated_snapcoll_id | NsObjectName |
| last_replicated_at_time | NsTime |
GET v1/protection_schedules/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsObjectName |
| description | NsDescription |
| volcoll_or_prottmpl_type | NsProtectionPolicyType |
| volcoll_or_prottmpl_id | NsObjectID |
| period | NsUnsignedLong |
| period_unit | NsPeriodUnit |
| at_time | NsTimeOfDay |
| until_time | NsTimeOfDay |
| days | NsDays |
| num_retain | NsUnsignedLong |
| downstream_partner_name | NsObjectName |
| downstream_partner_id | NsOptionalObjectID |
| upstream_partner_name | NsObjectName |
| upstream_partner_id | NsObjectID |
| replicate_every | NsUnsignedLong |
| num_retain_replica | NsUnsignedLong |
| repl_alert_thres | NsTime |
| snap_verify | NsBoolean |
| skip_db_consistency_check | NsBoolean |
| disable_appsync | NsBoolean |
| schedule_type | NsScheduleType |
| creation_time | NsTime |
| last_modified | NsTime |
| last_replicated_snapcoll_name | NsObjectName |
| last_replicated_snapcoll_id | NsObjectName |
| last_replicated_at_time | NsTime |
Description
List one or more protection schedules.
Normal Response Codes
200
HTTP Error Codes
400 401 403 404 500 503
Detail Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for protection schedule. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsObjectName | string | Name of snapshot schedule to create. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| description | NsDescription | string | Description of the schedule. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | |
| volcoll_or_prottmpl_type | NsProtectionPolicyType | string enum | Type of the protection policy this schedule is attached to. Valid values are protection_template and volume_collection. Possible values: 'protection_template', 'volume_collection'. | |
| volcoll_or_prottmpl_id | NsObjectID | string | Identifier of the protection policy (protection_template or volume_collection) in which this protection schedule is attached to. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| period | NsUnsignedLong | number | Repeat interval for snapshots with respect to the period_unit. For example, a value of 2 with the 'period_unit' of 'hours' results in one snapshot every 2 hours. Unsigned 64-bit integer. Example: 1234. | |
| period_unit | NsPeriodUnit | string enum | Time unit over which to take the number of snapshots specified in 'period'. For example, a value of 'days' with a 'period' of '1' results in one snapshot every day. Possible values: 'minutes', 'hours', 'days', 'weeks'. | |
| at_time | NsTimeOfDay | number | Time of day when snapshot should be taken. In case repeat frequency specifies more than one snapshot in a day then the until_time option specifies until what time of day to take snapshots. Non-negative integer in range [0,86399] which is equivalent to [0:00:00 AM, 23:59:59 PM]. | |
| until_time | NsTimeOfDay | number | Time of day to stop taking snapshots. Applicable only when repeat frequency specifies more than one snapshot in a day. Non-negative integer in range [0,86399] which is equivalent to [0:00:00 AM, 23:59:59 PM]. | |
| days | NsDays | string | Specifies which days snapshots should be taken. Comma separated list of days of the week or 'all'. Example: 'monday,sunday'. | |
| num_retain | NsUnsignedLong | number | Number of snapshots to retain. If replication is enabled on this schedule the array will always retain the latest replicated snapshot, which may exceed the specified retention value. This is necessary to ensure efficient replication performance. Unsigned 64-bit integer. Example: 1234. | |
| downstream_partner | NsObjectName | string | Specifies the partner name if snapshots created by this schedule should be replicated. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | Yes |
| downstream_partner_name | NsObjectName | string | Specifies the partner name if snapshots created by this schedule should be replicated. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| downstream_partner_id | NsOptionalObjectID | string | Specifies the partner ID if snapshots created by this schedule should be replicated. In an update operation, if snapshots should be replicated, set this attribute to the ID of the replication partner. If snapshots should not be replicated, set this attribute to the empty string. An optional NsObjectID. A 42 digit hexadecimal number or the empty string. Example: '1234123412341234123412341234123412341234cd' or ''. | |
| upstream_partner_name | NsObjectName | string | Specifies the partner name from which snapshots created by this schedule are replicated. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| upstream_partner_id | NsObjectID | string | Specifies the partner ID from which snapshots created by this schedule are replicated. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| replicate_every | NsUnsignedLong | number | Specifies which snapshots should be replicated. If snapshots are replicated and this option is not specified, every snapshot is replicated. Unsigned 64-bit integer. Example: 1234. | |
| num_retain_replica | NsUnsignedLong | number | Number of snapshots to retain on the replica. Unsigned 64-bit integer. Example: 1234. | |
| repl_alert_thres | NsTime | number | Replication alert threshold in seconds. If the replication of a snapshot takes more than this amount of time to complete an alert will be generated. Enter 0 to disable this alert. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| snap_verify | NsBoolean | boolean | Run verification tool on snapshot created by this schedule. This option can only be used with snapshot schedules of a protection template that has application synchronization. The tool used to verify snapshot depends on the type of application. For example, if application synchronization is VSS and the application ID is Exchange, eseutil tool is run on the snapshots. If verification fails, the logs are not truncated. Possible values: 'true', 'false'. | |
| skip_db_consistency_check | NsBoolean | boolean | Skip consistency check for database files on snapshots created by this schedule. This option only applies to snapshot schedules of a protection template with application synchronization set to VSS, application ID set to MS Exchange 2010 or later w/DAG, this schedule's snap_verify option set to yes, and its disable_appsync option set to false. Skipping consistency checks is only recommended if each database in a DAG has multiple copies. Possible values: 'true', 'false'. | |
| disable_appsync | NsBoolean | boolean | Disables application synchronized snapshots and creates crash consistent snapshots instead. Possible values: 'true', 'false'. | |
| schedule_type | NsScheduleType | string enum | Normal schedules have internal timers which drive snapshot creation. An externally driven schedule has no internal timers. All snapshot activity is driven by an external trigger. In other words, these schedules are used only for externally driven manual snapshots. Possible values: 'regular', 'external_trigger'. | |
| creation_time | NsTime | number | Time when this protection schedule was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified | NsTime | number | Time when this protection schedule was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_replicated_snapcoll_name | NsObjectName | string | Specifies the name of last replicated snapshot collection. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| last_replicated_snapcoll_id | NsObjectName | string | Specifies the snapshot collection ID of last replicated snapshot collection. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| last_replicated_at_time | NsTime | number | Time when last snapshot collection was replicatied. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_snap_time | NsTime | number | Time when last snapshot was taken. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| next_snap_time | NsTime | number | Time when next snapshot will be taken. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| next_repl_snap_time | NsTime | number | Time when next snapshot will be replicated. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| sched_owner_id | NsObjectID | string | Identifier of the group that owns this schedule. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| sched_owner_name | NsObjectName | string | Name of the group that owns this schedule. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. |
JSON Response
{
"data" : {
"num_retain_replica" : 0,
"skip_db_consistency_check" : false,
"num_retain" : 1,
"creation_time" : 1426776485,
"id" : "0c00000000000004d300000000000000000000001f",
"at_time" : 0,
"disable_appsync" : false,
"period" : 1,
"volcoll_or_prottmpl_id" : "0700000000000004d3000000000000000000000025",
"period_unit" : "days",
"repl_alert_thres" : 86400,
"downstream_partner" : "",
"upstream_partner" : "",
"last_modified" : 1426776485,
"name" : "testschedule",
"schedule_type" : "regular",
"description" : "",
"days" : "all",
"snap_verify" : false,
"volcoll_or_prottmpl_type" : "volume_collection",
"replicate_every" : 0,
"until_time" : 86399
}
}