更新一个集群的快照计划
已弃用
更新指定项目中一个集群的快照计划。要使用此资源，请求的服务帐户或 API 密钥必须具有“项目所有者”角色。
自 232020 3 月起，所有新集群只能使用云备份。当您升级到 4.2 时，如果您的备份系统当前设立为 传统备份，则它会升级到云备份。升级后，所有现有的传统备份快照仍然可用。它们会根据您的保留策略随时间推移而过期。您的备份策略将重置为默认安排。如果您在传统备份中使用了自定义备份策略，则必须按照云备份文档中概述的程序重新创建该策略。
路径参数
-
用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。
注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。
格式应符合以下模式：
^([a-f0-9]{24})$。 -
人类可读标签，标识具有待返回的快照的集群。
格式应符合以下模式：
^[a-zA-Z0-9][a-zA-Z0-9-]*$。
查询参数
-
指示应用程序是否将响应包装在
envelopeJSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。默认值为
false。 -
指示响应正文是否应采用 prettyprint 格式的标记。
默认值为
false。Prettyprint
body
必需
更新指定项目中一个集群的快照计划。
-
连续集群检查点之间的时间量（以分钟为单位）。此参数仅适用于分片集群。此数字决定了分片集群的连续云备份粒度。
值为
15、30或60。 -
唯一的 24 位十六进制数字字符串，用于标识要返回的快照的集群。
格式应符合以下模式：
^([a-f0-9]{24})$。 -
保留每日快照的时间量。MongoDB Cloud 以天为单位表示此值。将此值设置为
0以禁用每日快照保留。值为
0、3、4、5、6、7、15、30、60、90、120、180、或360。 -
MongoDB Cloud 必须保留每月快照的月数。将此值设置为
0以禁用每月快照保留。值为
0、1、2、3、4、5、6、7、8、9、10、11、12、13、18、24或36。 -
MongoDB Cloud 可以创建连续云备份快照的当前时间之前的小时数。
-
在拍摄另一个快照之前必须经过的小时数。
取值为
6、8、12或24。 -
MongoDB Cloud 必须保留最近快照的天数。
取值为
2、3、4或5。 -
MongoDB Cloud 必须保留每周快照的周数。将此值设置为
0以禁用每周快照保留。值为
0、1、2、3、4、5、6、7、8、12、16、20、24或52。
atlas api legacyBackup updateGroupClusterSnapshotSchedule --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.UpdateGroupClusterSnapshotScheduleApiParams{}
sdkResp, httpResp, err := client.LegacyBackupApi.
UpdateGroupClusterSnapshotScheduleWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \
-d '{ <Payload> }'{
"clusterCheckpointIntervalMin": 15,
"clusterId": "32b6e34b3d91647abb20e7b8",
"dailySnapshotRetentionDays": 0,
"monthlySnapshotRetentionMonths": 0,
"pointInTimeWindowHours": 42,
"snapshotIntervalHours": 6,
"snapshotRetentionDays": 2,
"weeklySnapshotRetentionWeeks": 0
}{
"clusterCheckpointIntervalMin": 15,
"clusterId": "32b6e34b3d91647abb20e7b8",
"dailySnapshotRetentionDays": 0,
"groupId": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"monthlySnapshotRetentionMonths": 0,
"pointInTimeWindowHours": 42,
"snapshotIntervalHours": 6,
"snapshotRetentionDays": 2,
"weeklySnapshotRetentionWeeks": 0
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}