返回一个传统备份快照
已弃用
返回指定项目中一个集群的一个传统备份快照。要使用此资源，请求的服务帐户或 API 密钥必须具有“项目只读”角色。自 2020 年 3 月 23 日起，所有新集群只能使用云备份。当您升级到 4.2 时，如果备份系统当前设置为传统备份，则它会升级到云备份。升级后，所有现有的传统备份快照仍然可用。它们会根据您的保留策略随时间的推移而过期。您的备份策略将重置为默认计划。如果您已为传统备份应用自定义备份策略，则必须按照云备份文档中概述的步骤重新创建该策略。
路径参数
-
用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。
注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。
格式应符合以下模式：
^([a-f0-9]{24})$。 -
用于标识集群的人类可读标签。
格式应符合以下模式：
^[a-zA-Z0-9][a-zA-Z0-9-]*$。 -
用于标识所需快照的唯一的 24 位十六进制数字字符串。
格式应符合以下模式：
^([a-f0-9]{24})$。
查询参数
-
指示应用程序是否将响应包装在
envelopeJSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。默认值为
false。 -
指示响应正文是否应采用 prettyprint 格式的标记。
默认值为
false。Prettyprint
GET /api/atlas/v2 /groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}
Atlas CLI
atlas api legacyBackup getGroupClusterSnapshot --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.GetGroupClusterSnapshotApiParams{}
sdkResp, httpResp, err := client.LegacyBackupApi.
GetGroupClusterSnapshotWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true"
响应示例 (200)
{
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"complete": true,
"created": {
"date": "2025-05-04T09:42:00Z",
"increment": 1199145600
},
"doNotDelete": true,
"expires": "2025-05-04T09:42:00Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"incremental": true,
"lastOplogAppliedTimestamp": {
"date": "2025-05-04T09:42:00Z",
"increment": 1199145600
},
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"parts": [
{
"clusterId": "32b6e34b3d91647abb20e7b8",
"completedTime": "2025-05-04T09:42:00Z",
"compressionSetting": "NONE",
"dataSizeBytes": 42,
"encryptionEnabled": true,
"fcv": "string",
"fileSizeBytes": 42,
"machineId": "string",
"masterKeyUUID": "string",
"mongodVersion": "string",
"replicaSetName": "string",
"replicaState": "string",
"storageSizeBytes": 42,
"typeName": "REPLICA_SET"
}
]
}
响应示例 (401)
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
响应示例 (403)
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
响应示例 (404)
{
"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"
}
响应示例 (500)
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}