更新快照计划

注意

群组和项目是同义术语。您的 {PROJECT-ID} 与您的群组 ID（group ID）相同。对于现有群组，您的群组/项目 ID 保持不变。当引用说明时，此页面使用更为人熟知的术语“群组”。终结点保持不变，如文档中所述。

Resource

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

请求参数

请求路径参数

Parameter	类型	必要性	说明
`PROJECT-ID`	字符串	必需	包含具有要更新的快照计划的集群的项目的唯一标识符。
`CLUSTER-ID`	字符串	必需	要更新快照安排的集群的唯一标识符。

请求查询参数

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

名称	类型	必要性	说明	默认
pretty	布尔	Optional	指示是否以美观打印格式返回响应正文的标志。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。对于返回一个结果的端点，响应体包括： `status`： HTTP响应代码 `content`：预期响应正文	`false`

请求正文参数

名称	类型	必要性	说明
`clusterCheckpointIntervalMin`	数字	Optional	连续集群检查点之间的分钟数。这仅适用于分片集群。此数字决定了分片集群的时间点恢复粒度。您可以将值设置为`15` 、 `30`或`60` 。重要提示：您可以对运行MongoDB且 `Feature Compatibility Version` 为 4.0 或更早版本的集群使用检查点。检查点已从使用FCV 4.2 或更高版本的MongoDB实例中删除。
`clusterId`	字符串	Optional	应用此备份配置的集群的唯一标识符。
`dailySnapshotRetentionDays`	数字	Optional	保留每日快照的天数。您可以设置介于`1`和`365` （含）之间的值。将`dailySnapshotRetentionDays`设置为`0`将禁用此规则。
`fullIncrementalDayOfWeek`	字符串	Optional	Cloud Manager 拍摄完整快照的星期几。这可确保在最近进行完整备份。 Cloud Manager 将默认值设置为随机工作日。
`groupId`	字符串	Optional	拥有备份配置的项目的唯一标识符。
`links`	对象数组	Optional	指向子资源和/或相关资源的一个或多个链接。响应中的所有 `links` 数组至少包含一个名为 `self` 的链接。URL之间的关系在 Web 链接规范中进行了解释。
`monthlySnapshotRetentionMonths`	数字	Optional	保留月度快照的月数。您可以设置介于`1`和`36` （含）之间的值。将`monthlySnapshotRetentionMonths`设置为`0`将禁用此规则。
`snapshotIntervalHours`	数字	Optional	快照之间的小时数。可以设置的值包括 `6`、`8`、`12` 或 `24`。
`snapshotRetentionDays`	数字	Optional	保留最近快照的天数。可以设置介于 `2` 和 `5`（含 36）之间的值。
`weeklySnapshotRetentionWeeks`	数字	Optional	保留每周快照的周数。您可以设置介于`1`和`52` （含）之间的值。将`weeklySnapshotRetentionWeeks`设置为`0`将禁用此规则。

响应

名称	类型	说明
`clusterCheckpointIntervalMin`	数字	连续集群检查点之间的分钟数。这仅适用于分片集群。此数字决定了分片集群的时间点恢复粒度。 Cloud Manager 返回的值可能为`15` 、 `30`或`60` 。重要提示：您可以对运行MongoDB且 `Feature Compatibility Version` 为 4.0 或更早版本的集群使用检查点。检查点已从使用FCV 4.2 或更高版本的MongoDB实例中删除。
`clusterId`	字符串	应用此备份配置的集群的唯一标识符。
`dailySnapshotRetentionDays`	数字	保留每日快照的天数。Cloud Manager 可能返回`1`到`365` （含）之间的值。将`dailySnapshotRetentionDays`设置为`0`将禁用此规则。
`fullIncrementalDayOfWeek`	字符串	Cloud Manager 拍摄完整快照的星期几。这可确保在最近进行完整备份。 Cloud Manager 将默认值设置为随机工作日。
`groupId`	字符串	拥有备份配置的项目的唯一标识符。
`links`	对象数组	指向子资源和/或相关资源的一个或多个链接。响应中的所有 `links` 数组至少包含一个名为 `self` 的链接。URL之间的关系在 Web 链接规范中进行了解释。
`monthlySnapshotRetentionMonths`	数字	保留月度快照的月数。Cloud Manager 可能返回`1`到`36` （含）之间的值。将`monthlySnapshotRetentionMonths`设置为`0`将禁用此规则。
`pointInTimeWindowHours`	数字	可以创建时间点快照的过去小时数。您无法更改快照的此值。
`snapshotIntervalHours`	数字	快照之间的小时数。 Cloud Manager 可能会返回`6` 、 `8` 、 `12`或`24`的值。
`snapshotRetentionDays`	数字	保留最近快照的天数。Cloud Manager 可能返回`2`到`5` （含）之间的值。
`weeklySnapshotRetentionWeeks`	数字	保留每周快照的周数。Cloud Manager 可能返回`1`到`52` （含）之间的值。将`weeklySnapshotRetentionWeeks`设置为`0`将禁用此规则。

请求示例

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://cloud.mongodb.com/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 }

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://cloud.mongodb.com/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	}'

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	}