MongoDB Atlas Administration API 2.0
  • 2025-03-12（最新）
  • 2025-02-19
  • 2024-11-13
  • 2024-10-23
  • 2024-08-05
  • 2024-05-30
  • 2023-11-15
  • 2023-10-01
  • 2023-02-01
  • 2023-01-01
Redocly 提供的 API 文档

MongoDB Atlas 管理 API (2.0)

资源版本 2025-03-12

下载 OpenAPI 规范：下载

许可证：CC BY-NC-SA 3.0 US 服务条款

MongoDB Atlas Administration API 允许开发者管理 MongoDB Atlas 中的所有组件。

Atlas Administration API 使用 HTTP 摘要式身份验证来对请求进行身份验证。在构造 HTTP 请求时，提供编程式 API 公钥和相应的私钥作为用户名和密码。例如，要使用 cURL 返回数据库访问历史记录，请在终端运行以下命令：

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"

要了解更多信息，请参阅 Atlas Administration API 入门。如需支持，请参阅 MongoDB 支持。

您还可以通过 MongoDB 的 Postman 工作区中的 Atlas Administration API 浏览各种可用的端点。

访问跟踪

返回对 Atlas 数据库部署进行的身份验证尝试的访问日志。要查看数据库访问历史记录，您必须具有“项目所有者”或“组织所有者”角色。

使用集群名称返回一个集群的数据库访问历史记录

返回由集群名称标识的一个集群的访问权限日志。 访问日志包含针对集群发出的身份验证请求的列表。 您不能在租户层集群（M0、M2、M5）上使用此功能。 要使用此资源，请求的API密钥必须具有项目监控管理员角色或项目数据库访问管理员角色。

数据库访问历史记录
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

authResult
布尔

指示响应是否仅返回成功的身份验证尝试的标记。

end
整型 <int64>

停止检索数据库历史记录的日期和时间。如果指定结束，则必须同时指定开始。此参数使用 UNIX 纪元时间（毫秒）。

IP 地址
字符串^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

尝试通过数据库进行身份验证的一个 Internet 协议地址。

nLogs
整型 <int32> [ 0 .. 20000 ]
默认： 20000

日志中要返回的最大行数。

开始
整型 <int64>

MongoDB Cloud 开始检索数据库历史记录的日期和时间。如果指定开始，则必须同时指定结束。此参数使用 UNIX 纪元时间（毫秒）。

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "accessLogs": [
    ]
}

使用主机名返回一个集群的数据库访问历史记录

返回由集群主机名标识的一个集群的访问权限日志。 访问日志包含针对集群发出的身份验证请求的列表。 您不能在租户层集群（M0、M2、M5）上使用此功能。 要使用此资源，请求的API密钥必须具有项目监控管理员角色或项目数据库访问管理员角色。

数据库访问历史记录
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

主机名
必需
字符串

存储要下载的日志文件的 MongoDB 主机的完全限定域名或 IP 地址。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

authResult
布尔

指示响应是否仅返回成功的身份验证尝试的标记。

end
整型 <int64>

停止检索数据库历史记录的日期和时间。如果指定结束，则必须同时指定开始。此参数使用 UNIX 纪元时间（毫秒）。

IP 地址
字符串^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

尝试通过数据库进行身份验证的一个 Internet 协议地址。

nLogs
整型 <int32> [ 0 .. 20000 ]
默认： 20000

日志中要返回的最大行数。

开始
整型 <int64>

MongoDB Cloud 开始检索数据库历史记录的日期和时间。如果指定开始，则必须同时指定结束。此参数使用 UNIX 纪元时间（毫秒）。

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "accessLogs": [
    ]
}

警报配置

返回和编辑触发警报的条件以及 MongoDB Cloud 通知用户的方式。该集合仍在修订中，可能会有变动。

获取所有警报配置匹配器字段名称

创建或更新“警报配置”时，获取 matchers.fieldName 参数接受的所有字段名称。您可以使用任何指定角色成功调用该端点。

授权：
DigestAuth服务账户
查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
[
  • "APPLICATION_ID"
]

返回一个项目的所有警报配置

返回一个项目的所有警报配置。这些警报配置适用于项目中的任何组件。警报配置定义了警报的触发器和通知方法。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

此资源仍在修订中，可能会有变动。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

在一个项目中创建一项警报配置

创建指定项目中的一个警报配置。警报配置定义了警报的触发器和通知方法。要使用此资源，请求的 API 密钥必须具有组织所有者或项目所有者角色。

此资源仍在修订中，可能会有变动。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

为指定项目创建一个警报配置。

以下其中之一
enabled
布尔
默认： false

指示是否有人为指定项目启用此警报配置的标志。

必需
账单事件类型（对象）或 Cps 备份事件类型（对象）或数据保护事件类型（对象）或 FTS 索引审核类型（对象）或群组事件类型（对象）或 NDS 审核类型（对象）或 NDS 维护窗口审核类型（对象）或在线存档事件类型（对象）或用户事件类型（对象）或资源事件类型（对象）或流处理器事件类型（对象）或 NDS Auto Scaling 审核类型（对象）

触发此警报的事件。

数组 对象 （匹配器）

目标资源的匹配条件。

必需
数组 Datadog 通知（对象）或电子邮件通知（对象）或组通知（对象）或 HipChat 通知（对象）或 Microsoft Teams 通知（对象）或 OpsGenie 通知（对象）或 Org 通知（对象）或 PagerDuty 通知（对象）或 Slack 通知（对象）或 SMS 通知（对象）或团队通知（对象）或用户通知（对象）或 VictorOps 通知（对象）或 Webhook 通知（对象） (AlertsNotificationRootForGroup)

包含 MongoDB Cloud 发送通知的目标的列表。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "matchers": [
    ],
  • "notifications": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "updated": "2019-08-24T14:15:22Z"
}

删除一个项目的一项警报配置

从指定项目中删除一个警报配置。要使用此资源，请求的 API 密钥必须具有组织所有者或项目所有者角色。

此资源仍在修订中，可能会有变动。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

alertConfigId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

用于标识警报配置的唯一 24 位十六进制数字字符串。使用 /alertConfigs 端点检索已经过身份验证的用户有权访问的所有警报配置。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "reason": "Unauthorized"
}

从一个项目返回一项警报配置

从指定项目中返回指定的警报配置。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

此资源仍在修订中，可能会有变动。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

alertConfigId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

用于标识警报配置的唯一 24 位十六进制数字字符串。使用 /alertConfigs 端点检索已经过身份验证的用户有权访问的所有警报配置。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "updated": "2019-08-24T14:15:22Z"
}

在一个项目中切换一项警报配置的一种状态

启用或禁用指定项目中的指定警报配置。如果当前已启用，则该资源将启用指定的警报配置。如果当前已禁用，则该资源将禁用指定的警报配置。要使用此资源，请求的 API 密钥必须具有“组织所有者”或“项目所有者”角色。

注意：该端点仅更新警报配置的启用/禁用状态。如果要更新的不只是此配置，请参阅更新一项警报配置。

此资源仍在修订中，可能会有变动。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

alertConfigId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

唯一的 24 位十六进制数字字符串，用于标识触发此警报的警报配置。使用 /alertConfigs 端点检索已经过身份验证的用户有权访问的所有警报配置。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

启用或禁用指定项目中的指定警报配置。

enabled
布尔

标志，用于指示是否启用或禁用指定项目中的指定警报配置。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "updated": "2019-08-24T14:15:22Z"
}

更新一个项目的一项警报配置

更新指定项目中的一个警报配置。警报配置定义了警报的触发器和通知方法。要使用此资源，请求的 API 密钥必须具有组织所有者或项目所有者角色。

注意：如需启用或禁用警报配置，请参阅“切换单个项目中单个警报配置的单个状态”。

此资源仍在修订中，可能会有变动。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

alertConfigId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

用于标识警报配置的唯一 24 位十六进制数字字符串。使用 /alertConfigs 端点检索已经过身份验证的用户有权访问的所有警报配置。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

更新指定项目中的一个警报配置。

以下其中之一
enabled
布尔
默认： false

指示是否有人为指定项目启用此警报配置的标志。

必需
账单事件类型（对象）或 Cps 备份事件类型（对象）或数据保护事件类型（对象）或 FTS 索引审核类型（对象）或群组事件类型（对象）或 NDS 审核类型（对象）或 NDS 维护窗口审核类型（对象）或在线存档事件类型（对象）或用户事件类型（对象）或资源事件类型（对象）或流处理器事件类型（对象）或 NDS Auto Scaling 审核类型（对象）

触发此警报的事件。

数组 对象 （匹配器）

目标资源的匹配条件。

必需
数组 Datadog 通知（对象）或电子邮件通知（对象）或组通知（对象）或 HipChat 通知（对象）或 Microsoft Teams 通知（对象）或 OpsGenie 通知（对象）或 Org 通知（对象）或 PagerDuty 通知（对象）或 Slack 通知（对象）或 SMS 通知（对象）或团队通知（对象）或用户通知（对象）或 VictorOps 通知（对象）或 Webhook 通知（对象） (AlertsNotificationRootForGroup)

包含 MongoDB Cloud 发送通知的目标的列表。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "matchers": [
    ],
  • "notifications": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "updated": "2019-08-24T14:15:22Z"
}

返回为一个警报设置的所有警报配置

返回为指定警报设置的所有警报配置。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

此资源仍在修订中，可能会有变动。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

alertId
必需
字符串^([a-f0-9]{24})$

用于标识警报的唯一的 24 位十六进制数字字符串。使用 /alerts 端点检索经过身份验证的用户有权访问的所有警报。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

警报

返回并确认 MongoDB Cloud 根据您定义的警报条件触发的警报。该集合仍在修订中，可能会有变动。

返回所有打开的警报以进行警报配置

返回指定警报配置触发的所有未处理警报。这些警报配置仅适用于指定项目。警报配置定义了警报的触发条件和通知方法。未处理警报是指已被触发但仍未得到确认的警报。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

此资源仍在修订中，可能会有变动。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

alertConfigId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

用于标识警报配置的唯一 24 位十六进制数字字符串。使用 /alertConfigs 端点检索已经过身份验证的用户有权访问的所有警报配置。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

从一个项目返回所有警报

返回所有警报。这些警报适用于一个项目中的所有组件。当受监控的组件达到或超过设置的值时，您会收到警报。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

此资源仍在修订中，可能会有变动。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

pretty
布尔
默认： false
示例： pretty=false

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

状态
字符串
枚举： "OPEN" "TRACKING" "Closed"

要返回的警报的状态。如果省略，将返回所有状态下的全部警报。

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

从一个项目返回一项警报

返回一个警报。该警报适用于一个项目中的任何组件。当受监控的组件达到或超过设置的值时，您会收到警报。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

此资源仍在修订中，可能会有变动。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

alertId
必需
字符串^([a-f0-9]{24})$

用于标识警报的唯一的 24 位十六进制数字字符串。使用 /alerts 端点检索经过身份验证的用户有权访问的所有警报。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "acknowledgedUntil": "2019-08-24T14:15:22Z",
  • "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
  • "acknowledgingUsername": "user@example.com",
  • "alertConfigId": "32b6e34b3d91647abb20e7b8",
  • "created": "2019-08-24T14:15:22Z",
  • "eventTypeName": "DEPLOYMENT_FAILURE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastNotified": "2019-08-24T14:15:22Z",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "resolved": "2019-08-24T14:15:22Z",
  • "status": "OPEN",
  • "updated": "2019-08-24T14:15:22Z"
}

确认来自一个项目的一个警报

确认收到一个现有警报。该警报适用于一个项目中的任何组件。确认警报可防止连续通知。当受监控的组件达到或超过设置的值时，您就会收到警报，直到您确认该警报为止。要使用此资源，请求的 API 密钥必须具有“组织所有者”或“项目所有者”角色。

