- API >
- Public API Resources >
- Backup and Restore >
- Snapshot Schedule >
- Get the Snapshot Schedule
Get the Snapshot Schedule¶
On this page
Base URL: {opsManagerHost}:{port}
¶
Syntax¶
Request Parameters¶
Request Path Parameters¶
Parameter | Required/Optional | Description |
---|---|---|
GROUP-ID |
Required. | The unique identifier for the group that holds the cluster with the snapshot schedule you want to get. |
CLUSTER-ID |
Required. | The unique indentifier of the cluster whose snapshot schedule you want to get. |
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.
Name | Type | Description | Default |
---|---|---|---|
pageNum |
integer | Page number (1-based). | 1 |
itemsPerPage |
integer | Maximum number of items to return, up to a maximum of 100. | 100 |
pretty |
boolean | Display response in human-readable format. | false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response Elements¶
Name | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
groupId |
string | ID of the group that owns the backup configuration. | ||||||||||
clusterId |
string | ID of the cluster to which this backup configuration applies. | ||||||||||
snapshotIntervalHours |
number | Number of hours between snapshots. Supported values are 6 , 8 , 12 , and 24 . |
||||||||||
snapshotRetentionDays |
number | Number of days to keep recent snapshots. Supported values are 2 - 5 . |
||||||||||
clusterCheckpointIntervalMin |
number | Number of minutes between successive cluster checkpoints. This only
applies to sharded clusters. This number determines the granularity of
point-in-time restores for sharded clusters. Supported values are 15 , 30 , and 60 . |
||||||||||
dailySnapshotRetentionDays |
number | Number of days to retain daily snapshots. Supported values are 1 - 365 . |
||||||||||
weeklySnapshotRetentionWeeks |
number | Number of weeks to retain weekly snapshots. Supported values are 1 - 52 . |
||||||||||
monthlySnapshotRetentionMonths |
number | Number of months to retain monthly snapshots. Supported values are 1 - 36 . |
||||||||||
pointInTimeWindowHours |
number | Number of hours in the past for which a point-in-time snapshot can be created. | ||||||||||
referenceHourOfDay |
number | Hour of the day to schedule snapshots using a 24 hour clock.
Default value is 0 (midnight), and supported values are 0 - 23 . |
||||||||||
referenceMinuteOfHour |
number | Minute of the hour to schedule snapshots. Default value is 0
and supported values are 0 - 59 . |
||||||||||
referenceTimeZoneOffset |
string | The ISO-8601 timezone offset
where the Ops Manager host resides. To avoid problems with daylight
saving time, use UTC. The default is +0000 , which is equivalent
to UTC. Z is also a supported value and equivalent to UTC. |
||||||||||
links |
string array |
|