返回一个项目中的所有无服务器实例

获取 /api/atlas/v2/groups/{groupId}/serverless

返回指定项目中所有无服务器实例的详细信息。要使用此资源,请求的服务账户或 API 密钥必须具有“项目只读”角色。

此端点还列出使用 createServerlessInstance 端点创建的 Flex 集群或已迁移到 Flex 集群的前无服务器实例,直到2026 月,此后此端点将被停用。这些集群不支持连续备份,并且 serverlessContinuousBackupEnabled 将不会生效。请改用 listFlexClusters 端点。

listFlexClusters

路径参数

  • groupId 字符串 必需

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

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

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

查询参数

  • envelope 布尔

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

    默认值为false

  • includeCount 布尔

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

    默认值为true

  • itemsPerPage 整型

    响应每页返回的列项数。

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

  • pageNum 整型

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

    最小值为 1。默认值为 1

  • pretty 布尔

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

    默认值为false

    Prettyprint

响应

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

    正常

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

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

      用于配置MongoDB无服务器实例的一组设置。

      隐藏结果属性 显示结果属性 对象
      • 连接字符串(Connection Strings) 对象

        指向 MongoDB 数据库的统一资源定位符集合。

        连接字符串 URI 格式
        隐藏 connectionStrings 属性 显示 connectionStrings 属性 对象
        • privateEndpoint 大量[对象]

          私有端点感知连接字符串列表,可用于通过私有端点连接到此无服务器实例。仅当您为此无服务器实例创建了私有端点且该端点为 AVAILABLE(可用)时,此参数才会返回。

          私有端点连接字符串,可用于通过私有端点连接到此无服务器实例。

          隐藏 privateEndpoint 属性 显示 privateEndpoint 属性 对象
          • 端点 大量[对象]

            包含私有端点的列表,当您使用 connectionStrings.privateEndpoint[n].srvConnectionString 时,您通过这些端点连接到MongoDB Cloud。

            为此无服务器实例部署的私有端点的详细信息。

            隐藏端点属性 显示端点属性 对象
            • endpointId 字符串

              云提供商用于标识私有端点的唯一字符串。

            • 提供商名称 字符串

              部署私有端点的云提供商。

              值为 AWSAZURE

            • 区域 字符串

              部署私有端点的区域。

          • srvConnectionString 字符串

            私有端点感知连接字符串,使用 mongodb+srv://协议通过私有端点连接到MongoDB Cloud。 mongodb+srv协议指示驾驶员在域名系统 (DNS) 中查找主机的种子列表。

          • 类型 字符串

            应用程序连接的MongoDB进程类型。

            值为 MONGOS

        • standardSrv 字符串

          可用于连接到此无服务器实例的公共连接字符串。该连接字符串使用 mongodb+srv://协议。

          连接字符串 URI 格式
      • createdate string(date-time)

        MongoDB Cloud 创建此无服务器实例的日期和时间。MongoDB Cloud 以 UTC 格式的 ISO 8601 表示此时间戳。

      • groupId 字符串

        唯一的 24 位十六进制字符串,用于标识项目。

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

      • id 字符串

        唯一的 24-十六进制数字字符串,用于标识无服务器实例。

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

      • MongoDB 版本 字符串

        无服务器实例运行的MongoDB版本。

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

      • 名称 字符串

        用于标识无服务器实例的人类可读标签。

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

      • providerSettings 对象 必需

        云提供商设置群组,用于配置预配的 MongoDB 无服务器实例。

        隐藏 providerSettings 属性 显示 providerSettings 属性 对象
        • backingProviderName 字符串 必需

          MongoDB Cloud 在其上预配无服务器实例的云服务提供商。

          值为 AWSAZUREGCP

        • validDiskSizeGBLimit integer(int32)

          实例数据卷的存储容量,以 GB 为单位。不可为无服务器集群或有效的 Flex 集群配置此值。

        • 有效实例大小名称 字符串

          集群可自动扩展的实例大小边界。

          以下之一:

          值为 M10M20M30M40M50M60M80M100M140M200M300R40R50R60R80R200R300R400R700M40_NVMEM50_NVMEM60_NVMEM80_NVMEM200_NVMEM400_NVME

          值为 M10M20M30M40M50M60M80M90M200R40R50R60R80R200R300R400M60_NVMEM80_NVMEM200_NVMEM300_NVMEM400_NVMEM600_NVME

          值为 M10M20M30M40M50M60M80M140M200M250M300M400R40R50R60R80R200R300R400R600

        • validProviderName 字符串

          MongoDB Cloud 在其上有效预配无服务器实例的云服务提供商。

        • 提供商名称 字符串

          用于标识云服务提供商的人类可读标签。

          值为 SERVERLESS。默认值为 SERVERLESS

        • regionName 字符串 必需

          人类可读标签,用于标识MongoDB无服务器实例的位置。您选择的地区可能会影响客户端访问数据库的网络延迟。有关地区名称的完整列表,请参阅 AWS GCP和Azure

      • serverlessBackupOptions 对象

        设置群组,用于配置无服务器备份。

        隐藏 serverlessBackupOptions 属性 显示 serverlessBackupOptions 属性 对象
        • serverlessContinuousBackupEnabled 布尔

          指示无服务器实例是否使用 Serverless Continuous Backup 的标志。如果此参数为false ,无服务器实例使用 Basic Backup(基本备份)。

          | 选项 |描述 | |---|---| |无服务器持续备份 | Atlas每六小时对无服务器实例中的数据拍摄一次增量快照,并允许您从过去 72小时内的选定时间点恢复数据。 Atlas还会拍摄每日快照并将这些快照保留35 天。要学习;了解更多信息,请参阅无服务器实例成本。 | |基本备份 | Atlas每六个小时对无服务器实例中的数据拍摄一次增量快照,并仅保留最新的两个快照。您可以免费使用此选项。 |

          默认值为true

      • stateName 字符串

        人类可读标签,指示Atlas控制平面在此集群上进行的任何当前活动。除 CREATING 和 DELETING 状态外,即使处于指示正在进行活动的状态,集群也应始终可用并具有主节点。

        • IDLE: Atlas没有对此集群进行任何更改,并且可以假定通过用户界面或API请求的所有更改都已应用。
        • CREATING:首次预配的集群会返回 CREATING 状态,直到准备好连接为止。在尝试连接之前,确保已配置IP访问列表和数据库用户。
        • UPDATING:正在执行通过用户界面、 API、 AutoScaling 或其他计划活动请求的更改。
        • DELETING:集群正在删除进程,即将被删除。
        • REPAIRING: Atlas控制平面正在使集群中的一个或多个节点恢复服务。其他节点应继续正常提供服务。

        取值为 IDLECREATINGUPDATINGDELETINGREPAIRING

      • 标记 大量[对象]

        包含长度在 1 到 255 个字符之间的键值对的列表,用于对无服务器实例进行标记和分类。

        用于标记和分类MongoDB Cloud组织、项目或集群的键值对。示例,environment : production

        Hide tags attributes 显示标签属性 对象
        • key 字符串 必需

          定义标签集的常量。 例如, environment : production标签中的environment

          最小长度为 1,最大长度为 255

        • 字符串 必需

          属于该标签集的变量。 例如, environment : production标签中的production

          最小长度为 1,最大长度为 255

      • terminationProtectionEnabled 布尔

        指示是否在无服务器实例上启用终止保护的标记。如果设置为 true,MongoDB Cloud 不会删除无服务器实例。如果设置为 false,MongoDB Cloud 将删除无服务器实例。

        默认值为false

    • 总计数 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 状态代码。

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

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

  • 409 application/json

    冲突。

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

      错误请求详情。

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

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

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

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

        • 字段 字符串 必需

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

    • 详细信息 字符串

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

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

  • 500 application/json

    内部服务器错误。

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

      错误请求详情。

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

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

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

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

        • 字段 字符串 必需

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

    • 详细信息 字符串

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

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