此资源仍在修订中，可能会有变动。已弃用的版本：v2-{2023-01-01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

alertId
必需
字符串^([a-f0-9]{24})$

用于标识警报的唯一的 24 位十六进制数字字符串。使用 /alerts 端点检索经过身份验证的用户有权访问的所有警报。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-05-30+json

确认或取消确认一个警报。

acknowledgedUntil
字符串 <date-time>

确认警报的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。如果 MongoDB 用户以前确认过该警报，该资源会返回此参数。

ISO 8601
acknowledgementComment
字符串 <= 200 个字符

MongoDB Cloud 用户在确认警报时提交的注释。

unacknowledgeAlert
布尔

指示取消确认先前已确认警报的标志。默认情况下，此值设置为 false。如果将此值设置为 true，它将覆盖 acknowledgedUntil 参数。

响应

请求样本

内容类型
application/vnd.atlas.2024-05-30+json
{
  • "acknowledgedUntil": "2019-08-24T14:15:22Z",
  • "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
  • "unacknowledgeAlert": true
}

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
例子
{
  • "acknowledgedUntil": "2019-08-24T14:15:22Z",
  • "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
  • "acknowledgingUsername": "user@example.com",
  • "alertConfigId": "32b6e34b3d91647abb20e7b8",
  • "created": "2019-08-24T14:15:22Z",
  • "eventTypeName": "DEPLOYMENT_FAILURE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastNotified": "2019-08-24T14:15:22Z",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "resolved": "2019-08-24T14:15:22Z",
  • "status": "OPEN",
  • "updated": "2019-08-24T14:15:22Z"
}

创建一个 Atlas Search 索引已弃用

在指定集合上创建一个 Atlas Search 索引。Atlas Search 索引定义了创建索引的字段和创建索引时使用的分析器。只有运行 MongoDB v4.2 或更高版本的集群才能使用 Atlas Search。要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。

Atlas Search 索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

集群名称，该集群包含要在其上创建 Atlas Search 索引的集合。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

在指定集合上创建一个 Atlas Search 索引。

collectionName
必需
字符串

可读标签，用于标识包含一个或多个 Atlas Search 索引的集合。

database
必需
字符串

人类可读标签，用于标识包含具有一个或多个 Atlas Search 索引的集合的数据库。

名称
必需
字符串

用于标识该索引的可读标签。在每个命名空间内，命名空间内的所有索引的名称必须是唯一的。

numPartitions
整型 <int32>
默认： 1

索引分区数。 注意：此功能目前处于预览状态。

类型
字符串

索引的类型。默认类型为搜索。

分析器
字符串
默认： "lucene.standard"
枚举： "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" “lucene.arabic” "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" “lucene.danish” “lucene.dutch” "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" “lucene.irish” "lucene.italian" “lucene.japanese” “lucene.korean” "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

选择的特定预定义方法，用于将数据库字段文本转换为可搜索单词。此转换会将字段的文本减少为最小的文本单位。这些单位被称为术语或词元。这个过程被称为分词，涉及对字段中的文本所做的各种更改：

  • 提取单词
  • 删除标点符号
  • 删除重音符号
  • 改为小写
  • 删除常用词
  • 将单词简化为其词根形式（词干）
  • 将单词更改为基本形式（词形还原） MongoDB Cloud 使用选定的过程来构建 Atlas Search 索引。
Atlas Search 分析器
数组 对象 （分析器）

用于将数据库字段文本转换为可搜索单词的用户定义方法的列表。

自定义 Atlas Search 分析器
对象 （映射）

集合的字段的索引规范。

搜索分析器
字符串
默认： "lucene.standard"
枚举： "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" “lucene.arabic” "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" “lucene.danish” “lucene.dutch” "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" “lucene.irish” "lucene.italian" “lucene.japanese” “lucene.korean” "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

用于在搜索此索引时识别单词的方法。

存储的源
对象

指示是否在 Atlas Search 上存储 (true) 所有字段的标记。默认情况下，Atlas 在 Atlas Search 上不存储 (false) 字段。或者，您可以指定一个对象，其中仅包含要在 Atlas Search 上存储 (include) 或不存储 (exclude) 的字段列表。要了解更多信息，请参阅文档。

存储源字段
数组 对象 （同义词映射定义）

将单词映射到此索引中的同义词的规则集。

同义词映射

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "collectionName": "string",
  • "database": "string",
  • "name": "string",
  • "numPartitions": 1,
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "numPartitions": 1,
  • "status": "IN_PROGRESS",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

返回一个集合的所有 Atlas Search 索引已弃用

返回指定集合上的所有 Atlas Search 索引。Atlas Search 索引包含索引字段和用于创建索引的分析器。要使用此资源，请求的 API 密钥必须具有项目数据访问读写角色。

Atlas Search 索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

集群名称，该集群包含具有一个或多个 Atlas Search 索引的集合。

collectionName
必需
字符串

集合名称，该集合包含一个或多个 Atlas Search 索引。

数据库名称
必需
字符串

人类可读标签，用于标识包含具有一个或多个 Atlas Search 索引的集合的数据库。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

删除一个 Atlas Search 索引已弃用

删除您使用其唯一 ID 标识的一个 Atlas Search 索引。要使用此资源，请求的 API 密钥必须具有“项目数据访问管理员”角色。

Atlas Search 索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

集群名称，该集群包含具有一个或多个应用程序搜索索引的数据库和集合。

indexId
必需
字符串^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识 Atlas Search 索引。使用获取集合 API 端点的所有 Atlas Search 索引来查找所有 Atlas Search 索引的 ID。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{ }

返回一个 Atlas Search 索引已弃用

返回指定项目中的一个 Atlas Search 索引。您可以使用其唯一 ID 来标识此索引。Atlas Search 索引包含索引字段和用于创建索引的分析器。要使用此资源，请求的 API 密钥必须具有“项目数据访问读写”角色。

Atlas Search 索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

集群名称，该集群包含具有一个或多个 Atlas Search 索引的集合。

indexId
必需
字符串^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识应用程序搜索索引。使用获取集合 API 端点的所有应用程序搜索索引来查找所有应用程序搜索索引的 ID。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "numPartitions": 1,
  • "status": "IN_PROGRESS",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

更新一个 Atlas Search 索引已弃用

更新您使用其唯一 ID 标识的一个 Atlas Search 索引。Atlas Search 索引定义了创建索引的字段和创建索引时使用的分析器。要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。

Atlas Search 索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

集群名称，该集群包含要更新其 Atlas Search 索引的集合。

indexId
必需
字符串^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识 Atlas Search 索引。使用获取集合 API 的所有 Atlas Search 索引端点来查找所有 Atlas Search 索引的 ID。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

Atlas Search 索引相关更新的详细信息。

collectionName
必需
字符串

可读标签，用于标识包含一个或多个 Atlas Search 索引的集合。

database
必需
字符串

人类可读标签，用于标识包含具有一个或多个 Atlas Search 索引的集合的数据库。

名称
必需
字符串

用于标识该索引的可读标签。在每个命名空间内，命名空间内的所有索引的名称必须是唯一的。

numPartitions
整型 <int32>
默认： 1

索引分区数。 注意：此功能目前处于预览状态。

类型
字符串

索引的类型。默认类型为搜索。

分析器
字符串
默认： "lucene.standard"
枚举： "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" “lucene.arabic” "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" “lucene.danish” “lucene.dutch” "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" “lucene.irish” "lucene.italian" “lucene.japanese” “lucene.korean” "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

选择的特定预定义方法，用于将数据库字段文本转换为可搜索单词。此转换会将字段的文本减少为最小的文本单位。这些单位被称为术语或词元。这个过程被称为分词，涉及对字段中的文本所做的各种更改：

  • 提取单词
  • 删除标点符号
  • 删除重音符号
  • 改为小写
  • 删除常用词
  • 将单词简化为其词根形式（词干）
  • 将单词更改为基本形式（词形还原） MongoDB Cloud 使用选定的过程来构建 Atlas Search 索引。
Atlas Search 分析器
数组 对象 （分析器）

用于将数据库字段文本转换为可搜索单词的用户定义方法的列表。

自定义 Atlas Search 分析器
对象 （映射）

集合的字段的索引规范。

搜索分析器
字符串
默认： "lucene.standard"
枚举： "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" “lucene.arabic” "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" “lucene.danish” “lucene.dutch” "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" “lucene.irish” "lucene.italian" “lucene.japanese” “lucene.korean” "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

用于在搜索此索引时识别单词的方法。

存储的源
对象

指示是否在 Atlas Search 上存储 (true) 所有字段的标记。默认情况下，Atlas 在 Atlas Search 上不存储 (false) 字段。或者，您可以指定一个对象，其中仅包含要在 Atlas Search 上存储 (include) 或不存储 (exclude) 的字段列表。要了解更多信息，请参阅文档。

存储源字段
数组 对象 （同义词映射定义）

将单词映射到此索引中的同义词的规则集。

同义词映射

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "collectionName": "string",
  • "database": "string",
  • "name": "string",
  • "numPartitions": 1,
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "numPartitions": 1,
  • "status": "IN_PROGRESS",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

删除搜索节点

删除指定集群的搜索节点。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

标识要删除的集群的标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
{ }

返回搜索节点

返回指定集群的搜索节点。已弃用的版本：v2-{2024-05-30}、v2-{2023-01-01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

标识要返回搜索节点的集群的标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2025-03-12+json
{
  • "encryptionAtRestProvider": "NONE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "specs": [
    ],
  • "stateName": "IDLE"
}

更新搜索节点

更新指定集群的搜索节点。已弃用的版本： v2-{2023-01-01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

用于标识要更新搜索节点的集群的标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-05-30+json

更新指定集群的搜索节点。

必需
数组 对象 （ApiSearchDeploymentSpecView） = 1 个列项

为集群配置搜索节点的设置列表。

注意：目前，我们接受对所有节点使用单一配置。

响应

请求样本

内容类型
application/vnd.atlas.2024-05-30+json
{
  • "specs": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
{
  • "encryptionAtRestProvider": "NONE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "specs": [
    ],
  • "stateName": "IDLE"
}

创建搜索节点

为指定集群创建搜索节点。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

用于标识要创建搜索节点的集群的标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-05-30+json

为指定集群创建搜索节点。

必需
数组 对象 （ApiSearchDeploymentSpecView） = 1 个列项

为集群配置搜索节点的设置列表。

注意：目前，我们接受对所有节点使用单一配置。

响应

请求样本

内容类型
application/vnd.atlas.2024-05-30+json
{
  • "specs": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
{
  • "encryptionAtRestProvider": "NONE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "specs": [
    ],
  • "stateName": "IDLE"
}

返回一个集群的所有 Atlas Search 索引

返回指定集群上的所有 Atlas Search 索引。Atlas Search 索引包含索引字段和用于创建索引的分析器。要使用此资源，请求的 API 密钥必须具有项目数据访问读写角色。

Atlas Search 索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

集群名称，该集群包含具有一个或多个 Atlas Search 索引的集合。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
[
  • {
    }
]

创建一个 Atlas Search 索引

在指定集合上创建一个 Atlas Search 索引。Atlas Search 索引定义了创建索引的字段和创建索引时使用的分析器。只有运行 MongoDB v4.2 或更高版本的集群才能使用 Atlas Search。要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。

Atlas Search 索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

集群名称，该集群包含要在其上创建 Atlas Search 索引的集合。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-05-30+json

在指定集合上创建一个 Atlas Search 索引。

collectionName
必需
字符串

用于标识要在其中创建 Atlas Search 的集合的标签。

database
必需
字符串

用于标识包含要在其中创建 Atlas Search 索引的集合的数据库的标签。

名称
必需
字符串

标识此索引的标签。 在每个命名空间内，命名空间内的所有索引的名称必须是唯一的。

类型
字符串

索引的类型。默认类型为搜索。

必需
对象 （文本搜索索引定义）

用户设置的文本搜索索引定义。

响应

请求样本

内容类型
application/vnd.atlas.2024-05-30+json
例子
{
  • "collectionName": "string",
  • "database": "string",
  • "name": "string",
  • "type": "search",
  • "definition": {
    }
}

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
例子
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "latestDefinition": {
    },
  • "latestDefinitionVersion": {
    },
  • "name": "string",
  • "queryable": true,
  • "status": "DELETING",
  • "statusDetail": [
    ],
  • "type": "search",
  • "synonymMappingStatus": "FAILED",
  • "synonymMappingStatusDetail": [
    ]
}

返回一个集合的所有 Atlas Search 索引

返回指定集合上的所有 Atlas Search 索引。Atlas Search 索引包含索引字段和用于创建索引的分析器。要使用此资源，请求的 API 密钥必须具有项目数据访问读写角色。

Atlas Search 索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

集群名称，该集群包含具有一个或多个 Atlas Search 索引的集合。

collectionName
必需
字符串

集合名称，该集合包含一个或多个 Atlas Search 索引。

数据库名称
必需
字符串

用于标识包含具有一个或多个 Atlas Search 索引的集合的数据库的标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
[
  • {
    }
]

按名称删除一个 Atlas Search 索引

删除您使用其数据库、集合和名称标识的一个 Atlas Search 索引。要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。这种删除最终是一致的。

Atlas Search 索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

集群名称，该集群包含具有一个或多个应用程序搜索索引的数据库和集合。

collectionName
必需
字符串

集合名称，该集合包含一个或多个 Atlas Search 索引。

数据库名称
必需
字符串

用于标识包含具有一个或多个 Atlas Search 索引的集合的数据库的标签。

indexName
必需
字符串

要删除的 Atlas Search 索引的名称。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
{ }

按名称返回一个 Atlas Search 索引

返回指定项目中的一个 Atlas Search 索引。您可以使用相应的数据库、集合和名称来标识此索引。Atlas Search 索引包含索引字段和用于创建索引的分析器。要使用此资源，请求的 API 密钥必须具有项目数据访问读写角色。

Atlas Search 索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

集群名称，该集群包含具有一个或多个 Atlas Search 索引的集合。

collectionName
必需
字符串

集合名称，该集合包含一个或多个 Atlas Search 索引。

数据库名称
必需
字符串

用于标识包含具有一个或多个 Atlas Search 索引的集合的数据库的标签。

indexName
必需
字符串

要返回的 Atlas Search 索引的名称。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
例子
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "latestDefinition": {
    },
  • "latestDefinitionVersion": {
    },
  • "name": "string",
  • "queryable": true,
  • "status": "DELETING",
  • "statusDetail": [
    ],
  • "type": "search",
  • "synonymMappingStatus": "FAILED",
  • "synonymMappingStatusDetail": [
    ]
}

按名称更新一个 Atlas Search 索引

更新您通过其数据库、集合名称和搜索索引名称标识的一个 Atlas Search 索引。Atlas Search 索引定义了创建索引的字段和创建索引时使用的分析器。要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。

Atlas Search 索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

集群名称，该集群包含要更新其 Atlas Search 索引的集合。

collectionName
必需
字符串

集合名称，该集合包含一个或多个 Atlas Search 索引。

数据库名称
必需
字符串

用于标识包含具有一个或多个 Atlas Search 索引的集合的数据库的标签。

indexName
必需
字符串

要更新的 Atlas Search 索引的名称。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-05-30+json

Atlas Search 索引相关更新的详细信息。

必需
文本搜索索引定义（对象）或向量搜索索引定义（对象）

用于更新搜索索引的索引定义。

响应

请求样本

内容类型
application/vnd.atlas.2024-05-30+json
{
  • "definition": {
    }
}

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
例子
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "latestDefinition": {
    },
  • "latestDefinitionVersion": {
    },
  • "name": "string",
  • "queryable": true,
  • "status": "DELETING",
  • "statusDetail": [
    ],
  • "type": "search",
  • "synonymMappingStatus": "FAILED",
  • "synonymMappingStatusDetail": [
    ]
}

按 ID 删除一个 Atlas Search 索引

删除您使用其唯一 ID 标识的一个 Atlas Search 索引。要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。此删除最终是一致的。

Atlas Search 索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

集群名称，该集群包含具有一个或多个应用程序搜索索引的数据库和集合。

indexId
必需
字符串^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识 Atlas Search 索引。使用获取集合 API 端点的所有 Atlas Search 索引来查找所有 Atlas Search 索引的 ID。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
{ }

按 ID 返回一个 Atlas Search 索引

返回指定项目中的一个 Atlas Search 索引。您可以使用其唯一 ID 来标识此索引。Atlas Search 索引包含索引字段和用于创建索引的分析器。要使用此资源，请求的 API 密钥必须具有“项目数据访问读写”角色。

Atlas Search 索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

集群名称，该集群包含具有一个或多个 Atlas Search 索引的集合。

indexId
必需
字符串^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识应用程序搜索索引。使用获取集合 API 端点的所有应用程序搜索索引来查找所有应用程序搜索索引的 ID。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
例子
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "latestDefinition": {
    },
  • "latestDefinitionVersion": {
    },
  • "name": "string",
  • "queryable": true,
  • "status": "DELETING",
  • "statusDetail": [
    ],
  • "type": "search",
  • "synonymMappingStatus": "FAILED",
  • "synonymMappingStatusDetail": [
    ]
}

按 ID 更新一个 Atlas Search 索引

更新您使用其唯一 ID 标识的一个 Atlas Search 索引。Atlas Search 索引定义了创建索引的字段和创建索引时使用的分析器。要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。

Atlas Search 索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

集群名称，该集群包含要更新其 Atlas Search 索引的集合。

indexId
必需
字符串^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识 Atlas Search 索引。使用获取集合 API 的所有 Atlas Search 索引端点来查找所有 Atlas Search 索引的 ID。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-05-30+json

Atlas Search 索引相关更新的详细信息。

必需
文本搜索索引定义（对象）或向量搜索索引定义（对象）

用于更新搜索索引的索引定义。

响应

请求样本

内容类型
application/vnd.atlas.2024-05-30+json
{
  • "definition": {
    }
}

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
例子
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "latestDefinition": {
    },
  • "latestDefinitionVersion": {
    },
  • "name": "string",
  • "queryable": true,
  • "status": "DELETING",
  • "statusDetail": [
    ],
  • "type": "search",
  • "synonymMappingStatus": "FAILED",
  • "synonymMappingStatusDetail": [
    ]
}

审核

返回和编辑 MongoDB Cloud 项目的数据库审核设置。

返回一个项目的审核配置

返回指定项目的审核配置。审核配置定义了 MongoDB Cloud 在审核日志中记录的事件。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。此功能不适用于 M0、M2、M5 或无服务器集群。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "configurationType": "NONE",
  • "enabled": false
}

更新一个项目的审核配置

更新指定项目的审核配置。审核配置定义 MongoDB Cloud 在审核日志中记录的事件。要使用此资源，请求的 API 密钥必须具有项目所有者角色。此功能不适用于 M0、M2、M5 或无服务器集群。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

更新指定项目的审核配置。

auditAuthorizationSuccess
布尔
默认： false

指示某人是否将审核设置为跟踪成功的身份验证的标志。这仅适用于 "atype" : "authCheck" 审核筛选器。将该参数设置为 true 会降低集群性能。

系统审核消息
auditFilter
字符串

用于指定要记录的事件的 JSON 文档。使用反斜杠 (\) 对任何可能妨碍解析的字符（如单引号或双引号）进行转义。

自定义审核过滤器
enabled
布尔
默认： false

指示某人是否为指定项目启用数据库审核的标记。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "enabled": false
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "configurationType": "NONE",
  • "enabled": false
}

AWS 集群 DNS

返回并编辑 AWS 上 MongoDB Cloud 数据库部署的自定义 DNS 配置。该资源需要您的项目 ID。如果您在 AWS 上使用 VPC 对等互连，并且使用您自己的 DNS 服务器而不是 Amazon Route 53，请启用自定义 DNS。在 2020 年 3 月 31 日之前，使用自定义 DNS 服务和与 MongoDB Cloud 对等互连的 VPC 在 AWS 中部署的应用程序，无法通过私有 IP 地址进行连接：自定义 DNS 解析为公共 IP 地址。AWS 内部 DNS 解析为私有 IP 地址。在 AWS 中使用自定义 DNS 服务部署的应用程序，应该为对等互连连接字符串使用私有 IP。

为 AWS 上的 Atlas 集群返回一个自定义 DNS 配置

返回指定项目中 AWS 集群的自定义 DNS 配置。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

切换 AWS 上 Atlas 集群的一个自定义 DNS 配置的状态

启用或禁用指定项目中 AWS 集群的自定义 DNS 配置。如果您使用 AWS VPC 对等互连并使用自己的 DNS 服务器，请启用自定义 DNS。要使用此资源，请求的 API 密钥必须具有“项目 Atlas 管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

启用或禁用指定项目中 AWS 集群的自定义 DNS 配置。

enabled
必需
布尔

指示部署到 Amazon Web Services (AWS) 的项目的集群是否使用自定义域名系统 (DNS) 的标志。当为 "enabled": true 时，使用私有 IP 作为对等互连连接字符串连接到集群。

如需了解更多信息，请参阅常见问题解答：MongoDB Atlas 文档中的“连接字符串选项”。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

云备份

管理“云备份”快照、快照导出存储桶、恢复作业和计划。此资源仅适用于使用“云备份”的集群。

返回所有快照导出存储桶

