返回所有旧版备份快照 已弃用

获取 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots

为指定项目中的一个集群返回所有传统备份快照。要使用此资源,请求的服务帐户或 API 密钥必须具有“项目只读”角色。自 2020 年 3 月 23 日起,所有新集群只能使用云备份。当您升级到 4.2 时,如果备份系统当前设置为传统备份,则它会升级到云备份。升级后,所有现有的传统备份快照仍然可用。它们会根据您的保留策略随时间的推移而过期。您的备份策略将重置为默认计划。如果您已为传统备份应用自定义备份策略,则必须按照云备份文档中概述的步骤重新创建该策略。

云备份文档

路径参数

  • groupId 字符串 必需

    用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。

    注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

    格式应符合以下模式:^([a-f0-9]{24})$

  • 集群名称 字符串 必需

    用于标识集群的人类可读标签。

    格式应符合以下模式:^[a-zA-Z0-9][a-zA-Z0-9-]*$

查询参数

  • envelope 布尔

    指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

    默认值为false

  • includeCount 布尔

    标志,用于指示响应是否返回响应中的列项总数 (totalCount)。

    默认值为true

  • itemsPerPage 整型

    响应每页返回的列项数。

    最小值为 1,最大值为 500。默认值为 100

  • pageNum 整型

    显示响应返回的当前总对象集的页面编号。

    最小值为 1。默认值为 1

  • pretty 布尔

    指示响应正文是否应采用 prettyprint 格式的标记。

    默认值为false

    Prettyprint
  • completed 字符串

    人类可读的标签,用于指定是否仅返回已完成、不完整或所有快照。默认情况下,MongoDB Cloud 只返回已完成的快照。

    值为 alltruefalse。默认值为 true

响应

  • 200 application/vnd.atlas.2023-01-01+json

    正常

    隐藏响应属性 显示响应属性 对象
    • 结果 大量[对象]

      MongoDB Cloud 在完成此请求时提供的返回文档列表。

      隐藏结果属性 显示结果属性 对象
      • clusterId 字符串

        唯一的 24-十六进制数字字符串,用于标识具有要返回的快照的集群。

        格式应符合以下模式:^([a-f0-9]{24})$

      • 集群名称 字符串

        用于标识集群的人类可读标签。

      • 完成 布尔

        指示快照是否存在的标志。当MongoDB Cloud 创建快照时,此标志返回 false

      • 已创建 对象

        BSON时间戳,指示oplog中的检查点令牌条目出现的时间。

        隐藏创建的属性 显示创建的属性 对象
        • 日期 string(date-time)

          oplog记录此数据库操作的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

        • 增量 integer(int32)

          oplog在特定日期和时间记录的数据库操作的顺序。

          最小值为 1199145600

      • doNotDelete 布尔

        标志,表示是否有人可以删除此快照。您不能在同一请求中设置 "doNotDelete" : true过期时间戳。

      • expires string(date-time)

        MongoDB Cloud 删除快照的日期和时间。如果为 "doNotDelete" : true,则 MongoDB Cloud 将删除为此参数设置的任何值。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

      • groupId 字符串

        唯一的 24-十六进制数字字符串,用于标识拥有快照的项目。

        格式应符合以下模式:^([a-f0-9]{24})$

      • id 字符串

        用于标识快照的唯一 24-十六进制数字字符串。

        格式应符合以下模式:^([a-f0-9]{24})$

      • 增量 布尔

        指示这是增量快照还是完整快照的标志。

      • lastOplogAppliedTimestamp 对象

        BSON时间戳,指示oplog中的检查点令牌条目出现的时间。

        隐藏 lastOplogAppliedTimestamp 属性 显示 lastOplogAppliedTimestamp 属性 对象
        • 日期 string(date-time)

          oplog记录此数据库操作的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

        • 增量 integer(int32)

          oplog在特定日期和时间记录的数据库操作的顺序。

          最小值为 1199145600

      • 零件 大量[对象]

        描述完整快照的元数据。

        • 对于副本集,此大量包含单个文档。
        • 对于分片集群,该大量包含每个分片的一份文档以及配置托管的一份文档。

        标识此快照的特征。

        隐藏零件属性 显示零件属性 对象
        • clusterId 字符串

          唯一的 24-十六进制数字字符串,用于标识具有要返回的快照的集群。

          格式应符合以下模式:^([a-f0-9]{24})$

        • completedTime string(date-time)

          快照完成的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

        • compressionSetting 字符串

          人类可读标签,用于标识快照的压缩方法。

          值为 NONEGZIP

        • dataSizeBytes integer(int64)

          集群中每个节点上存储的数据总大小。此参数以字节为单位表示其值。

        • EncryptionEnabled 布尔

          指示是否有人加密此快照的标志。

        • fcv 字符串

          一个数字,表示MongoDB Cloud 创建快照时副本集主节点 (primary node in the replica set)运行的MongoDB的特征兼容性版本。

        • fileSizeBytes integer(int64)

          表示数据文件总大小(以字节为单位)的数字。

        • 机器 ID 字符串

          指示MongoDB Cloud 在其上创建快照的节点的主机名和端口。

          格式应符合以下模式:^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$

        • masterKeyUUID string(uuid)

          标识用于加密快照数据的 Key Management Interoperability (KMIP) 主密钥的唯一字符串。当 "parts.encryptionEnabled" : true 时,资源返回此参数。

        • mongodVersion 字符串

          一个数字,表示MongoDB Cloud 创建快照时副本集主节点 (primary node in the replica set)运行的MongoDB版本。

          格式应符合以下模式:([\d]+\.[\d]+\.[\d]+)

        • ReplicaSetName 字符串

          用于标识副本集的人类可读标签。

        • replicaState 字符串

          快照进程开始时节点的角色。

        • storageSizeBytes integer(int64)

          指示为文档存储分配的空间总大小的数字。

        • typeName 字符串

          人类可读标签,用于标识MongoDB Cloud 从中拍摄此快照的服务器类型。

          取值为 REPLICA_SETCONFIG_SERVERCONFIG_SERVER_REPLICA_SETCONFIG_SHARD_REPLICA_SET

    • 总计数 integer(int32)

      可用文档总数。如果 includeCount设立为 false,MongoDB Cloud 会忽略此值。总数为估计值,可能不准确。

      最小值为 0

  • 401 application/json

    未经授权。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 403 application/json

    Forbidden.

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 404 application/json

    未找到。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 500 application/json

    内部服务器错误。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

GET /api/atlas/v2 /groups/{groupId}/clusters/{clusterName}/snapshots
atlas api legacyBackup listGroupClusterSnapshots --help
import (
	"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.ListGroupClusterSnapshotsApiParams{}
	sdkResp, httpResp, err := client.LegacyBackupApi.
		ListGroupClusterSnapshotsWithParams(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?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?pretty=true"
响应示例 (200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "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"
        }
      ]
    }
  ],
  "totalCount": 42
}
响应示例 (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"
}