GET /API/Atlas/v2/groups/{groupId}/ 无服务器
atlas api serverlessInstances listGroupServerlessInstances --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.ListGroupServerlessInstancesApiParams{}
	sdkResp, httpResp, err := client.ServerlessInstancesApi.
		ListGroupServerlessInstancesWithParams(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}/serverless?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}/serverless?pretty=true"
响应示例 (200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "connectionStrings": {
        "privateEndpoint": [
          {
            "endpoints": [
              {
                "endpointId": "string",
                "providerName": "AWS",
                "region": "string"
              }
            ],
            "srvConnectionString": "string",
            "type": "MONGOS"
          }
        ],
        "standardSrv": "string"
      },
      "createDate": "2025-05-04T09:42:00Z",
      "groupId": "32b6e34b3d91647abb20e7b8",
      "id": "32b6e34b3d91647abb20e7b8",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "mongoDBVersion": "string",
      "name": "string",
      "providerSettings": {
        "backingProviderName": "AWS",
        "effectiveDiskSizeGBLimit": 42,
        "": "M10",
        "effectiveProviderName": "string",
        "providerName": "SERVERLESS",
        "regionName": "string"
      },
      "serverlessBackupOptions": {
        "serverlessContinuousBackupEnabled": true
      },
      "stateName": "IDLE",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "terminationProtectionEnabled": false
    }
  ],
  "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"
}
响应示例 (409)
{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}
响应示例 (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"
}