返回与指定项目关联的所有导出存储桶。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。已弃用的版本：v2-{2023-01-01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
{}

创建一个快照导出存储桶

为 AWS S3 存储桶或 Azure Blob 存储容器创建快照导出存储桶。创建快照后，可以将快照导出到导出存储桶及其引用的 AWS S3 存储桶或 Azure Blob 存储容器中。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。已弃用的版本：v2-{2023-01-01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-05-30+json

指定导出存储桶应引用的角色和 AWS S3 存储桶或 Azure Blob 存储容器。

bucketName
必需
字符串 [ 3 .. 63 ] 个字符

人类可读的标签，用于标识角色有权导出到的 AWS S3 存储桶或 Azure 存储容器。

云服务提供商
必需
字符串

人类可读标签，用于标识Atlas 备份快照导出到的云提供商。

iamRoleId
必需
字符串^([a-f0-9]{24})$

唯一的 24 位十六进制字符串，可用于标识 MongoDB Cloud 用来访问 AWS S3 存储桶的统一 AWS 访问角色 ID。

响应

请求样本

内容类型
application/vnd.atlas.2024-05-30+json
例子

AWS

{
  • "bucketName": "export-bucket",
  • "cloudProvider": "AWS",
  • "iamRoleId": "668c5f0ed436263134491592"
}

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
例子

AWS

{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "bucketName": "export-bucket",
  • "cloudProvider": "AWS",
  • "iamRoleId": "668c5f0ed436263134491592",
  • "links": []
}

删除一个快照导出存储桶

删除导出存储桶。在撤销访问权限之前，必须对此项目中导出到此导出存储桶的所有集群禁用自动导出。要使用此资源，请求的 API 密钥必须具有“项目备份管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

exportBucketId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

唯一的 24 位十六进制字符串，用于标识导出存储桶。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{ }

返回一个快照导出存储桶

返回一个与指定项目关联的导出存储桶。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。已弃用的版本：v2-{2023-01-01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

exportBucketId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

唯一的 24 位十六进制字符串，用于标识导出存储桶。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
例子

AWS

{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "bucketName": "export-bucket",
  • "cloudProvider": "AWS",
  • "iamRoleId": "668c5f0ed436263134491592",
  • "links": []
}

禁用备份合规策略设置

禁用指定项目的备份合规性策略设置。作为先决条件，您需要先提交支持工单，相关说明请参阅 https://www.mongodb.com/zh-cn/docs/atlas/backup/cloud-backup/backup-compliance-policy/。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-11-13+json
{ }

返回备份合规性策略设置

返回指定项目的备份合规性策略设置。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。已弃用的版本：v2-{2023-01-01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-10-01+json
{
  • "authorizedEmail": "user@example.com",
  • "authorizedUserFirstName": "string",
  • "authorizedUserLastName": "string",
  • "copyProtectionEnabled": false,
  • "deletable": false,
  • "encryptionAtRestEnabled": false,
  • "onDemandPolicyItem": {
    },
  • "pitEnabled": false,
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreWindowDays": 0,
  • "scheduledPolicyItems": [
    ],
  • "state": "ACTIVE",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUser": "user@example.com"
}

更新或启用备份合规性策略设置

更新指定项目的备份合规性策略设置。要使用此资源，请求的 API 密钥必须具有项目所有者角色。已弃用的版本：v2-{2023-01-01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

overwriteBackupPolicies
布尔
默认： true

该标志指示是否使用新的数据保护设置覆盖不符合要求的备份策略。

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-10-01+json

新的“备份合规性策略”设置。

authorizedEmail
必需
字符串 <email>

授权更新备份合规策略设置的用户电子邮件地址。

authorizedUserFirstName
必需
字符串

授权更新备份合规策略设置的用户姓氏。

authorizedUserLastName
必需
字符串

授权更新备份合规策略设置的用户名称。

copyProtectionEnabled
布尔
默认： false

指示是否阻止集群用户删除已复制到其他地区的备份的标志，即使这些附加快照地区已被删除。如果未指定，则此值默认为 False。

encryptionAtRestEnabled
布尔
默认： false

指示具有备份合规策略的所有集群是否需要使用客户密钥管理进行静态加密的标志。如果未指定，则此值默认为 False。

使用客户密钥管理进行静态加密
对象 （BackupComplianceOnDemandPolicyItem）

按需策略规范。

pitEnabled
布尔
默认： false

指示集群是否使用带有备份合规性策略的持续云备份的标志。如果未指定，则此值默认为 False。

持续的云备份
projectId
字符串^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识“备份合规性策略”的项目。

restoreWindowDays
整型 <int32>

使用带有备份合规性策略的持续云备份可以恢复到以前的天数。必须指定一个正的非零整数，并且最大保留窗口不能超过每小时保留时间。此参数仅适用于具有备份合规性策略的持续云备份。

数组 对象 (BackupComplianceScheduledPolicyItem)

包含一项计划策略的规范的列表。

响应

请求样本

内容类型
application/vnd.atlas.2023-10-01+json
{
  • "authorizedEmail": "user@example.com",
  • "authorizedUserFirstName": "string",
  • "authorizedUserLastName": "string",
  • "copyProtectionEnabled": false,
  • "encryptionAtRestEnabled": false,
  • "onDemandPolicyItem": {
    },
  • "pitEnabled": false,
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreWindowDays": 0,
  • "scheduledPolicyItems": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2023-10-01+json
{
  • "authorizedEmail": "user@example.com",
  • "authorizedUserFirstName": "string",
  • "authorizedUserLastName": "string",
  • "copyProtectionEnabled": false,
  • "deletable": false,
  • "encryptionAtRestEnabled": false,
  • "onDemandPolicyItem": {
    },
  • "pitEnabled": false,
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreWindowDays": 0,
  • "scheduledPolicyItems": [
    ],
  • "state": "ACTIVE",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUser": "user@example.com"
}

返回所有快照导出作业

返回与指定 Atlas 集群关联的所有云备份快照导出作业。要使用此资源，请求的 API 密钥必须具有“项目 Atlas 管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

创建一个快照导出作业

使用云备份将专用 Atlas 集群的一个备份快照导出到导出存储桶。要使用此资源，请求的 API 密钥必须具有“项目 Atlas 管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

有关要创建的云备份快照导出作业的信息。

数组 对象 (BackupLabel)

键值对的集合，表示导出作业完成时要添加到 MongoDB Cloud 上传到存储桶的元数据文件的自定义数据。

exportBucketId
必需
字符串^([a-f0-9]{24})$

唯一的 24 位十六进制字符串，用于标识导出存储桶。

snapshotId
必需
字符串^([a-f0-9]{24})$

唯一的 24 位十六进制字符串，用于标识要导出的云备份快照。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "customData": [
    ],
  • "exportBucketId": "32b6e34b3d91647abb20e7b8",
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "components": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customData": [
    ],
  • "exportBucketId": "32b6e34b3d91647abb20e7b8",
  • "exportStatus": {
    },
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "prefix": "string",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "Cancelled",
  • "stateReason": {
    }
}

返回一个快照导出作业

返回与指定 Atlas 集群关联的一个云备份快照导出作业。要使用此资源，请求的 API 密钥必须具有“项目 Atlas 管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

exportId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

24唯一的string -十六进制字符串，用于标识导出作业。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "components": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customData": [
    ],
  • "exportBucketId": "32b6e34b3d91647abb20e7b8",
  • "exportStatus": {
    },
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "prefix": "string",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "Cancelled",
  • "stateReason": {
    }
}

返回一个集群的所有恢复作业

返回指定项目中一个集群的云备份恢复作业。要使用此资源，请求的 API 密钥必须具有“项目备份管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，用于标识具有要返回的恢复作业的集群。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

恢复一个集群的一张快照

从指定项目中恢复一个集群的一个快照。Atlas 立即拍摄按需快照，并定期拍摄计划快照。如果存在状态为已排队或进行中的按需快照，则在拍摄另一张快照前，请等待 Atlas 完成对先前拍摄的按需快照的处理。

要使用此资源，请求的 API 密钥必须具有“项目备份管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

从指定项目中恢复一个集群的一个快照。

deliveryType
必需
字符串
枚举： "automated" "download" "pointInTime"

人类可读标签，用于对要创建的恢复任务分类。

oplogInc
整型 <int32> >= 1

要从中恢复此快照的 Oplog 操作编号。该数字表示 Oplog 时间戳的第二部分。当 "deliveryType" : "pointInTime" 和 oplogTs 超过 0 时，资源将返回此参数。

oplogTs
整型 <int32> >= 1199145600

要还原此快照的日期和时间。此参数以自 UNIX 纪元起经过的秒数表示此时间戳。此数字表示 Oplog 时间戳的第一部分。当 "deliveryType" : "pointInTime" 和 oplogTs 超过 0 时，资源返回此参数。

pointInTimeUTCSeconds
整型 <int32> >= 1199145600

MongoDB Cloud 恢复此快照的日期和时间。此参数以自 UNIX 纪元起经过的秒数表示此时间戳。当 "deliveryType" : "pointInTime" 和 pointInTimeUTCSeconds 超过 0 时，资源将返回此参数。

snapshotId
字符串^([a-f0-9]{24})$

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

targetClusterName
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

人可读标签，用于标识恢复作业还原快照的目标集群。当 "deliveryType": "automated" 时，资源返回此参数。对于 automated 和 pointInTime 恢复类型是必需的。

targetGroupId
字符串^([a-f0-9]{24})$

唯一的 24 进制数字字符串，用于标识指定 targetClusterName 的目标项目。对于 automated 和 pointInTime 恢复类型是必需的。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "deliveryType": "automated",
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8"
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "components": [
    ],
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "privateDownloadDeliveryUrls": [
    ],
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8",
  • "timestamp": "2019-08-24T14:15:22Z"
}

取消一个集群的一个恢复作业

从指定项目中取消一个集群的一个云备份恢复作业。要使用此资源，请求的 API 密钥必须具有“项目备份管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

restoreJobId
必需
字符串^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要删除的恢复作业。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{ }

返回一个集群的一项恢复作业

返回指定项目中一个集群的一个云备份恢复作业。要使用此资源，请求的 API 密钥必须具有“项目备份管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，用于标识具有要返回的恢复作业的集群。

restoreJobId
必需
字符串^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，标识要返回的恢复作业。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "components": [
    ],
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "privateDownloadDeliveryUrls": [
    ],
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8",
  • "timestamp": "2019-08-24T14:15:22Z"
}

删除所有云备份计划

删除指定集群的所有云备份计划。此计划定义了 MongoDB Cloud 何时拍摄计划快照以及存储这些快照的时长。要使用此资源，请求的 API 密钥必须具有“项目 Atlas 管理员”角色。 已弃用的版本：v2-{2023-01-01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-08-05+json
{
  • "autoExportEnabled": true,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "copySettings": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "links": [],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "useOrgAndGroupNamesInExportPrefix": true
}

返回一个云备份计划

返回指定项目中指定集群的云备份计划。此计划定义了 MongoDB Cloud 何时拍摄计划快照以及存储这些快照的时长。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。已弃用的版本：v2-{2023-01-01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-08-05+json
{
  • "autoExportEnabled": true,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "copySettings": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "links": [],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "useOrgAndGroupNamesInExportPrefix": true
}

更新一个集群的云备份计划

更新指定项目中一个集群的云备份计划。此计划定义了 MongoDB Cloud 何时拍摄计划快照以及存储这些快照的时长。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。已弃用的版本：v2-{2023-01-01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-08-05+json

更新指定项目中一个集群的云备份计划。

注意：在请求正文中，仅提供要更新的字段。

autoExportEnabled
布尔

指示 MongoDB Cloud 是否自动将云备份快照导出到导出存储桶的标志。

数组 对象 (DiskBackupCopySetting20240805)

包含所需备份策略中每个副本设置列项文档的列表。

数组 对象 (DeleteCopiedBackups20240805)

该列表包含要删除其备份副本的每个已删除副本设置的文档。

对象 (export)

自动导出云备份快照的策略。

数组 对象 (ExtraRetentionSetting)

包含所需备份策略中每个额外保留设置项的文档的列表。

数组 对象 （AdvancedDiskBackupSnapshotSchedulePolicy） <= 1 个列项

为该备份计划设置的规则。

referenceHourOfDay
整型 <int32>

以协调世界时（UTC）表示的一天中的某个小时，表示 MongoDB Cloud 拍摄快照的时间。

referenceMinuteOfHour
整型 <int32>

表示 MongoDB Cloud 获取快照时间的 referenceHourOfDay 的分钟数。

restoreWindowDays
整型 <int32>

使用“持续云备份”准确性可恢复到之前的天数。必须指定非零的正整数。此参数仅适用于连续云备份。

updateSnapshots
布尔

指示是否将更新的备份策略中的保留更改应用到 MongoDB Cloud 以前拍摄的快照的标志。

useOrgAndGroupNamesInExportPrefix
布尔

标志，用于标识是否在 MongoDB Cloud 上传到导出存储桶的元数据文件路径中使用组织和项目名称，而不是组织和项目 UUID。

响应

请求样本

内容类型
application/vnd.atlas.2024-08-05+json
{
  • "autoExportEnabled": true,
  • "copySettings": [
    ],
  • "deleteCopiedBackups": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "updateSnapshots": true,
  • "useOrgAndGroupNamesInExportPrefix": true
}

响应样本

内容类型
application/vnd.atlas.2024-08-05+json
{
  • "autoExportEnabled": true,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "copySettings": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "links": [],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "useOrgAndGroupNamesInExportPrefix": true
}

返回所有副本集云备份

从指定项目中返回一个集群的所有快照。要使用此资源，请求的 API 密钥必须具有“项目只读”角色或“项目备份管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

拍摄一张按需快照

为指定集群拍摄一张按需快照。Atlas 立即拍摄按需快照，并定期拍摄计划快照。如果存在状态为已排队或进行中的按需快照，则在拍摄另一张快照前，请等待 Atlas 完成对先前拍摄的按需快照的处理。

要使用此资源，请求的 API 密钥必须具有“项目备份管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

按需拍摄一张快照。

描述
字符串

说明快照目的的人类可读短语或句子。当 "status" : "onDemand" 时，资源返回此参数。

retentionInDays
整型 <int32> >= 1

MongoDB Cloud 应保留按需快照的天数。必须至少为 1。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "description": "string",
  • "retentionInDays": 1
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "cloudProvider": "AWS",
  • "copyRegions": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "replicaSetName": "string",
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0,
  • "type": "replicaSet"
}

删除一个分片集群云备份

从指定项目中删除一个分片集群的一个快照。要使用此资源，请求的 API 密钥必须具有“项目备份管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

snapshotId
必需
字符串^([a-f0-9]{24})$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{ }

返回一个分片集群云备份

从指定项目中返回一个分片集群的一个快照。要使用此资源，请求的 API 密钥必须具有“项目只读”角色或“项目备份管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

snapshotId
必需
字符串^([a-f0-9]{24})$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "configServerType": "EMBEDDED",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "members": [
    ],
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "snapshotIds": [
    ],
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0,
  • "type": "replicaSet"
}

返回所有分片集群云备份

从指定项目中返回一个分片集群的所有快照。要使用此资源，请求的 API 密钥必须具有“项目只读”角色或“项目备份经理”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

删除一个副本集云备份

删除指定的快照。要使用此资源，请求的 API 密钥必须具有“项目备份管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

snapshotId
必需
字符串^([a-f0-9]{24})$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{ }

返回一个副本集云备份

从指定集群返回一个快照。要使用此资源，请求的 API 密钥必须具有“项目只读”角色或“项目备份管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

snapshotId
必需
字符串^([a-f0-9]{24})$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "cloudProvider": "AWS",
  • "copyRegions": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "replicaSetName": "string",
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0,
  • "type": "replicaSet"
}

更改一个云备份的到期日期

更改指定项目中一个集群的一个云备份快照的过期日期，而请求的 API 密钥必须具有“项目备份管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

snapshotId
必需
字符串^([a-f0-9]{24})$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

更改指定项目中一个集群的一个云备份快照的过期日期。

retentionUnit
必需
字符串
枚举： “天” “周” "MONTHS" "YEARS"

MongoDB Cloud 用于计量快照保留时间的时长。

retentionValue
必需
整型 <int32>

数字，表示 MongoDB Cloud 保留快照的天数、周数、月数或年数。对于频率较低的策略项目，MongoDB Cloud 要求您指定的值大于或等于为频率较高的策略项目指定的值。如果每小时策略项目指定保留两天，请为每周策略项目指定两天或更长的保留时间。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "retentionUnit": "DAYS",
  • "retentionValue": 5
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "cloudProvider": "AWS",
  • "copyRegions": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "replicaSetName": "string",
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0,
  • "type": "replicaSet"
}

为一个无服务器实例返回所有恢复作业

返回指定项目中一个无服务器实例的所有恢复作业。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

