Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/
API
/
资源
/
备份和恢复
/
快照计划

更新快照计划

在此页面上

  • Resource
  • 请求参数
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

注意

注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。

Resource

PATCH /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule

请求参数

请求路径参数

Parameter
类型
必要性
说明

PROJECT-ID

字符串

必需

包含具有要更新的快照计划的集群的项目的唯一标识符。

CLUSTER-ID

字符串

必需

要更新快照安排的集群的唯一标识符。

请求查询参数

以下查询参数为可选参数：

名称
类型
必要性
说明
默认

pretty

布尔

Optional

指示响应正文是否应采用 Prettyprint 的标志 格式。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称
说明

状态

HTTP 响应代码

envelope

预期响应正文

false

请求正文参数

名称
类型
必要性
说明

clusterCheckpointIntervalMin

数字

Optional

连续集群检查点之间的分钟数。 这仅适用于分片集群。 此数字决定了分片集群的时间点恢复粒度。 您可以将值设置为15 、 30或60 。

重要

您可以对运行功能兼容性版本为4.0或更早版本的 MongoDB 的集群使用检查点。 检查点已从FCV为4.2或更高版本的 MongoDB 实例中删除。

clusterId

字符串

Optional

应用此备份配置的集群的唯一标识符。

dailySnapshotRetentionDays

数字

Optional

保留每日快照的天数。您可以设置介于1和365 （含）之间的值。

注意

将dailySnapshotRetentionDays设置为0将禁用此规则。

fullIncrementalDayOfWeek

字符串

Optional

Ops Manager 拍摄完整快照的星期几。这可确保在最近进行完整备份。 Ops Manager 将默认值设置为 SUNDAY 。

groupId

字符串

Optional

拥有备份配置的项目的唯一标识符。

links

对象数组

Optional

指向子资源和/或相关资源的一个或多个链接。 响应中的所有links数组至少包含一个名为self的链接。 URL 之间的关系在 Web 链接规范中进行了解释。

monthlySnapshotRetentionMonths

数字

Optional

保留月度快照的月数。您可以设置介于1和36 （含）之间的值。

注意

将monthlySnapshotRetentionMonths设置为0将禁用此规则。

pointInTimeWindowHours

数字

Optional

可以创建点快照的过去小时数。

referenceHourOfDay

数字

Optional

使用 24 小时制安排快照的时间。 您可以设置介于0和23 （含）之间的值。

referenceMinuteOfHour

数字

Optional

安排快照的小时中的分钟。 您可以设置介于0和59 （含）之间的值。

referenceTimeZoneOffset

字符串

Optional

ISO-8601 时区偏移量 MongoDB Ops Manager主机所在的位置。为避免夏令时问题，请使用UTC 。 默认值为+0000 ，相当于UTC 。 Z也是一个支持的值，相当于UTC 。

Ops Manager 会在存储之前将+0000以外的任何偏移转换为+0000 ，并相应地调整referenceHourOfDay值。

例子

您传入一个请求，其中referenceHourOfDay为5 ， referenceTimeZoneOffset为"+0200". |onprem| stores a ``referenceHourOfDay的3 ， referenceTimeZoneOffset为"+0000" 。

snapshotIntervalHours

数字

Optional

快照之间的小时数。可以设置的值包括 6、8、12 或 24。

snapshotRetentionDays

数字

Optional

保留最近快照的天数。可以设置介于 2 和 5（含 36）之间的值。

weeklySnapshotRetentionWeeks

数字

Optional

保留每周快照的周数。您可以设置介于1和52 （含）之间的值。

注意

将weeklySnapshotRetentionWeeks设置为0将禁用此规则。

响应

名称
类型
说明

clusterCheckpointIntervalMin

数字

连续集群检查点之间的分钟数。 这仅适用于分片集群。 此数字决定了分片集群的时间点恢复粒度。 Ops Manager 可能返回15 、 30或60的值。

重要

您可以对运行功能兼容性版本为4.0或更早版本的 MongoDB 的集群使用检查点。 检查点已从FCV为4.2或更高版本的 MongoDB 实例中删除。

clusterId

字符串

应用此备份配置的集群的唯一标识符。

dailySnapshotRetentionDays

数字

保留每日快照的天数。Ops Manager 可能返回1和365 （含）之间的值。

注意

将dailySnapshotRetentionDays设置为0将禁用此规则。

fullIncrementalDayOfWeek

字符串

Ops Manager 撷取完整快照的星期几。这样可以确保始终在近期进行完整备份。 Ops Manager 会将默认值设置为 SUNDAY。

groupId

字符串

拥有备份配置的项目的唯一标识符。

links

对象数组

指向子资源和/或相关资源的一个或多个链接。 响应中的所有links数组至少包含一个名为self的链接。 URL 之间的关系在 Web 链接规范中进行了解释。

monthlySnapshotRetentionMonths

数字

保留月度快照的月数。Ops Manager 可能返回1和36 （含）之间的值。

注意

将monthlySnapshotRetentionMonths设置为0将禁用此规则。

pointInTimeWindowHours

数字

可以创建点快照的过去小时数。

referenceHourOfDay

数字

使用 24 小时制安排快照的时间。 Ops Manager 可能返回0和23 （含）之间的值。

referenceMinuteOfHour

数字

安排快照的小时中的分钟。 Ops Manager 可能返回0和59 （含）之间的值。

referenceTimeZoneOffset

字符串

ISO-8601 时区偏移量 MongoDB Ops Manager主机所在的位置。为避免夏令时问题，请使用UTC 。 默认值为+0000 ，相当于UTC 。 Z也是一个支持的值，相当于UTC 。

Ops Manager 会在存储之前将+0000以外的任何偏移转换为+0000 ，并相应地调整referenceHourOfDay值。

例子

您传入一个请求，其中referenceHourOfDay为5 ， referenceTimeZoneOffset为"+0200". |onprem| stores a ``referenceHourOfDay的3 ， referenceTimeZoneOffset为"+0000" 。

snapshotIntervalHours

数字

快照之间的小时数。 Ops Manager 可能返回6 、 8 、 12或24的值。

snapshotRetentionDays

数字

保留最近快照的天数。Ops Manager 可能返回2和5 （含）之间的值。

weeklySnapshotRetentionWeeks

数字

保留每周快照的周数。Ops Manager 可能返回1和52 （含）之间的值。

注意

将weeklySnapshotRetentionWeeks设置为0将禁用此规则。

请求示例

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule" \
6     --data '
7       {
8         "fullIncrementalDayOfWeek":"TUESDAY"
9         "snapshotIntervalHours": 8,
10         "dailySnapshotRetentionDays": 15,
11         "monthlySnapshotRetentionMonths": 6
12       }'

响应示例

响应标头

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

1{
2  "clusterId" : "{CLUSTER-ID}",
3  "dailySnapshotRetentionDays" : 15,
4  "fullIncrementalDayOfWeek":"TUESDAY",
5  "groupId" : "{PROJECT-ID}",
6  "links" : [],
7  "monthlySnapshotRetentionMonths" : 6,
8  "pointInTimeWindowHours": 24,
9  "snapshotIntervalHours" : 8,
10  "snapshotRetentionDays" : 2,
11  "weeklySnapshotRetentionWeeks" : 4
12}

后退

获取时间表

来年

快照