此 API 也可用于通过 createServerlessInstance 终结点创建的 Flex 集群，或是从无服务器实例迁移的 Flex 集群。该终结点将在 2026 年 1 月停用。请改用 listFlexBackupRestoreJobs 终结点。

listFlexBackupRestoreJobs
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

恢复一个无服务器实例的一个快照

恢复指定项目中一个无服务器实例的一个快照。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

此 API 也可用于通过 createServerlessInstance 终结点创建的 Flex 集群，或是从无服务器实例迁移的 Flex 集群。该终结点将在 2026 年 1 月停用。请改用 createFlexBackupRestoreJob 终结点。

创建FlexBackupRestoreJob
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

用户可读的标签，用于标识要恢复其快照的无服务器实例。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

从指定项目中恢复一个无服务器实例的一个快照。

deliveryType
必需
字符串
枚举： "automated" "download" "pointInTime"

人类可读标签，用于对要创建的恢复任务分类。

oplogInc
整型 <int32> >= 1

要从中恢复此快照的 Oplog 操作编号。该数字表示 Oplog 时间戳的第二部分。当 "deliveryType" : "pointInTime" 和 oplogTs 超过 0 时，资源将返回此参数。

oplogTs
整型 <int32> >= 1199145600

要还原此快照的日期和时间。此参数以自 UNIX 纪元起经过的秒数表示此时间戳。此数字表示 Oplog 时间戳的第一部分。当 "deliveryType" : "pointInTime" 和 oplogTs 超过 0 时，资源返回此参数。

pointInTimeUTCSeconds
整型 <int32> >= 1199145600

MongoDB Cloud 恢复此快照的日期和时间。此参数以自 UNIX 纪元起经过的秒数表示此时间戳。当 "deliveryType" : "pointInTime" 和 pointInTimeUTCSeconds 超过 0 时，资源将返回此参数。

snapshotId
字符串^([a-f0-9]{24})$

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

targetClusterName
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

用户可读的标签，用于标识恢复作业将快照恢复到的目标集群。当 "deliveryType": "automated" 时，资源返回此参数。

targetGroupId
必需
字符串^([a-f0-9]{24})$

唯一的 24 进制数字字符串，用于标识指定 targetClusterName 的目标项目。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "deliveryType": "automated",
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8"
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8",
  • "timestamp": "2019-08-24T14:15:22Z"
}

为一个无服务器实例返回一个恢复作业

从指定项目中返回一个无服务器实例的一个恢复作业。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

此 API 也可用于通过 createServerlessInstance 终结点创建的 Flex 集群，或是从无服务器实例迁移的 Flex 集群。该终结点将在 2026 年 1 月停用。请使用 getFlexBackupRestoreJob 终结点。

getFlexBackupRestoreJob
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

restoreJobId
必需
字符串^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，标识要返回的恢复作业。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8",
  • "timestamp": "2019-08-24T14:15:22Z"
}

为一个无服务器实例返回所有快照

从指定项目中返回一个无服务器实例的所有快照。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

此 API 也可用于通过 createServerlessInstance 终结点创建的 Flex 集群，或是从无服务器实例迁移的 Flex 集群。该终结点将在 2026 年 1 月停用。请改用 listFlexBackups 终结点。

listFlexBackups
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

返回一个无服务器实例的一个快照

从指定项目中返回一个无服务器实例的一个快照。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

此终结点也可用于通过 createServerlessInstance API 创建的 Flex 集群，或是从无服务器实例迁移的 Flex 集群。该终结点将在 2026 年 1 月停用。请改用 getFlexBackup 终结点。

getFlexBackup
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

snapshotId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongodVersion": "string",
  • "serverlessInstanceName": "string",
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0
}

云迁移服务

管理云迁移服务。源组织、项目和 MongoDB 集群位于 Cloud Manager 或 Ops Manager 上。目标组织、项目和 MongoDB 集群位于 MongoDB Cloud 上。源数据库不能使用除 SCRAM-SHA 以外的任何身份验证。

将一个本地托管集群迁移到 MongoDB Atlas

将 Cloud 或 Ops Manager 托管的一个集群迁移到 MongoDB Atlas。

请确保在开始迁移之前进行验证。

您只能将此 API 端点用于推送实时迁移。您的 API 密钥必须具有“组织所有者”角色才能成功调用此资源。

注意：MongoDB 6.0 或更高版本暂不支持迁移时间序列集合。MongoDB 6.0 或更高版本上的迁移将跳过源集群上的任何时间序列集合。已弃用的版本：v2-{2023-01-01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-05-30+json

要创建的一个迁移。

必需
对象 （目的地）

描述迁移目标的文档。

dropDestinationData
布尔
默认： false

指示迁移过程是否在迁移开始之前从目标集群删除所有集合的标志。

migrationHosts
数组 字符串 = 1 个列项

用于此迁移的迁移主机列表。

对象 （ShardingRequest）

当从副本集源迁移到 MongoDB 6.0 或更高版本上的分片集群目标时，在目标集群上配置分片的文档。如果您不希望对目标集群上的任何集合进行分片，请将其留空。

必需
对象 （来源）

描述迁移来源的文档。

响应

请求样本

内容类型
application/vnd.atlas.2024-05-30+json
{
  • "destination": {
    },
  • "dropDestinationData": false,
  • "migrationHosts": [
    ],
  • "sharding": {
    },
  • "source": {
    }
}

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "lagTimeSeconds": 0,
  • "migrationHosts": [
    ],
  • "readyForCutover": true,
  • "status": "NEW"
}

验证一个迁移请求

验证提供的凭据、可用磁盘空间、MongoDB 版本等是否满足迁移请求的要求。如果检查通过，则可以继续迁移。您的 API 密钥必须具有“组织所有者”角色才能成功调用此资源。已弃用的版本： v 2 -{2023 - 01 - 01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-05-30+json

有待验证的一次迁移。

必需
对象 （目的地）

描述迁移目标的文档。

dropDestinationData
布尔
默认： false

指示迁移过程是否在迁移开始之前从目标集群删除所有集合的标志。

migrationHosts
数组 字符串 = 1 个列项

用于此迁移的迁移主机列表。

对象 （ShardingRequest）

当从副本集源迁移到 MongoDB 6.0 或更高版本上的分片集群目标时，在目标集群上配置分片的文档。如果您不希望对目标集群上的任何集合进行分片，请将其留空。

必需
对象 （来源）

描述迁移来源的文档。

响应

请求样本

内容类型
application/vnd.atlas.2024-05-30+json
{
  • "destination": {
    },
  • "dropDestinationData": false,
  • "migrationHosts": [
    ],
  • "sharding": {
    },
  • "source": {
    }
}

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "errorMessage": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "sourceGroupId": "32b6e34b3d91647abb20e7b8",
  • "status": "PENDING"
}

返回一个迁移验证任务

返回一个迁移验证作业的状态。您的 API 密钥必须具有“组织所有者”角色才能成功调用此资源。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

validationId
必需
字符串^([a-f0-9]{24})$
示例： 507f1f77bcf86cd799439011

唯一的 24 位十六进制数字字符串，用于标识该验证作业。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "errorMessage": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "sourceGroupId": "32b6e34b3d91647abb20e7b8",
  • "status": "PENDING"
}

返回一个迁移作业

返回一个集群迁移作业的详细信息。每个推送实时迁移作业都使用一个迁移主机。 您的 API 密钥必须具有“组织成员”角色才能成功调用此资源。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

liveMigrationId
必需
字符串^([a-f0-9]{24})$
示例： 6296fb4c7c7aa997cf94e9a8

用于标识该迁移的唯一的 24 位十六进制数字字符串。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "lagTimeSeconds": 0,
  • "migrationHosts": [
    ],
  • "readyForCutover": true,
  • "status": "NEW"
}

切换已迁移的集群

将迁移的集群切换到 MongoDB Atlas。确认切换何时完成。切换完成后，MongoDB Atlas 将完成实时迁移进程，并停止与源集群同步。您的 API 密钥必须具有“组织所有者”角色才能成功调用此资源。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

liveMigrationId
必需
字符串^([a-f0-9]{24})$
示例： 6296fb4c7c7aa997cf94e9a8

用于标识该迁移的唯一的 24 位十六进制数字字符串。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

返回所有可迁移的项目

返回可以迁移到指定组织的所有项目。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

删除一个链接令牌

删除一个组织链接及其关联的公用 API 密钥。MongoDB Atlas 仅将链接令牌用于推送实时迁移。实时迁移（推送）可让您将数据从 Cloud Manager 或 Ops Manager 安全地推送到 MongoDB Atlas。您的 API 密钥必须具有“组织所有者”角色才能成功调用此资源。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{ }

创建一个链接令牌

创建一个链接令牌，其中包含完成链接所需的所有信息。MongoDB Atlas 仅将链接令牌用于推送实时迁移。实时迁移（推送）允许您安全地将数据从 Cloud Manager 或 Ops Manager 推送到 MongoDB Atlas。您的 API 密钥必须具有“组织所有者”角色才能成功调用此资源。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

与迁移相关的 IP 地址访问列表条目。

accessListIps
数组 字符串

与 API 密钥相关联的 IP 地址访问列表条目。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "accessListIps": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "linkToken": "string"
}

云提供商访问

返回、添加、授权和删除 Atlas 中的 AWS IAM 角色。

返回所有云提供商访问角色

返回有权访问指定项目的所有云提供商访问角色。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "awsIamRoles": [
    ],
  • "azureServicePrincipals": [
    ]
}

创建一个云提供商访问角色

为指定的云提供商创建一个访问角色。某些 MongoDB Cloud 功能使用这些云提供商访问角色进行身份验证。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

设置对云提供商的访问权限
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

为指定的云提供商创建一个角色。

提供商名称
必需
字符串

用于标识角色的云提供商的人类可读标签。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "providerName": "AWS"
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "providerName": "AWS",
  • "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
  • "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
  • "authorizedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "featureUsages": [
    ],
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
  • "roleId": "32b6e34b3d91647abb20e7b8"
}

取消对一个云提供商访问角色的授权

撤销指定访问角色对指定项目的访问权限。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

云服务提供商
必需
字符串
枚举： "AWS" "AZURE" "GCP"

人类可读标签，用于标识要取消授权的角色的云提供商。

roleId
必需
字符串^([a-f0-9]{24})$

用于标识角色的唯一的 24 位十六进制数字字符串。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

返回指定的云提供商访问角色

返回具有指定 ID 且有权访问指定项目的访问角色。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

roleId
必需
字符串^([a-f0-9]{24})$

用于标识角色的唯一的 24 位十六进制数字字符串。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "providerName": "AWS",
  • "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
  • "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
  • "authorizedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "featureUsages": [
    ],
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
  • "roleId": "32b6e34b3d91647abb20e7b8"
}

授权一个云提供商访问角色

授予指定访问权限角色对指定项目的访问权限。 要使用此资源，请求的API密钥必须具有“项目所有者”角色。 此API端点是为MongoDB Cloud 服务创建统一访问权限过程中的一个步骤。 这不是GCP服务帐户访问权限所必需的。

设置对云提供商的访问权限
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

roleId
必需
字符串^([a-f0-9]{24})$

用于标识角色的唯一的 24 位十六进制数字字符串。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

授予指定访问角色对指定项目的访问权限。

提供商名称
必需
字符串

用于标识角色的云提供商的人类可读标签。

iamAssumedRoleArn
字符串 [ 20 .. 2048 ] 个字符

Amazon 资源名称 (ARN)，用于标识 MongoDB Cloud 在访问您的 AWS 账户中的资源时所使用的 Amazon Web Services (AWS) 身份和访问管理 (IAM) 角色。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "providerName": "AWS",
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
例子
{
  • "providerName": "AWS",
  • "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
  • "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
  • "authorizedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "featureUsages": [
    ],
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
  • "roleId": "32b6e34b3d91647abb20e7b8"
}

集群中断模拟

返回、开始或结束集群停电模拟。

结束中断模拟

结束集群中断模拟。

集群中断模拟
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，标识正在进行断电模拟的集群。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2019-08-24T14:15:22Z",
  • "state": "START_REQUESTED"
}

返回一次停电模拟

返回一个集群的一次停电模拟。

集群中断模拟
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，标识正在进行断电模拟的集群。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2019-08-24T14:15:22Z",
  • "state": "START_REQUESTED"
}

开始停电模拟

开始集群停电模拟。

集群中断模拟
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

用于标识正在进行停电模拟的集群的人类可读标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

描述中断模拟。

数组 对象 (AtlasClusterOutageSimulationOutageFilter) non-empty

指定集群中断模拟类型的设置列表。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "outageFilters": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2019-08-24T14:15:22Z",
  • "state": "START_REQUESTED"
}

集群

返回、添加、编辑和删除数据库部署。对集群配置的更改可能会影响成本。此资源需要您的项目 ID。

返回所有项目中的所有授权集群

返回您有权访问的所有项目中所有集群的详细信息。集群包含一组维护着相同数据集的主机。响应不包括多云集群。要使用此资源，请求的 API 密钥可以具有任何集群级别的角色。

授权：
DigestAuth服务账户
查询参数
envelope
布尔
默认： false
示例： envelope=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

返回一个项目中的所有集群

返回您可以访问的特定项目中所有集群的详细信息。集群包含一组维护相同数据集的主机。响应包括具有不对称大小分片的集群。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。此功能不适用于无服务器集群。

此终结点还可用于使用 createCluster 终结点创建的 Flex 集群，或是在 2026 年 1 月之前已迁移到 Flex 集群的原 M2/M5 集群。请改用面向 Flex 集群的 listFlexClusters 终结点。已弃用的版本：v2-{2023-02-01}、v2-{2023-01-01}

listFlexClusters
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

pretty
布尔
默认： false
示例： pretty=false

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

includeDeletedWithRetainedBackups
布尔
默认： false

指示是否返回具有保留备份的集群的标志。

响应

响应样本

内容类型
application/vnd.atlas.2024-08-05+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

从一个项目创建一个集群

在指定项目中创建一个集群。集群包含一组维护相同数据集的主机。此资源可以创建具有不对称大小分片的集群。每个项目最多支持 25 个数据库部署。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。此功能不适用于无服务器集群。

请注意，使用 M2 或 M5 的 instanceSize 会改为创建一个 Flex 集群。对 M2 或 M5 的 instanceSize 的支持将于 2026 年 1 月停止。我们建议今后使用 createFlexCluster API 来进行此类配置。已弃用的版本：v2-{2024-08-05}、v2-{2023-02-01}、v2-{2023-01-01}

createFlexCluster
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-10-23+json

在此项目中创建的集群。

acceptDataRisksAndForceReplicaSetReconfig
字符串 <date-time>

如果由于区域停电而需要重新配置以重新获得主节点，请与拓扑结构重新配置一起提交此字段，以请求新的区域抗停电拓扑。如果复制的写入操作（甚至多数提交的写入操作）尚未复制到新的主节点，则在大多数可选举节点中断期间强制重新配置会带来数据丢失的风险。MongoDB Atlas 文档包含更多信息。要继续执行存在该风险的操作，请将 acceptDataRisksAndForceReplicaSetReconfig 设置为当前日期。

在区域中断期间重新配置副本集
对象 (ApiAtlasClusterAdvancedConfigurationView)

配置高级配置详细信息子集的一组设置。

backupEnabled
布尔
默认： false

指示集群是否可以执行备份的标志。如果设置为 true，则集群可以执行备份。对于 NVMe 集群，必须将此值设置为 true。备份对专用集群使用云备份，对租户集群使用共享集群备份。如果设置为 false，则集群不使用备份。

对象 （MongoDB Connector for Business Intelligence 设置）

为此集群配置 MongoDB Connector for Business Intelligence 所需的设置。

MongoDB Connector for Business Intelligence
clusterType
字符串
枚举： “REPLICASET” "SHARDED" "GEOSHARDED"

组成该集群的节点的配置。

configServerManagementMode
字符串
默认： "ATLAS_MANAGED"
枚举： "ATLAS_MANAGED" "FIXED_TO_DEDICATED"

用于创建或更新分片集群的配置服务器管理模式。

配置为 ATLAS_MANAGED 时，atlas 可能会自动切换集群的配置服务器类型，以获得最佳性能并节省成本。

当配置为 FIXED_TO_DEDICATED 时，集群将始终使用专用的配置服务器。

MongoDB 分片集群配置服务器
diskWarmingMode
字符串
默认： “FULLY_WARMED”
枚举： “FULLY_WARMED” "VISIBLE_EARLIER"

磁盘预热模式选择

减少从节点磁盘升温的影响
encryptionAtRestProvider
字符串
枚举： "NONE" "AWS" "AZURE" "GCP"

管理客户密钥的云服务提供商，为集群提供额外的静态加密层。要为静态加密启用客户密钥管理，集群的 replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 设置必须为 M10 或更高，且 "backupEnabled" : false 或完全省略。

使用客户密钥管理进行静态加密
globalClusterSelfManagedSharding
布尔

设置该字段，用于在创建新的全球集群时配置分片管理模式。

当设置为 false 时，管理模式设置为 Atlas-托管分片。此模式可全面托管全球集群的分片，旨在提供无缝部署体验。

当设置为真时，管理模式设置为自我托管分片。此模式将分片的管理权交给您，旨在提供先进、灵活的部署体验。

一旦集群部署完毕，此设置就无法更改。

创建全球集群
数组 对象 （组件标签）
已弃用

长度在 1 到 255 个字符之间的键值对集合，用于标记和分类集群。MongoDB Cloud 控制台不显示您的标签。

集群标签已弃用，并将在未来版本中删除。我们强烈建议您改用资源标签。

对象 (EmployeeAccessGrantView)

MongoDB 员工被授予集群访问权限级别和过期时间。

mongoDBMajorVersion
字符串

集群的MongoDB主要版本。 设置为二进制主要版本。

创建时：从 MongoDB 的可用版本中进行选择，或者在 MongoDB Cloud 平台上，对当前建议的默认值保持不作指定。推荐的版本是最新的长期支持版本。在整个发布周期中，默认值并不保证是最新发布的版本。有关特定项目中可用的版本，请参阅链接的文档或使用项目 LTS 版本端点的 API 端点。

更新时：一次只能增加 1 个主要版本的版本。 如果将集群固定到比当前 MongoDB 版本低一个主要版本的 MongoDB 功能兼容版本，则 MongoDB 版本可以降级到上一个主要版本。

Atlas 中可用的 MongoDB 版本
名称
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

paused
布尔

指示集群是否已暂停的标志。

pitEnabled
布尔

指示集群是否使用连续云备份的标志。

持续的云备份
redactClientLogData
布尔

启用或禁用日志校订。

此设置将 mongod 或 mongos 配置为在登录之前编辑与给定日志事件相关的消息中的任何文档字段内容。这可以防止程序将存储在数据库上的潜在敏感数据写入诊断日志。错误或操作代码、行号和源文件名等元数据在日志中仍然可见。

将 redactClientLogData 与静态加密和 TLS/SSL（传输加密）结合使用，以帮助遵守监管要求。

注意：在集群上更改此设置将在更新集群后立即触发滚动重启。

日志编辑 (Redaction)
replicaSetScalingStrategy
字符串
默认： "WORKLOAD_TYPE"
枚举： "SEQUENTIAL" "WORKLOAD_TYPE" "NODE_TYPE"

设置此字段以配置集群的副本集扩展模式。

默认情况下，Atlas 在 WORKLOAD_TYPE 下进行扩展。此模式允许 Atlas 将分析节点与操作节点并行扩展。

当配置为 SEQUENTIAL 时， Atlas 会按顺序扩展所有节点。该模式适用于稳态工作负载和执行对延迟敏感的二次读取的应用程序。

当配置为 NODE_TYPE 时，Atlas 会将可选举节点与只读节点和分析节点并行扩展。此模式适用于需要频繁和及时的集群层扩展的大型动态工作负载。这是最快的扩展策略，但在执行大量从节点读取时，它可能会影响工作负载的延迟。

修改副本集扩展模式
数组 对象 (复制规范）

用于配置集群区域的设置列表。该数组每个分片有一个对象，表示每个分片中的节点配置。对于副本集，只有一个对象表示节点配置。

rootCertType
字符串
默认： “ISRGROOTX1”
值： “ISRGROOTX1”

MongoDB Cloud 集群使用的根证书颁发机构。MongoDB Cloud 支持 Internet Security Research Group。

数组 对象 (Resource Tag)

包含长度介于 1 到 255 个字符之间的键值对的列表，用于对集群进行标记和分类。

Resource Tags
terminationProtectionEnabled
布尔
默认： false

指示是否在集群上启用终止保护的标记。如果设置为 true，MongoDB Cloud 将不会删除集群。如果设置为 false，MongoDB Cloud 将删除集群。

versionReleaseSystem
字符串
默认： “LTS”
枚举： “LTS” "CONTINUOUS"

集群维护 MongoDB 版本的方法。如果值为 CONTINUOUS，则不得指定 mongoDBMajorVersion。

响应

请求样本

内容类型
application/vnd.atlas.2024-10-23+json

集群

{
  • "clusterType": "SHARDED",
  • "name": "myCluster",
  • "replicationSpecs": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2024-10-23+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "advancedConfiguration": {
    },
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "configServerType": "DEDICATED",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "featureCompatibilityVersion": "string",
  • "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBEmployeeAccessGrant": {},
  • "mongoDBMajorVersion": "string",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "redactClientLogData": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

返回所有云提供商地区

返回指定云提供商在指定层级的可用区域列表。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

pretty
布尔
默认： false
示例： pretty=false

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

providers
数组 字符串

要检索其区域的云提供商。指定多个提供商时，响应只能返回支持多云集群的层级和区域。

tier
字符串

用于检索区域的集群层。

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

升级一个共享层集群

将共享层集群升级为指定项目中的 Flex 或专用 (M10+) 集群。如需使用此资源，请求的 API 密钥必须具有“项目集群管理员”角色。每个项目最多支持 25 个集群。

此终结点还可用于升级使用 createCluster API 创建的 Flex 集群，或已迁移到 Flex 集群的原 M2/M5 集群，在 2026 年 1 月之前使用 instanceSizeName 升级到“M2”或“M5”。此功能可用至 2026 年 1 月，之后将仅适用于 M0 集群。请改用 upgradeFlexCluster 终结点。

upgradeFlexCluster
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

指定项目中共享层集群升级的详细信息。

acceptDataRisksAndForceReplicaSetReconfig
字符串 <date-time>

如果由于区域停电而需要重新配置以重新获得主节点，请与拓扑结构重新配置一起提交此字段，以请求新的区域抗停电拓扑。如果复制的写入操作（甚至多数提交的写入操作）尚未复制到新的主节点，则在大多数可选举节点中断期间强制重新配置会带来数据丢失的风险。MongoDB Atlas 文档包含更多信息。要继续执行存在该风险的操作，请将 acceptDataRisksAndForceReplicaSetReconfig 设置为当前日期。

在区域中断期间重新配置副本集
对象 (ApiAtlasClusterAdvancedConfigurationView)

配置高级配置详细信息子集的一组设置。

对象 （集群自动缩放设置）

集群可扩展的实例大小范围。

集群自动伸缩
backupEnabled
布尔

指示集群是否可以执行备份的标志。如果设置为 true，则集群可以执行备份。对于 NVMe 集群，必须将此值设置为 true。备份对专用集群使用云备份，对租户集群使用共享集群备份。如果设置为 false ，则集群不使用 MongoDB Cloud 备份。

对象 （MongoDB Connector for Business Intelligence 设置）

为此集群配置 MongoDB Connector for Business Intelligence 所需的设置。

MongoDB Connector for Business Intelligence
clusterType
字符串
枚举： “REPLICASET” "SHARDED" "GEOSHARDED"

组成该集群的节点的配置。

configServerManagementMode
字符串
默认： "ATLAS_MANAGED"
枚举： "ATLAS_MANAGED" "FIXED_TO_DEDICATED"

用于创建或更新分片集群的配置服务器管理模式。

配置为 ATLAS_MANAGED 时，atlas 可能会自动切换集群的配置服务器类型，以获得最佳性能并节省成本。

当配置为 FIXED_TO_DEDICATED 时，集群将始终使用专用的配置服务器。

MongoDB 分片集群配置服务器
diskSizeGB
数字 <double> [ 10 .. 4096 ]

实例数据卷的存储容量，以 GB 为单位。增加这一数字可提高容量。

此值在 M0/M2/M5 集群上不可配置。

如果设置了 replicationSpecs，则 MongoDB Cloud 需要此参数。

如果指定的磁盘大小低于最小值 (10 GB)，则该参数默认为最小磁盘大小值。

存储费用的计算取决于您选择的是默认值还是自定义值。

磁盘存储的最大值不能超过所选集群最大 RAM 的 50 倍。如果您需要更多存储空间，请考虑将集群升级到更高层级。

diskWarmingMode
字符串
默认： “FULLY_WARMED”
枚举： “FULLY_WARMED” "VISIBLE_EARLIER"

磁盘预热模式选择

减少从节点磁盘升温的影响
encryptionAtRestProvider
字符串
枚举： "NONE" "AWS" "AZURE" "GCP"

管理客户密钥的云服务提供商，为集群提供额外的静态加密层。

使用客户密钥管理进行静态加密
globalClusterSelfManagedSharding
布尔

设置该字段，用于在创建新的全球集群时配置分片管理模式。

当设置为 false 时，管理模式设置为 Atlas-托管分片。此模式可全面托管全球集群的分片，旨在提供无缝部署体验。

当设置为真时，管理模式设置为自我托管分片。此模式将分片的管理权交给您，旨在提供先进、灵活的部署体验。

一旦集群部署完毕，此设置就无法更改。

创建全球集群
数组 对象 （组件标签）
已弃用

长度在 1 到 255 个字符之间的键值对集合，用于标记和分类集群。MongoDB Cloud 控制台不显示您的标签。

集群标签已弃用，并将在未来版本中删除。我们强烈建议您改用资源标签。

对象 (EmployeeAccessGrantView)

MongoDB 员工被授予集群访问权限级别和过期时间。

mongoDBMajorVersion
字符串

集群的主要 MongoDB 版本。

创建时：从 MongoDB 的可用版本中进行选择，或者在 MongoDB Cloud 平台上，对当前建议的默认值保持不作指定。推荐的版本是最新的长期支持版本。在整个发布周期中，默认值并不保证是最新发布的版本。有关特定项目中可用的版本，请参阅链接的文档或使用项目 LTS 版本端点的 API 端点。

更新时：一次只能增加 1 个主要版本的版本。 如果将集群固定到比当前 MongoDB 版本低一个主要版本的 MongoDB 功能兼容版本，则 MongoDB 版本可以降级到上一个主要版本。

Atlas 中可用的 MongoDB 版本
MongoDB 版本
字符串([\d]+\.[\d]+\.[\d]+)

集群运行的 MongoDB 版本。

名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

numShards
整型 <int32> [ 1 .. 50 ]
默认： 1

可为分片集群部署的分片数量最多为 50 个。该资源返回 1 以指示副本集，并返回 2 及更高值以指示分片集群。返回值等于集群中分片的数量。

分片
paused
布尔

指示集群是否已暂停的标志。

pitEnabled
布尔

指示集群是否使用连续云备份的标志。

持续的云备份
providerBackupEnabled
布尔

指示 M10 或更高集群能否执行“云备份”的标志。如果设置为 true，则集群可以执行备份。如果此项和 backupEnabled 设置为 false，则集群不使用 MongoDB Cloud 备份。

对象 （集群的云服务提供商设置）

用于配置预配的 MongoDB 主机的云提供商设置群组。

replicaSetScalingStrategy
字符串
默认： "WORKLOAD_TYPE"
枚举： "SEQUENTIAL" "WORKLOAD_TYPE" "NODE_TYPE"

设置此字段以配置集群的副本集扩展模式。

默认情况下，Atlas 在 WORKLOAD_TYPE 下进行扩展。此模式允许 Atlas 将分析节点与操作节点并行扩展。

当配置为 SEQUENTIAL 时， Atlas 会按顺序扩展所有节点。该模式适用于稳态工作负载和执行对延迟敏感的二次读取的应用程序。

当配置为 NODE_TYPE 时，Atlas 会将可选举节点与只读节点和分析节点并行扩展。此模式适用于需要频繁和及时的集群层扩展的大型动态工作负载。这是最快的扩展策略，但在执行大量从节点读取时，它可能会影响工作负载的延迟。

修改副本集扩展模式
replicationFactor
整型 <int32>
已弃用
默认： 3
枚举： 3 5 7

属于副本集的节点数量。每个节点都保留数据库的副本，提供高可用性和数据冗余。请改用 replicationSpecs。

对象 (地区配置）

MongoDB Cloud 配置集群节点的物理位置。

数组 对象 (LegacyReplicationSpec)

用于配置集群区域的设置列表。

  • 对于全局集群，数组中的每个对象代表 MongoDB Cloud 部署集群节点的一个区域。
  • 对于非全局分片集群和副本集，单个对象表示 MongoDB Cloud 部署集群节点的位置。
rootCertType
字符串
默认： “ISRGROOTX1”
值： “ISRGROOTX1”

MongoDB Atlas 集群使用的根证书颁发机构。MongoDB Cloud 支持 Internet Security Research Group。

数组 对象 (Resource Tag)

包含长度介于 1 到 255 个字符之间的键值对的列表，用于对集群进行标记和分类。

Resource Tags
terminationProtectionEnabled
布尔
默认： false

指示是否在集群上启用终止保护的标记。如果设置为 true，MongoDB Cloud 将不会删除集群。如果设置为 false，MongoDB Cloud 将删除集群。

versionReleaseSystem
字符串
默认： “LTS”
枚举： “LTS” "CONTINUOUS"

集群维护 MongoDB 版本的方法。如果值为 CONTINUOUS，则不得指定 mongoDBMajorVersion。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "advancedConfiguration": {
    },
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "labels": [
    ],
  • "mongoDBEmployeeAccessGrant": {
    },
  • "mongoDBMajorVersion": "5.0",
  • "mongoDBVersion": "5.0.25",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "advancedConfiguration": {
    },
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "configServerType": "DEDICATED",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "featureCompatibilityVersion": "string",
  • "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBEmployeeAccessGrant": {},
  • "mongoDBMajorVersion": "5.0",
  • "mongoDBVersion": "5.0.25",
  • "mongoURI": "string",
  • "mongoURIUpdated": "2019-08-24T14:15:22Z",
  • "mongoURIWithOptions": "string",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "srvAddress": "string",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

将一个共享层集群升级为无服务器实例（已弃用）

自 2025 起，由于我们不再支持创建新的无服务器实例，此终结点已被弃用。请使用 upgradeFlexCluster 终结点来升级 Flex 集群。

将共享层集群升级为指定项目中的无服务器实例。如需使用此资源，请求的“API 密钥”必须具有“项目集群管理器”角色。

upgradeFlexCluster
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

指定项目中共享层集群升级的详细信息。

名称
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

必需
对象 （无服务器实例的云服务提供商设置）

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

对象 (无服务器备份选项）

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

数组 对象 (Resource Tag)

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

terminationProtectionEnabled
布尔
默认： false

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

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

从一个项目删除一个集群

从指定项目中删除一个集群。 必须禁用终止保护才能删除集群。 要使用此资源，请求的 API 密钥必须具有项目所有者角色。 此功能不适用于无服务器集群。

此终结点还可用于使用 createCluster 终结点创建的 Flex 集群，或是在 2026 年 1 月之前已迁移到 Flex 集群的原 M2/M5 集群。请改用面向 Flex 集群的 deleteFlexCluster 终结点。已弃用的版本：v2-{2023-01-01}

deleteFlexCluster
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

retainBackups
布尔

标志，用于指示是否为已删除的专用集群保留备份快照。

响应

响应样本

内容类型
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

从一个项目返回一个集群

返回指定项目中一个集群的详细信息。集群包含一组维护相同数据集的主机。响应包括具有不对称大小分片的集群。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。此功能不适用于无服务器集群。

此终结点还可用于使用 createCluster 终结点创建的 Flex 集群，或是在 2026 年 1 月之前已迁移到 Flex 集群的原 M2/M5 集群。请改用面向 Flex 集群 getFlexCluster 终结点。已弃用的版本：v2-{2023-02-01}、v2-{2023-01-01}

getFlexCluster
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-08-05+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "advancedConfiguration": {
    },
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "configServerType": "DEDICATED",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "featureCompatibilityVersion": "string",
  • "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBEmployeeAccessGrant": {},
  • "mongoDBMajorVersion": "string",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "redactClientLogData": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

从一个项目修改一个集群

更新指定项目中一个集群的详细信息。集群包含一组维护相同数据集的主机。此资源可以更新具有不对称大小分片的集群。要更新集群的终止保护，请求的 API 密钥必须具有项目所有者角色。对于所有其他更新，请求的 API 密钥必须具有项目集群管理员角色。您无法修改已暂停的集群（paused : true）。您必须调用此端点来设置 paused : false。在此端点使用 paused : false 响应后，您可以再次调用它以对集群进行更改。此功能不适用于无服务器集群。已弃用的版本：v2-{2024-08-05}、v2-{2023-02-01}、v2-{2023-01-01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-10-23+json

指定项目中要更新的集群。

acceptDataRisksAndForceReplicaSetReconfig
字符串 <date-time>

如果由于区域停电而需要重新配置以重新获得主节点，请与拓扑结构重新配置一起提交此字段，以请求新的区域抗停电拓扑。如果复制的写入操作（甚至多数提交的写入操作）尚未复制到新的主节点，则在大多数可选举节点中断期间强制重新配置会带来数据丢失的风险。MongoDB Atlas 文档包含更多信息。要继续执行存在该风险的操作，请将 acceptDataRisksAndForceReplicaSetReconfig 设置为当前日期。

在区域中断期间重新配置副本集
对象 (ApiAtlasClusterAdvancedConfigurationView)

配置高级配置详细信息子集的一组设置。

backupEnabled
布尔
默认： false

指示集群是否可以执行备份的标志。如果设置为 true，则集群可以执行备份。对于 NVMe 集群，必须将此值设置为 true。备份对专用集群使用云备份，对租户集群使用共享集群备份。如果设置为 false，则集群不使用备份。

对象 （MongoDB Connector for Business Intelligence 设置）

为此集群配置 MongoDB Connector for Business Intelligence 所需的设置。

MongoDB Connector for Business Intelligence
clusterType
字符串
枚举： “REPLICASET” "SHARDED" "GEOSHARDED"

组成该集群的节点的配置。

configServerManagementMode
字符串
默认： "ATLAS_MANAGED"
枚举： "ATLAS_MANAGED" "FIXED_TO_DEDICATED"

用于创建或更新分片集群的配置服务器管理模式。

配置为 ATLAS_MANAGED 时，atlas 可能会自动切换集群的配置服务器类型，以获得最佳性能并节省成本。

当配置为 FIXED_TO_DEDICATED 时，集群将始终使用专用的配置服务器。

MongoDB 分片集群配置服务器
diskWarmingMode
字符串
默认： “FULLY_WARMED”
枚举： “FULLY_WARMED” "VISIBLE_EARLIER"

磁盘预热模式选择

减少从节点磁盘升温的影响
encryptionAtRestProvider
字符串
枚举： "NONE" "AWS" "AZURE" "GCP"

管理客户密钥的云服务提供商，为集群提供额外的静态加密层。要为静态加密启用客户密钥管理，集群的 replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 设置必须为 M10 或更高，且 "backupEnabled" : false 或完全省略。

使用客户密钥管理进行静态加密
globalClusterSelfManagedSharding
布尔

设置该字段，用于在创建新的全球集群时配置分片管理模式。

当设置为 false 时，管理模式设置为 Atlas-托管分片。此模式可全面托管全球集群的分片，旨在提供无缝部署体验。

当设置为真时，管理模式设置为自我托管分片。此模式将分片的管理权交给您，旨在提供先进、灵活的部署体验。

一旦集群部署完毕，此设置就无法更改。

创建全球集群
数组 对象 （组件标签）
已弃用

长度在 1 到 255 个字符之间的键值对集合，用于标记和分类集群。MongoDB Cloud 控制台不显示您的标签。

集群标签已弃用，并将在未来版本中删除。我们强烈建议您改用资源标签。

对象 (EmployeeAccessGrantView)

MongoDB 员工被授予集群访问权限级别和过期时间。

mongoDBMajorVersion
字符串

集群的MongoDB主要版本。 设置为二进制主要版本。

创建时：从 MongoDB 的可用版本中进行选择，或者在 MongoDB Cloud 平台上，对当前建议的默认值保持不作指定。推荐的版本是最新的长期支持版本。在整个发布周期中，默认值并不保证是最新发布的版本。有关特定项目中可用的版本，请参阅链接的文档或使用项目 LTS 版本端点的 API 端点。

更新时：一次只能增加 1 个主要版本的版本。 如果将集群固定到比当前 MongoDB 版本低一个主要版本的 MongoDB 功能兼容版本，则 MongoDB 版本可以降级到上一个主要版本。

Atlas 中可用的 MongoDB 版本
名称
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

paused
布尔

指示集群是否已暂停的标志。

pitEnabled
布尔

指示集群是否使用连续云备份的标志。

持续的云备份
redactClientLogData
布尔

启用或禁用日志校订。

此设置将 mongod 或 mongos 配置为在登录之前编辑与给定日志事件相关的消息中的任何文档字段内容。这可以防止程序将存储在数据库上的潜在敏感数据写入诊断日志。错误或操作代码、行号和源文件名等元数据在日志中仍然可见。

将 redactClientLogData 与静态加密和 TLS/SSL（传输加密）结合使用，以帮助遵守监管要求。

注意：在集群上更改此设置将在更新集群后立即触发滚动重启。

日志编辑 (Redaction)
replicaSetScalingStrategy
字符串
默认： "WORKLOAD_TYPE"
枚举： "SEQUENTIAL" "WORKLOAD_TYPE" "NODE_TYPE"

设置此字段以配置集群的副本集扩展模式。

默认情况下，Atlas 在 WORKLOAD_TYPE 下进行扩展。此模式允许 Atlas 将分析节点与操作节点并行扩展。

当配置为 SEQUENTIAL 时， Atlas 会按顺序扩展所有节点。该模式适用于稳态工作负载和执行对延迟敏感的二次读取的应用程序。

当配置为 NODE_TYPE 时，Atlas 会将可选举节点与只读节点和分析节点并行扩展。此模式适用于需要频繁和及时的集群层扩展的大型动态工作负载。这是最快的扩展策略，但在执行大量从节点读取时，它可能会影响工作负载的延迟。

修改副本集扩展模式
数组 对象 (复制规范）

用于配置集群区域的设置列表。该数组每个分片有一个对象，表示每个分片中的节点配置。对于副本集，只有一个对象表示节点配置。

rootCertType
字符串
默认： “ISRGROOTX1”
值： “ISRGROOTX1”

MongoDB Cloud 集群使用的根证书颁发机构。MongoDB Cloud 支持 Internet Security Research Group。

数组 对象 (Resource Tag)

包含长度介于 1 到 255 个字符之间的键值对的列表，用于对集群进行标记和分类。

Resource Tags
terminationProtectionEnabled
布尔
默认： false

指示是否在集群上启用终止保护的标记。如果设置为 true，MongoDB Cloud 将不会删除集群。如果设置为 false，MongoDB Cloud 将删除集群。

versionReleaseSystem
字符串
默认： “LTS”
枚举： “LTS” "CONTINUOUS"

集群维护 MongoDB 版本的方法。如果值为 CONTINUOUS，则不得指定 mongoDBMajorVersion。

响应

请求样本

内容类型
application/vnd.atlas.2024-10-23+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "advancedConfiguration": {
    },
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "labels": [
    ],
  • "mongoDBEmployeeAccessGrant": {
    },
  • "mongoDBMajorVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "redactClientLogData": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

响应样本

内容类型
application/vnd.atlas.2024-10-23+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "advancedConfiguration": {
    },
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "configServerType": "DEDICATED",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "featureCompatibilityVersion": "string",
  • "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBEmployeeAccessGrant": {},
  • "mongoDBMajorVersion": "string",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "redactClientLogData": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

获取分片集群集群的集群内部配置 AutoScaling 操作 已弃用

返回分片的集群的 AutoScaling 内部配置。此端点可用于诊断目的，以确保从旧 API 更新的分片的集群已获得对每个分片独立 AutoScaling 的支持。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-08-05+json
{
  • "autoScalingMode": "INDEPENDENT_SHARD_SCALING"
}

返回单个集群的高级配置选项

返回指定项目中一个集群的高级配置详细信息。集群包含一组维护相同数据集的主机。高级配置详细信息包括读/写关注、索引和 oplog 限制以及其他数据库设置。此功能不适用于 M0 免费集群、M2 与 M5 共享层集群、Flex 集群或无服务器集群。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。已弃用的版本：v2-{2023-01-01}

Atlas 全球集群
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-08-05+json
{
  • "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  • "chunkMigrationConcurrency": 0,
  • "customOpensslCipherConfigTls12": [
    ],
  • "defaultMaxTimeMS": 0,
  • "defaultWriteConcern": "string",
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": true,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "queryStatsLogVerbosity": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 0,
  • "tlsCipherConfigMode": "CUSTOM",
  • "transactionLifetimeLimitSeconds": 1
}

更新一个集群的高级配置选项

更新指定项目中一个集群的高级配置详细信息。集群包含一组维护相同数据集的主机。高级配置详细信息包括读/写关注、索引和 oplog 限制以及其他数据库设置。要使用此资源，请求的 API 密钥必须具有项目集群管理员角色。此功能不适用于 M0 免费集群、M2 与 M5 共享层集群、Flex 集群或无服务器集群。已弃用的版本：v2-{2023-01-01}

Atlas 全球集群
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-08-05+json

要为指定项目中的一个集群添加的高级配置详细信息。

changeStreamOptionsPreAndPostImagesExpireAfterSeconds
chunkMigrationConcurrency
整型 <int32>

源分片和接收分片上用于数据段迁移的线程数。线程数不应超过分片集群中 CPU 内核总数的一半。

该选项对应于“mongod”配置文件中的“chunkMigrationConcurrency”选项。
customOpensslCipherConfigTls12
数组 字符串
列项枚举： "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"

TLS 1.2 的自定义 OpenSSL 密码套件列表。 此字段仅在 tlsCipherConfigMode设立为 CUSTOM 时有效。

该选项对应于“opensslCipherConfig”、“mongod”配置文件选项。
defaultMaxTimeMS
整型 <int32>

单个读取操作必须在默认时间限制内完成（以毫秒为单位）。

此选项对应于 defaultMaxTimeMS 集群参数。
默认写关注
字符串

当没有写入操作被驱动程序指定时，请求 MongoDB 确认的默认级别。

该选项对应于隐式默认写关注。
Javascript 启用
布尔

指示集群是否允许执行服务器端执行 JavaScript 的操作的标志。 使用 8.0 + 时，我们建议禁用服务器端 JavaScript 并使用聚合管道的操作符作为性能更高的替代方案。

此选项相当于为集群中的每个“mongod”和“mongos”修改“security.javascriptEnabled”配置文件选项。
minimumEnabledTlsProtocol
字符串
枚举： "TLS1_0" “TLS1_1” "TLS1_2"

集群接受的用于传入连接的最低传输层安全性 (TLS) 版本。使用 TLS 1.0 或 1.1 的集群应考虑将 TLS 1.2 设置为最低 TLS 协议版本。

该选项对应于“net.ssl.disabledProtocols”。“mongod”配置文件选项。
noTableScan
布尔

该标志指示集群是否禁用执行需要集合扫描才能返回结果的查询。

该选项对应于“notablescan”“mongod”配置文件选项。
oplogMinRetentionHours
数字或空值 <double>

集群 oplog 的最小保留窗口以小时为单位。null 值表示集群使用 MongoDB Cloud 计算的默认最小 oplog 窗口。

该选项对应于 `storage.oplogMinRetentionHours` “mongod”配置文件选项。
oplogSizeMB
整数或空值 <int32>

集群 oplog 的存储限制（以兆字节为单位）。null 值表示集群使用 MongoDB Cloud 计算的默认 oplog 大小。

该选项对应于“replication.oplogSizeMB”“mongod”配置文件选项。
queryStatsLogVerbosity
整型 <int32>

可设置为 1（禁用）或 3（启用）。当设置为 3 时，Atlas 将在 MongoDB 日志中包含经过编辑和匿名的 $queryStats 输出。$queryStats 输出不包含文字或字段值。启用此设置可能会影响集群的性能。

此选项对应于 logComponentVerbosity 服务器参数的 queryStats 组件。
sampleRefreshIntervalBIConnector
整型 <int32> >= 0
默认： 0

mongsqld 进程重新进行数据采样以创建其关系模式的时间间隔（以秒为单位）。

该选项对应于“sampleRefreshIntervalSecs”“mongosqld”选项。
sampleSizeBIConnector
整型 <int32> >= 0

收集架构信息时要采样的每个数据库的文档数。

此选项对应于“sampleSize”和“mongosqld”选项。
tlsCipherConfigMode
字符串
枚举： "CUSTOM" "DEFAULT"

TLS 密码套件配置模式。 默认模式使用默认密码套件。 自定义模式允许您为 TLS 1.2 和 TLS 1.3 指定自定义密码套件。

transactionLifetimeLimitSeconds
整型 <int64> >= 1

多文档事务的生命周期（以秒为单位）。Atlas 认为超过此限制的事务已过期，因此会通过定期清理过程予以中止。

该选项对应于“transactionLifetimeLimitSeconds”“mongod”配置文件选项。

响应

请求样本

内容类型
application/vnd.atlas.2024-08-05+json
{
  • "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  • "chunkMigrationConcurrency": 0,
  • "customOpensslCipherConfigTls12": [
    ],
  • "defaultMaxTimeMS": 0,
  • "defaultWriteConcern": "string",
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": true,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "queryStatsLogVerbosity": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 0,
  • "tlsCipherConfigMode": "CUSTOM",
  • "transactionLifetimeLimitSeconds": 1
}

响应样本

内容类型
application/vnd.atlas.2024-08-05+json
{
  • "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  • "chunkMigrationConcurrency": 0,
  • "customOpensslCipherConfigTls12": [
    ],
  • "defaultMaxTimeMS": 0,
  • "defaultWriteConcern": "string",
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": true,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "queryStatsLogVerbosity": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 0,
  • "tlsCipherConfigMode": "CUSTOM",
  • "transactionLifetimeLimitSeconds": 1
}

测试一个集群的故障转移

为指定项目中的指定集群启动故障转移测试。集群包含一组维护相同数据集的主机。故障转移测试检查 MongoDB Cloud 如何处理集群主节点的故障。在测试过程中，MongoDB Cloud 关闭主节点并选举新的主节点。要使用此资源，请求的 API 密钥必须具有项目集群管理员角色。已弃用的版本：v2-{2023-01-01}

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "reason": "Unauthorized"
}

返回所有集群操作的状态

返回您在指定项目中对指定集群做出的所有更改的状态。使用此资源检查 MongoDB Cloud 在处理您的更改方面的进度。响应不包括部署新的专用集群。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{}

授予 MongoDB 员工一个集群的集群访问权限。

授予 MongoDB 员工在给定持续时间内在指定级别访问一个集群的集群访问权限。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-08-05+json

授予访问级别和有效期。

expirationTime
必需
字符串 <date-time>

员工访问权限授予的到期日期。

grantType
必需
字符串
枚举： “CLUSTER_DATABASE_LOGS” “CLUSTER_INFRASTRUCTURE” “CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA”

授予 MongoDB 员工的访问权限级别。

响应

请求样本

内容类型
application/vnd.atlas.2024-08-05+json
{
  • "expirationTime": "2019-08-24T14:15:22Z",
  • "grantType": "CLUSTER_DATABASE_LOGS"
}

响应样本

内容类型
application/vnd.atlas.2024-08-05+json
{ }

从一个项目中固定一个集群的 FCV

将特征兼容性版本 (FCV) 固定到当前 MongoDB 版本并设置固定到期日期。如果集群已存在 FCV 固定，则调用此方法只会更新现有固定的到期日期，而不会重新固定 FCV。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2024-05-30+json

用于调整 FCV 固定配置的可选请求参数。

到期日期
字符串 <date-time>

固定 FCV 的到期日期。如果未指定，则到期日期将默认为自最初固定 FCV 之日起 4 周。请注意，此字段自固定日期起不得超过 4 周。

响应

请求样本

内容类型
application/vnd.atlas.2024-05-30+json
{
  • "expirationDate": "2019-08-24T14:15:22Z"
}

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
{ }

撤销已授予 MongoDB 员工对一个集群的集群访问权限。

撤销先前授予的 MongoDB 员工集群访问权限。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-08-05+json
{ }

从一个项目中取消固定一个集群的 FCV

取消固定当前已修复的功能兼容性版本 (FCV)。此功能不适用于快速发布的集群。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2024-05-30+json
{ }

将样本数据集请求加载到集群中

请求将 MongoDB 样本数据集加载到指定集群。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

可读的标签，用于标识您加载样本数据集的集群。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "errorMessage": "string",
  • "state": "WORKING"
}

检查集群样本数据集请求的状态

检查将样本数据集加载到一个集群的进度。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

sampleDatasetId
必需
字符串^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识已加载的样本数据集。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "errorMessage": "string",
  • "state": "WORKING"
}

集合级别指标

返回、添加和编辑指定集群或进程的固定命名空间。还返回集合级别延迟指标数据。

返回固定命名空间

返回给定集群的固定命名空间列表，这是一组由用户手动选择的命名空间，用于收集查询延迟指标。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，用于标识要检索其固定命名空间的集群。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "pinnedNamespaces": [
    ]
}

添加固定命名空间

将提供的命名空间列表添加到现有的固定命名空间列表中，以便为给定的分组和集群收集集合级别的延迟指标

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，用于标识要将命名空间固定到的集群。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

请求正文模式：application/vnd.atlas.2023-11-15+json

用于指定查询延迟指标集合的命名空间字符串列表（数据库和集合名称的组合）。

namespaces
数组 字符串 unique

指定主机或集群上的命名空间字符串（数据库和集合的组合）列表。

响应

请求样本

内容类型
application/vnd.atlas.2023-11-15+json
{
  • "namespaces": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "pinnedNamespaces": [
    ]
}

Pin 命名空间

Pin 为给定群组和集群的集合级延迟指标集合提供了命名空间列表。 这将初始化固定的命名空间列表，或替换群组和集群的任何现有固定命名空间列表。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，用于标识要将命名空间固定到的集群。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

请求正文模式：application/vnd.atlas.2023-11-15+json

用于指定查询延迟指标集合的命名空间字符串列表（数据库和集合名称的组合）。

namespaces
数组 字符串 unique

指定主机或集群上的命名空间字符串（数据库和集合的组合）列表。

响应

请求样本

内容类型
application/vnd.atlas.2023-11-15+json
{
  • "namespaces": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "pinnedNamespaces": [
    ]
}

取消固定命名空间

取消固定为给定群组和集群的集合级延迟指标集合提供的命名空间列表

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，用于标识要从中取消固定命名空间的集群。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

请求正文模式：application/vnd.atlas.2023-11-15+json

用于指定查询延迟指标集合的命名空间字符串列表（数据库和集合名称的组合）。

namespaces
数组 字符串 unique

指定主机或集群上的命名空间字符串（数据库和集合的组合）列表。

响应

请求样本

内容类型
application/vnd.atlas.2023-11-15+json
{
  • "namespaces": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "pinnedNamespaces": [
    ]
}

从集群中返回排名的命名空间

在给定时间窗口内，按最高总执行时间（降序）排序，返回给定集群的命名空间子集。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，用于标识要将命名空间固定到的集群。

clusterView
必需
字符串
枚举： "primary" "secondary" "INDIVIDUAL_PROCESS"

人类可读标签，用于标识要检索其指标的集群拓扑结构。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

开始
字符串 <date-time>

MongoDB Cloud 开始报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

end
字符串 <date-time>

MongoDB Cloud 停止报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

period
字符串
示例： period=PT10H

Atlas 报告指标的持续时间。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。在未设置开始和结束时包含此参数。

响应

响应样本

内容类型
application/vnd.atlas.2023-11-15+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "identifierId": "string",
  • "rankedNamespaces": [
    ]
}

返回集群级查询延迟

获取给定命名空间的集合延迟统计集群级测量值列表。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，用于标识要检索其指标的集群。

clusterView
必需
字符串
枚举： "primary" "secondary" "INDIVIDUAL_PROCESS"

人类可读标签，用于标识要检索其指标的集群拓扑结构。

数据库名称
必需
字符串
示例： mydb

用于标识数据库的人类可读标签。

collectionName
必需
字符串
示例： mycoll

用于标识集合的用户可读标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

衡量标准
数组 字符串 unique
列项枚举： "READS_OPS" "READS_LATENCY" "AVERAGE_READS_LATENCY" "READS_P50_VALUE" "READS_P95_VALUE" "READS_P99_VALUE" "WRITES_OPS" "WRITES_LATENCY" “AVERAGE_WRITES_LATENCY” "WRITES_P50_VALUE" "WRITES_P95_VALUE" "WRITES_P99_VALUE" "COMMANDS_OPS" "COMMANDS_LATENCY" "AVERAGE_COMMANDS_LATENCY" "COMMANDS_P50_VALUE" "COMMANDS_P95_VALUE" "COMMANDS_P99_VALUE" "TOTAL_OPS" "TOTAL_LATENCY" "AVERAGE_TOTAL_OPS_LATENCY" "TOTAL_OPS_P50_VALUE" "TOTAL_OPS_P95_VALUE" "TOTAL_OPS_P99_VALUE"

包含您希望为关联数据系列检索的指标的列表。如果您未设置此参数，则此资源将返回所有集合延迟统计指标的数据序列。

开始
字符串 <date-time>

MongoDB Cloud 开始报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

end
字符串 <date-time>

MongoDB Cloud 停止报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

period
字符串
示例： period=PT10H

Atlas 报告指标的持续时间。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。在未设置开始和结束时包含此参数。

响应

响应样本

内容类型
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "string",
  • "clusterView": "string",
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "measurements": [
    ],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

返回所有指标名称

返回请求时指定项目的所有可用的 Coll 统计数据延迟指标名称及其各自的单位。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-11-15+json
{ }

从主机返回排名的命名空间

在给定时间窗口内，按最高总执行时间（降序）排名，返回给定进程的命名空间子集。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

processId
必需
字符串^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
示例： my.host.name.com:27017

为 MongoDB 进程提供服务的主机名和 IANA 端口的组合。主机必须是运行 MongoDB 进程（mongod 或 mongos）的主机的主机名、完全限定域名 (FQDN) 或 Internet 协议地址（IPv4 或 IPv6）。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

开始
字符串 <date-time>

MongoDB Cloud 开始报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

end
字符串 <date-time>

MongoDB Cloud 停止报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

period
字符串
示例： period=PT10H

Atlas 报告指标的持续时间。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。在未设置开始和结束时包含此参数。

响应

响应样本

内容类型
application/vnd.atlas.2023-11-15+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "identifierId": "string",
  • "rankedNamespaces": [
    ]
}

返回主机级查询延迟

获取给定命名空间的集合延迟统计进程级测量值列表

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

processId
必需
字符串^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
示例： my.host.name.com:27017

为 MongoDB 进程提供服务的主机名和 IANA 端口的组合。主机必须是运行 MongoDB 进程（mongod 或 mongos）的主机的主机名、完全限定域名 (FQDN) 或 Internet 协议地址（IPv4 或 IPv6）。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。

数据库名称
必需
字符串
示例： mydb

用于标识数据库的人类可读标签。

collectionName
必需
字符串
示例： mycoll

用于标识集合的用户可读标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

衡量标准
数组 字符串 unique
列项枚举： "READS_OPS" "READS_LATENCY" "AVERAGE_READS_LATENCY" "READS_P50_VALUE" "READS_P95_VALUE" "READS_P99_VALUE" "WRITES_OPS" "WRITES_LATENCY" “AVERAGE_WRITES_LATENCY” "WRITES_P50_VALUE" "WRITES_P95_VALUE" "WRITES_P99_VALUE" "COMMANDS_OPS" "COMMANDS_LATENCY" "AVERAGE_COMMANDS_LATENCY" "COMMANDS_P50_VALUE" "COMMANDS_P95_VALUE" "COMMANDS_P99_VALUE" "TOTAL_OPS" "TOTAL_LATENCY" "AVERAGE_TOTAL_OPS_LATENCY" "TOTAL_OPS_P50_VALUE" "TOTAL_OPS_P95_VALUE" "TOTAL_OPS_P99_VALUE"

包含您希望为关联数据系列检索的指标的列表。如果您未设置此参数，则此资源将返回所有集合延迟统计指标的数据序列。

开始
字符串 <date-time>

MongoDB Cloud 开始报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

end
字符串 <date-time>

MongoDB Cloud 停止报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

period
字符串
示例： period=PT10H

Atlas 报告指标的持续时间。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。在未设置开始和结束时包含此参数。

响应

响应样本

内容类型
application/vnd.atlas.2023-11-15+json
{
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "measurements": [
    ],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

自定义数据库角色

返回、添加、编辑和删除自定义数据库用户权限角色。使用自定义角色来指定 MongoDB Cloud 内置角色无法描述的自定义操作集。您可以在项目级别为项目中的所有集群确定自定义角色。此资源支持 MongoDB 权限操作的子集。您可以创建自定义角色操作子集。要创建更广泛的自定义角色操作列表，请使用 MongoDB Cloud 用户界面。自定义角色必须包括所有项目集群都支持的操作，并且与项目集群使用的每个 MongoDB 版本兼容。例如，如果您的项目具有 MongoDB 4.2 集群，则您无法创建使用 MongoDB 4.4 中引入的操作的自定义角色。

返回一个项目中的所有自定义角色

返回指定项目的所有自定义角色。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

创建一个自定义角色

在指定项目中创新一个自定义角色。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色、“项目流处理所有者”角色或“项目数据库访问管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

在指定项目中创建一个自定义角色。

数组 对象 （数据库特权动作）

角色授予的各个权限操作的列表。

数组 对象 （继承角色） unique

该自定义角色继承的内置角色列表。

roleName
必需
字符串

标识请求角色的可读标签。此名称必须是此项目中此自定义角色的唯一名称。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

从一个项目中删除一个自定义角色

从指定项目中删除一个自定义角色。 如果删除自定义角色。 此外，如果删除自定义角色会导致一个或多个数据库用户没有角色，则也不能删除该角色。 要使用此资源，请求的API密钥必须具有“项目所有者”角色、“项目流处理所有者”角色或“项目数据库访问管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

roleName
必需
字符串

标识请求角色的可读标签。此名称必须是此项目中此自定义角色的唯一名称。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

返回一个项目中的一个自定义角色

返回指定项目的一个自定义角色。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

roleName
必需
字符串

标识请求角色的可读标签。此名称必须是此项目中此自定义角色的唯一名称。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

更新一个项目中的一个自定义角色

更新指定项目中的一个自定义角色。 要使用此资源，请求的API密钥必须具有“项目所有者”角色、“项目流处理所有者”角色或“项目数据库访问管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

roleName
必需
字符串

标识请求角色的人类可读标签。此名称必须是本项目中此自定义角色的唯一名称。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

在指定项目中更新一个自定义角色。

数组 对象 （数据库特权动作）

角色授予的各个权限操作的列表。

数组 对象 （继承角色） unique

该自定义角色继承的内置角色列表。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

Data Federation

返回、添加、编辑和删除联合数据库实例。此资源需要您的项目 ID。联合数据库实例配置的更改会影响成本。

返回一个项目中的所有联合数据库实例

返回指定项目中的所有联合数据库实例的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”或更高权限的角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

类型
字符串
默认： "USER"
枚举： "USER" "ONLINE_ARCHIVE"

要返回的联合数据库实例的类型。

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

在一个项目中创建一个联合数据库实例

在指定的项目中创建一个联合数据库实例。要使用此资源，请求的 API 密钥必须具有项目所有者或项目图表管理员角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

skipRoleValidation
布尔
默认： false

指示此请求是否应检查请求的 IAM 角色是否可以从 S3 存储桶读取数据的标记。AWS 检查角色是否可以在写入存储桶之前列出桶中的对象。某些 IAM 角色仅需要写入权限。此标记允许您跳过该检查。

请求正文模式：application/vnd.atlas.2023-01-01+json

在指定项目中创建一个联合数据库实例的详细信息。

对象 （Data Federation 云提供商）

托管此联合数据库实例的云提供商。

对象 (DataLakeDataProcessRegion)

有关联邦数据库实例路由客户端连接的云提供商区域的信息。

名称
字符串

人类可读标签，用于标识联合数据库实例。

对象 (DataLakeStorage)

每个数据存储的配置信息及其到 MongoDB Cloud 数据库的映射。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "storage": {
    }
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

从一个项目中删除一个联合数据库实例

从指定项目中删除一个联合数据库实例。要使用此资源，请求的 API 密钥必须具有项目所有者或项目图表管理员角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

租户名称
必需
字符串

用于标识要删除的联合数据库实例的人类可读标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{ }

返回一个项目中的一个联合数据库实例

返回指定项目中一个联合数据库实例的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”或“项目图表管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

租户名称
必需
字符串

人类可读标签，用于标识要返回的“联合数据库”。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

创建一个项目中的一个联合数据库实例

更新指定项目中一个联合数据库实例的详细信息。要使用此资源，请求的 API 密钥必须具有项目所有者角色或更高角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

租户名称
必需
字符串

用于标识要更新的联合数据库实例的可读标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

skipRoleValidation
必需
布尔

指示此请求是否应检查请求的 IAM 角色是否可以从 S3 存储桶读取数据的标记。AWS 检查角色是否可以在写入存储桶之前列出桶中的对象。某些 IAM 角色仅需要写入权限。此标记允许您跳过该检查。

请求正文模式：application/vnd.atlas.2023-01-01+json

要在指定项目中更新的一个联合数据库的详细信息。

对象 （Data Federation 云提供商）

托管此联合数据库实例的云提供商。

对象 (DataLakeDataProcessRegion)

有关联邦数据库实例路由客户端连接的云提供商区域的信息。

名称
字符串

人类可读标签，用于标识联合数据库实例。

对象 (DataLakeStorage)

每个数据存储的配置信息及其到 MongoDB Cloud 数据库的映射。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "storage": {
    }
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

返回一个联合数据库实例的所有查询限制

返回指定项目中联合数据库实例的查询限制。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

租户名称
必需
字符串

人可读标签，标识要检索的查询限制对应的联合数据库实例。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

删除一个联合数据库实例的一个查询限制

删除一个联合数据库实例的一个查询限制。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

租户名称
必需
字符串

用于标识应用查询限制的联合数据库实例的人类可读标签。

limitName
必需
字符串
枚举： "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly"

人类可读标签，用于标识此数据联合实例限制。

限制名称 说明 默认
bytesProcessed.query 单个 Data Federation 查询期间处理的字节数限制 不适用
bytesProcessed.daily 针对数据联合实例当周处理的字节数限制 不适用
bytesProcessed.weekly 针对数据联合实例的当周处理字节数限制 不适用
bytesProcessed.monthly 针对数据联合实例的当月处理字节数限制 不适用
查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{ }

返回一个项目中的一个联合数据库实例查询限制

为指定项目中的指定联合数据库实例返回一个查询限制的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

租户名称
必需
字符串

用于标识应用查询限制的联合数据库实例的人类可读标签。

limitName
必需
字符串
枚举： "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly"

人类可读标签，用于标识此数据联合实例限制。

限制名称 说明 默认
bytesProcessed.query 单个 Data Federation 查询期间处理的字节数限制 不适用
bytesProcessed.daily 针对数据联合实例当周处理的字节数限制 不适用
bytesProcessed.weekly 针对数据联合实例的当周处理字节数限制 不适用
bytesProcessed.monthly 针对数据联合实例的当月处理字节数限制 不适用
查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "maximumLimit": 0,
  • "name": "string",
  • "overrunPolicy": "BLOCK",
  • "tenantName": "string",
  • "value": 0
}

为一个联合数据库实例配置一个查询限制

为一个联合数据库实例创建或更新一个查询限制。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

租户名称
必需
字符串

用于标识应用查询限制的联合数据库实例的人类可读标签。

limitName
必需
字符串
枚举： "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly"

人类可读标签，用于标识此数据联合实例限制。

限制名称 说明 默认
bytesProcessed.query 单个 Data Federation 查询期间处理的字节数限制 不适用
bytesProcessed.daily 针对数据联合实例当周处理的字节数限制 不适用
bytesProcessed.weekly 针对数据联合实例的当周处理字节数限制 不适用
bytesProcessed.monthly 针对数据联合实例的当月处理字节数限制 不适用
查询参数
envelope
布尔
默认： false
示例： envelope=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

为一个联合数据库实例创建或更新一个查询限制。

overrunPolicy
字符串
枚举： "BLOCK" “BLOCK_AND_KILL”

仅用于 Data Federation 限制。超过使用限制时应执行的操作。如果限制跨度设置为 QUERY，则会忽略此限制，因为 MongoDB Cloud 会在查询超过使用限制时停止查询。

值
必需
整型 <int64>

要设置限制的金额。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "overrunPolicy": "BLOCK",
  • "value": 0
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "maximumLimit": 0,
  • "name": "string",
  • "overrunPolicy": "BLOCK",
  • "tenantName": "string",
  • "value": 0
}

下载单个联合数据库实例的查询日志

下载指定联合数据库实例的查询日志。要使用此资源，请求的 API 密钥必须具有“项目所有者”或“项目数据访问读写”角色。该 API 不支持直接调用并返回 JSON 格式的响应模式。您必须使用以下格式的接受标头来请求 gzip 响应模式：“Accept: application/vnd.atlas.YYYY-MM-DD+gzip”。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

租户名称
必需
字符串

可读标签，用于标识要下载查询限制的联合数据库实例。

查询参数
endDate
整型 <int64> 1199145600
示例： endDate=1636481348

指定要下载的日志消息范围终点的时间戳。MongoDB Cloud 以自 UNIX 纪元以来经过的秒数表示此时间戳。

startDate
整型 <int64> 1199145600
示例： startDate=1636466948

指定要下载的日志消息范围起点的时间戳。MongoDB Cloud 以自 UNIX 纪元以来经过的秒数表示此时间戳。

响应

响应样本

内容类型
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

返回全部项目中的一个联合数据库实例和在线存档私有端点

返回指定项目中联合数据库实例或在线归档的所有私有端点。要使用此资源，请求的 API 密钥必须具有“项目只读”或“项目图表管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

为一个项目创建一个联合数据库实例和在线归档私有端点

添加指定项目中联合数据库实例和在线存档的所有私有端点。如果端点 ID 已存在且关联注释未更改，则 Atlas Data Federation 不会更改端点 ID 列表。如果端点 ID 已存在且关联注释发生更改，则 Atlas Data Federation 仅更新端点 ID 列表中的注释值。如果端点 ID 不存在，Atlas Data Federation 会将新端点附加到端点 ID 列表中的端点列表中。每个区域都有每个区域中各种端点的关联服务名称。

us-east-1 是 com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4。

us-west-1 是 com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb。

eu-west-1 是 com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e。

eu-west-2 是 com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9。

eu-central-1 是 com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d。

sa-east-1 是 com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044。

ap-southeast-2 是 com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e。

ap-south-1 是 com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d。

要使用此资源，请求的 API 密钥必须具有项目所有者或项目图表管理员角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

用于将联合数据库实例和在线存档添加到指定项目的私有端点。

azureLinkId
字符串

标识Azure私有端点连接的链接ID 。

comment
字符串

与此私有端点关联的人类可读字符串。

customerEndpointDNSName
字符串

人类可读标签，用于标识客户 VPC 端点 DNS 名称。如果已定义，则还必须为区域指定一个值。

customerEndpointIPAddress
字符串^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

用于连接到Azure私有端点的IP解决。

endpointId
必需
字符串^vpce-[0-9a-f]{17}$

唯一的 22 字符构成的字母数字字符串，用于标识私有端点。

Atlas 数据湖使用 AWS PrivateLink 功能支持 Amazon Web Services 私有端点。
错误消息
字符串

描述批准私有端点请求失败的错误消息。

provider
字符串
默认： "AWS"
值： "AWS"

用于标识云服务提供商的可读标签。Atlas Data Lake 仅支持 Amazon Web Services。

区域
字符串

用于标识客户 VPC 端点所在区域的人类可读标签。如果已定义，则还必须为 customerEndpointDNSName 指定一个值。

状态
字符串
枚举： "PENDING" "OK" "FAILED" "DELETING"

私有端点连接请求的状态。

类型
字符串
默认： "DATA_LAKE"
值： "DATA_LAKE"

用户可读的标签，用于标识与此私有端点关联的资源类型。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "azureLinkId": "string",
  • "comment": "string",
  • "customerEndpointDNSName": "string",
  • "customerEndpointIPAddress": "string",
  • "endpointId": "vpce-3bf78b0ddee411ba1",
  • "errorMessage": "string",
  • "provider": "AWS",
  • "region": "US_EAST_1",
  • "status": "PENDING",
  • "type": "DATA_LAKE"
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

从一个项目删除一个联合数据库实例和在线归档私有端点

删除指定项目中联合数据库实例或在线归档的一个私有端点。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

endpointId
必需
字符串^vpce-[0-9a-f]{17}$

唯一的 22 字符构成的字母数字字符串，标识要删除的私有端点。Atlas Data Federation 使用 AWS PrivateLink 功能支持 AWS 私有端点。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{ }

返回一个项目中的一个联合数据库实例和在线存档私有端点

返回指定项目中联合数据库实例或在线归档的指定私有端点。要使用此资源，请求的 API 密钥必须具有“项目只读”或“项目图表管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

endpointId
必需
字符串^vpce-[0-9a-f]{17}$

唯一的 22 位字母数字字符串，用于标识要返回的私有端点。Atlas Data Federation 使用 AWS PrivateLink 功能支持 AWS 私有端点。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "azureLinkId": "string",
  • "comment": "string",
  • "customerEndpointDNSName": "string",
  • "customerEndpointIPAddress": "string",
  • "endpointId": "vpce-3bf78b0ddee411ba1",
  • "errorMessage": "string",
  • "provider": "AWS",
  • "region": "US_EAST_1",
  • "status": "PENDING",
  • "type": "DATA_LAKE"
}

Atlas 数据湖管道

返回、编辑和删除 Atlas Data Lake 管道及关联的运行。

数据湖管道已弃用。请参阅数据湖弃用指南。

从一个项目返回所有数据湖管道已弃用

返回 Atlas 数据湖管道列表。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

创建一个数据湖管道已弃用

创建一个 Atlas 数据湖管道。

数据湖管道已弃用。请参阅数据湖弃用指南。
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

创建一个 Atlas 数据湖管道。

对象 (数据集保留政策）

预定数据湖管道的数据集保留策略。

名称
字符串

该“数据湖管道”的名称。

对象 （摄取目标）

Atlas 数据湖管道的摄取目标。

对象 （摄取来源）

Atlas 数据湖管道的摄取来源。

数组 对象 （字段转换）

要为此 Data Lake 管道排除的字段。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "datasetRetentionPolicy": {
    },
  • "name": "string",
  • "sink": { },
  • "source": {
    },
  • "transformations": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

移除一个数据湖管道已弃用

删除一个数据湖管道。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{ }

返回一个数据湖管道已弃用

返回指定项目中的数据湖管道的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

更新一个数据湖管道 已弃用

更新一个数据湖管道。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

更新一个数据湖管道。

对象 (数据集保留政策）

预定数据湖管道的数据集保留策略。

名称
字符串

该“数据湖管道”的名称。

对象 （摄取目标）

Atlas 数据湖管道的摄取目标。

对象 （摄取来源）

Atlas 数据湖管道的摄取来源。

数组 对象 （字段转换）

要为此 Data Lake 管道排除的字段。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "datasetRetentionPolicy": {
    },
  • "name": "string",
  • "sink": { },
  • "source": {
    },
  • "transformations": [
    ]
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

返回单个数据湖管道的可用输入计划 已弃用

返回可用作“数据湖管道”源的备份计划策略项列表。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

返回一个数据湖管道的可用备份快照已弃用

返回可用于触发按需管道运行的备份快照列表。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

pretty
布尔
默认： false
示例： pretty=false

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

completedAfter
字符串 <date-time>

MongoDB Cloud 在该日期和时间之后创建了快照。如果指定，MongoDB Cloud 仅返回在此时间和日期之后创建的可用备份快照。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

暂停一个 Data Lake 管道已弃用

暂停指定项目内数据湖管道的摄取。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

恢复一个数据湖管道已弃用

恢复指定项目内 Atlas 数据湖管道的摄取。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

从一个项目返回所有数据湖管道运行已弃用

返回过去的 Atlas 数据湖管道运行列表。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

pretty
布尔
默认： false
示例： pretty=false

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

createdBefore
字符串 <date-time>

如果指定，Atlas 只返回在此时间和日期之前启动的“数据湖管道”运行。

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

删除管道运行数据集已弃用

删除 Atlas 在指定管道运行期间生成的数据集。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

pipelineRunId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

唯一的 24 位十六进制字符串，用于标识 Atlas 数据湖管道运行。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{ }

返回一个数据湖管道运行已弃用

返回指定项目中一个数据湖管道运行的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

pipelineRunId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

唯一的 24 位十六进制字符串，用于标识 Atlas 数据湖管道运行。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "backupFrequencyType": "HOURLY",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "phase": "SNAPSHOT",
  • "pipelineId": "32b6e34b3d91647abb20e7b8",
  • "scheduledDeletionDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "PENDING",
  • "stats": {
    }
}

按需触发快照摄取已弃用

触发指定快照的 Atlas 数据湖管道摄取。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

触发快照的单次摄取运行。

对象 (数据集保留政策）

预定数据湖管道的数据集保留策略。

snapshotId
必需
字符串^([a-f0-9]{24})$

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

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "datasetRetentionPolicy": {
    },
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "backupFrequencyType": "HOURLY",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "phase": "SNAPSHOT",
  • "pipelineId": "32b6e34b3d91647abb20e7b8",
  • "scheduledDeletionDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "PENDING",
  • "stats": {
    }
}

数据库用户

返回、添加、编辑和删除数据库用户。

从一个项目中返回所有数据库用户

返回属于指定项目的所有数据库用户。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

includeCount
布尔
默认： true
示例： includeCount=true

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

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

创建一个项目中的一个数据库用户

在指定项目中创建一个数据库用户。 此MongoDB Cloud 支持每个项目最多 100 个数据库用户。 如果项目需要100 个以上的数据库用户，联系支持部门。要使用此资源，请求的API密钥必须具有“项目所有者”角色、“项目Charts管理员”角色、“项目流处理所有者”角色或“项目数据库访问管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

请求正文模式：application/vnd.atlas.2023-01-01+json

在指定项目中创建一个数据库用户。

awsIAMType
字符串
默认： "NONE"
枚举： "NONE" "USER" "ROLE"

可读的标签，指示新数据库用户是否使用与用户或用户角色关联的 Amazon Web Services (AWS) 身份和访问管理 (IAM) 凭证进行身份验证。

数据库名称
必需
字符串
默认： "admin"
枚举： "admin" “$external”

数据库用户进行身份验证所依据的数据库。 数据库用户必须提供用户名和身份验证数据库才能登录 MongoDB。 如果用户使用Amazon Web Services IAM、x.509、 LDAP或 OIDC 工作负载进行身份验证，此值应为 $external。 如果用户使用 SCRAM-SHA 或 OIDC Workforce 进行身份验证，则此值应为admin 。

deleteAfterDate
字符串 <date-time>

MongoDB Cloud 删除用户的日期和时间。此参数以 ISO 8601 时间戳格式（UTC 格式）表示其值，可以包括时区名称。您必须指定发出应用程序编程接口 (API) 请求后一周内的某个未来日期。

描述
字符串 <= 100 个字符

此数据库用户的描述。

groupId
必需
字符串

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

数组 对象 （组件标签）

包含用于标记和分类 MongoDB 数据库用户的键值对的列表。您定义的标签不会显示在控制台中。

ldapAuthType
字符串
默认： "NONE"
枚举： "NONE" "GROUP" "USER"

轻型目录访问协议 (LDAP) 记录的一部分，数据库使用它来对 LDAP 主机上的此数据库用户进行身份验证。

oidcAuthType
字符串
默认： "NONE"
枚举： "NONE" "IDP_GROUP" "USER"

人类可读标签，指示新数据库用户或群组是否使用 OIDC 联合身份验证进行身份验证。如需创建联合身份验证用户，请指定该字段的 USER 的值。如需创建联合身份验证群组，请指定该字段的 IDP_GROUP 的值。

密码
字符串 >= 8 个字符

用于根据 databaseName 中指定的数据库验证此数据库用户身份的字母数字字符串。要使用 SCRAM-SHA 进行身份验证，您必须指定此参数。该参数不出现在此响应中。

SCRAM-SHA
数组 对象 (数据库用户角色）

提供单个角色与单个适用数据库配对的列表。

数组 对象 (数据库用户范围）

包含此数据库用户可以访问的集群、MongoDB Atlas 数据湖和 MongoDB Atlas Streams 实例的列表。如果省略，MongoDB Cloud 会授予数据库用户访问项目中的所有集群、MongoDB Atlas 数据湖和 MongoDB Atlas Streams 实例的权限。

用户名
必需
字符串 <= 1024 个字符

人类可读标签，表示向 MongoDB 进行身份验证的用户。此标签的格式取决于身份验证方法：

身份验证方法 所需参数 参数值 用户名格式
AWS IAM awsIAMType ROLE ARN
AWS IAM awsIAMType 用户 ARN
x.509 x509Type 客户 RFC 2253 标识名
x.509 x509Type 托管 RFC 2253 标识名
LDAP ldapAuthType 用户 RFC 2253 标识名
LDAP ldapAuthType 群组 RFC 2253 标识名
OIDC 员工队伍 oidcAuthType IDP_GROUP Atlas OIDC IdP ID（在联合设置中找到），后跟“/”，然后是 IdP 组名称
OIDC 工作负载 oidcAuthType 用户 Atlas OIDC IdP ID（在联合设置中找到），后跟“/”，然后是 IdP 用户名
SCRAM-SHA awsIAMType、x509Type、ldapAuthType、oidcAuthType 无 字母数字字符串
x509Type
字符串
默认： "NONE"
枚举： "NONE" “客户” "MANAGED"

MongoDB Cloud 用于对数据库用户进行身份验证的 X.509 方法。

  • 对于应用程序托管的 X.509，请指定 MANAGED。
  • 对于自我托管的 X.509，请指定 CUSTOMER。

使用 CUSTOMER 方法创建的用户需要在用户名参数中使用公用名 (CN)。您必须对 $external 数据库创建经过外部身份验证的用户。

响应

请求样本

内容类型
application/vnd.atlas.2023-01-01+json
例子

AWS IAM 身份验证

{
  • "awsIAMType": "USER",
  • "databaseName": "$external",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user"
}

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "links": [],
  • "oidcAuthType": "NONE",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "string",
  • "x509Type": "NONE"
}

从一个项目中删除一个数据库用户

从指定项目中删除一个数据库用户。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色、“项目流处理所有者”角色或“项目数据库访问管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

数据库名称
必需
字符串

数据库用户进行身份验证所依据的数据库。 数据库用户必须提供用户名和身份验证数据库才能登录 MongoDB。 如果用户使用Amazon Web Services IAM、x.509、 LDAP或 OIDC 工作负载进行身份验证，此值应为 $external。 如果用户使用 SCRAM-SHA 或 OIDC Workforce 进行身份验证，则此值应为admin 。

用户名
必需
字符串
示例： SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs 或 x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName

人类可读标签，表示向 MongoDB 进行身份验证的用户。此标签的格式取决于身份验证方法：

身份验证方法 所需参数 参数值 用户名格式
AWS IAM awsIAMType ROLE ARN
AWS IAM awsIAMType 用户 ARN
x.509 x509Type 客户 RFC 2253 标识名
x.509 x509Type 托管 RFC 2253 标识名
LDAP ldapAuthType 用户 RFC 2253 标识名
LDAP ldapAuthType 群组 RFC 2253 标识名
OIDC 员工队伍 oidcAuthType IDP_GROUP Atlas OIDC IdP ID（在联合设置中找到），后跟“/”，然后是 IdP 组名称
OIDC 工作负载 oidcAuthType 用户 Atlas OIDC IdP ID（在联合设置中找到），后跟“/”，然后是 IdP 用户名
SCRAM-SHA awsIAMType、x509Type、ldapAuthType、oidcAuthType 无 字母数字字符串
查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{ }

从一个项目中返回一个数据库用户

返回属于指定项目的一个数据库用户。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

数据库名称
必需
字符串

数据库用户进行身份验证所依据的数据库。 数据库用户必须提供用户名和身份验证数据库才能登录 MongoDB。 如果用户使用Amazon Web Services IAM、x.509、 LDAP或 OIDC 工作负载进行身份验证，此值应为 $external。 如果用户使用 SCRAM-SHA 或 OIDC Workforce 进行身份验证，则此值应为admin 。

用户名
必需
字符串
示例： SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs 或 x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName

人类可读标签，表示向 MongoDB 进行身份验证的用户。此标签的格式取决于身份验证方法：

身份验证方法 所需参数 参数值 用户名格式
AWS IAM awsIAMType ROLE ARN
AWS IAM awsIAMType 用户 ARN
x.509 x509Type 客户 RFC 2253 标识名
x.509 x509Type 托管 RFC 2253 标识名
LDAP ldapAuthType 用户 RFC 2253 标识名
LDAP ldapAuthType 群组 RFC 2253 标识名
OIDC 员工队伍 oidcAuthType IDP_GROUP Atlas OIDC IdP ID（在联合设置中找到），后跟“/”，然后是 IdP 组名称
OIDC 工作负载 oidcAuthType 用户 Atlas OIDC IdP ID（在联合设置中找到），后跟“/”，然后是 IdP 用户名
SCRAM-SHA awsIAMType、x509Type、ldapAuthType、oidcAuthType 无 字母数字字符串
查询参数
envelope
布尔
默认： false
示例： envelope=false

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

pretty
布尔
默认： false
示例： pretty=false

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

响应

响应样本

内容类型
application/vnd.atlas.2023-01-01+json
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "links": [],
  • "oidcAuthType": "NONE",
  • "roles": [
    ],
  • "scopes": [