MongoDB Atlas Administration API
Redocly 提供的 API 文档

MongoDB Atlas Administration API (1.0)

下载 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/json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"

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

访问跟踪

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

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

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

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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/json
{
  • "accessLogs": [
    ]
}

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

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

数据库访问历史记录
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "accessLogs": [
    ]
}

警报配置

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/json
[
  • "APPLICATION_ID"
]

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

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

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

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

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

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

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

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/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/json
例子
{
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "matchers": [
    ],
  • "notifications": [
    ]
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

alertConfigId
必需
字符串 = 24 个字符 ^([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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

alertConfigId
必需
字符串 = 24 个字符 ^([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
例子
{
  • "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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

alertConfigId
必需
字符串 = 24 个字符 ^([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

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

enabled
布尔

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

响应

请求样本

内容类型
application/json
{
  • "enabled": true
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

alertConfigId
必需
字符串 = 24 个字符 ^([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

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

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

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

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

触发此警报的事件。

数组 对象 （匹配器）

目标资源的匹配条件。

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

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

响应

请求样本

内容类型
application/json
例子
{
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "matchers": [
    ],
  • "notifications": [
    ]
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

alertId
必需
字符串 = 24 个字符 ^([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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

警报

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

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

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

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

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

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

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

alertConfigId
必需
字符串 = 24 个字符 ^([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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

从一个项目返回所有警报

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

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

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

从一个项目返回一项警报

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

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

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

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

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/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 密钥必须具有“组织所有者”或“项目所有者”角色。

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

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

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

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

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

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

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

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

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

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

请求正文模式：application/json

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

acknowledgedUntil
字符串 <date-time>

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

  • 要永久确认此警报，请将参数值设置为未来 100 年。

  • 要取消确认先前已确认的警报，请勿设置此参数值。

acknowledgementComment
字符串 <= 200 个字符

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

响应

请求样本

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

响应样本

内容类型
application/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 自定义分析器。自定义分析器定义对字段进行索引时要执行的操作。 要使用此资源，请求的 API 密钥必须具有项目数据访问读写角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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/json
[
  • {
    }
]

更新一个集群的所有用户定义的分析器

更新指定集群上的一个或多个 Atlas Search 自定义分析器。自定义分析器定义对字段进行索引时要执行的操作。 要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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/json

更新指定集群上的一个或多个 Atlas Search 自定义分析器。

阵列
数组 htmlStrip（对象）或 icuNormalize（对象）或 mapping（对象）或 persian（对象）

一次检查一个字符的文本并执行筛选操作的筛选器。

名称
必需
字符串

用于标识自定义分析器的人类可读名称。 名称在索引中必须是唯一的，并且不能以以下任何字符串开头：

  • lucene.
  • builtin.
  • mongodb.
数组 asciiFolding（对象）或 daitchMokotoffSoundex（对象）或 edgeGram（对象）或 englishPossessive（对象）或 flattenGraph（对象）或 icuFolding（对象）或 icuNormalizer（对象）或 kStemming（对象）或 length（对象）或 lowercase（对象）或nGram（对象）、porterStemming（对象）、regex（对象）、reverse（对象）、shingle（对象）、snowballStemming（对象）、spanishPluralStemming（对象）、stempel（对象）、stopword（对象）、trim（对象）、 wordDelimiterGraph（对象）

执行以下操作的筛选器：

  • 提取词干，这会将相关词语（例如“talking”、“talked”和“talks”）缩减为词根“talk”。

  • 编辑，这会从公共文档中删除敏感信息。

必需
对象

要用于创建词元的分词器。 词元决定了 Atlas Search 如何将文本分割成离散的数据段以进行索引。

响应

请求样本

内容类型
application/json
[
  • {
    }
]

响应样本

内容类型
application/json
[
  • {
    }
]

创建一个 Atlas Search 索引

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

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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/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/json
例子
{
  • "collectionName": "string",
  • "database": "string",
  • "name": "string",
  • "numPartitions": 1,
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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/json
[
  • {
    }
]

删除一个 Atlas Search 索引

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

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

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

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

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

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

indexId
必需
字符串 = 24 个字符 ^([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/json
{ }

返回一个 Atlas Search 索引

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

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

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

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

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

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

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

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

indexId
必需
字符串 = 24 个字符 ^([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/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/json
例子
{
  • "collectionName": "string",
  • "database": "string",
  • "name": "string",
  • "numPartitions": 1,
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

响应样本

内容类型
application/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": [
    ]
}

审核

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

返回一个项目的审核配置

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

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "configurationType": "NONE",
  • "enabled": false
}

更新一个项目的审核配置

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

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

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

auditAuthorizationSuccess
布尔
默认： false

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

系统审核消息
auditFilter
字符串

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

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

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

响应

请求样本

内容类型
application/json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "enabled": false
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([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/json
{
  • "enabled": true
}

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

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

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

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

enabled
必需
布尔

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

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

响应

请求样本

内容类型
application/json
{
  • "enabled": true
}

响应样本

内容类型
application/json
{
  • "enabled": true
}

云备份

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

返回所有快照导出存储桶

返回与指定项目关联的所有导出存储桶。 要使用此资源，请求的API密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{}

创建一个快照导出存储桶

为给定的Amazon Web ServicesAmazon Web Services S3 存储桶创建导出存储桶。创建快照后，可将其导出到导出存储桶及其引用的Amazon Web ServicesAmazon Web Services S3 存储桶。要使用此资源，请求的API密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

指定导出存储桶应引用的AmazonAmazon Web Services 3Web Services S 存储桶和 IAM角色。

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

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

云服务提供商
必需
字符串
枚举： "AWS" "AZURE"

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

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

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

响应

请求样本

内容类型
application/json
{
  • "bucketName": "export-bucket",
  • "cloudProvider": "AWS",
  • "iamRoleId": "32b6e34b3d91647abb20e7b8"
}

响应样本

内容类型
application/json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "bucketName": "export-bucket",
  • "cloudProvider": "AWS",
  • "iamRoleId": "32b6e34b3d91647abb20e7b8",
  • "links": []
}

删除一个快照导出存储桶

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

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/json
{ }

返回一个快照导出存储桶

返回与指定项目关联的一个导出存储桶。 要使用此资源，请求的API密钥必须具有“项目只读”角色。

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "bucketName": "export-bucket",
  • "cloudProvider": "AWS",
  • "iamRoleId": "32b6e34b3d91647abb20e7b8",
  • "links": []
}

返回备份合规性策略设置

返回指定项目的备份合规性策略设置。要使用该资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/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 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

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

authorizedEmail
必需
字符串 <email>

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

authorizedUserFirstName
字符串

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

authorizedUserLastName
字符串

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

copyProtectionEnabled
布尔
默认： false

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

encryptionAtRestEnabled
布尔
默认： false

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

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

按需策略规范。

pitEnabled
布尔
默认： false

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

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

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

restoreWindowDays
整型 <int32>

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

数组 对象 (BackupComplianceScheduledPolicyItem)

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

响应

请求样本

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

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

创建一个快照导出作业

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

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

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

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

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

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

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

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

请求正文模式：application/json

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

数组 对象 (BackupLabel)

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

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

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

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

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

响应

请求样本

内容类型
application/json
{
  • "customData": [
    ],
  • "exportBucketId": "32b6e34b3d91647abb20e7b8",
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

恢复一个集群的一张快照

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

要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

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

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
字符串 = 24 个字符 ^([a-f0-9]{24})$

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

targetClusterName
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

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

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

响应

请求样本

内容类型
application/json
{
  • "deliveryType": "automated",
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8"
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

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

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/json
{ }

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

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

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

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

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

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

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/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 管理员角色。

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/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 密钥必须具有“项目只读”角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "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 密钥必须具有“项目所有者”角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

更新指定项目中一个集群的云备份计划。

注意：在请求正文中，仅提供要更新的字段。

autoExportEnabled
布尔

指示 MongoDB Cloud 是否自动将云备份快照导出到导出存储桶的标志。

数组 对象 (DiskBackupCopySetting)

包含所需备份策略中每个副本设置列项文档的列表。

数组 对象 （DeleteCopiedBackups）

该列表包含要删除其备份副本的每个已删除副本设置的文档。

对象 (export)

自动导出云备份快照的策略。

数组 对象 (ExtraRetentionSetting)

包含所需备份策略中每个额外保留设置项的文档的列表。

数组 对象 （AdvancedDiskBackupSnapshotSchedulePolicy） <= 1 个列项

为该备份计划设置的规则。

referenceHourOfDay
整型 <int32>

以协调世界时（UTC）表示的一天中的某个小时，表示 MongoDB Cloud 拍摄快照的时间。

referenceMinuteOfHour
整型 <int32>

表示 MongoDB Cloud 获取快照时间的 referenceHourOfDay 的分钟数。

restoreWindowDays
整型 <int32>

使用“持续云备份”准确性可恢复到之前的天数。必须指定非零的正整数。此参数仅适用于连续云备份。

updateSnapshots
布尔

指示是否将更新的备份策略中的保留更改应用到 MongoDB Cloud 以前拍摄的快照的标志。

useOrgAndGroupNamesInExportPrefix
布尔

标志，用于标识是否在 MongoDB Cloud 上传到导出存储桶的元数据文件路径中使用组织和项目名称，而不是组织和项目 UUID。

响应

请求样本

内容类型
application/json
{
  • "autoExportEnabled": true,
  • "copySettings": [
    ],
  • "deleteCopiedBackups": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "updateSnapshots": true,
  • "useOrgAndGroupNamesInExportPrefix": true
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

拍摄一张按需快照

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

要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

按需拍摄一张快照。

描述
字符串

说明快照目的的人类可读短语或句子。当 "status" : "onDemand" 时，资源返回此参数。

retentionInDays
整型 <int32> >= 1

MongoDB Cloud 应保留按需快照的天数。必须至少为 1。

响应

请求样本

内容类型
application/json
{
  • "description": "string",
  • "retentionInDays": 1
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

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

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/json
{ }

返回一个分片集群云备份

从指定项目中返回一个分片集群的一个快照。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

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

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

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

删除一个副本集云备份

删除指定的快照。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

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

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

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

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

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/json
{ }

返回一个副本集云备份

从指定集群返回一个快照。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

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

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

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/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"
}

更改一个云备份的到期日期

更改指定项目中一个集群的一个云备份快照的过期日期。

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

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

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

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

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

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

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

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

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

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

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

请求正文模式：application/json

更改指定项目中一个集群的一个云备份快照的过期日期。

retentionUnit
必需
字符串
枚举： “天” “周” "MONTHS" "YEARS"

MongoDB Cloud 用于计量快照保留时间的时长。

retentionValue
必需
整型 <int32>

数字，表示 MongoDB Cloud 保留快照的天数、周数、月数或年数。对于频率较低的策略项目，MongoDB Cloud 要求您指定的值大于或等于为频率较高的策略项目指定的值。如果每小时策略项目指定保留两天，请为每周策略项目指定两天或更长的保留时间。

响应

请求样本

内容类型
application/json
{
  • "retentionUnit": "DAYS",
  • "retentionValue": 5
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

恢复一个无服务器实例的一个快照

恢复指定项目中一个无服务器实例的一个快照。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

从指定项目中恢复一个无服务器实例的一个快照。

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
字符串 = 24 个字符 ^([a-f0-9]{24})$

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

targetClusterName
必需
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

用户可读的标签，用于标识恢复作业将快照恢复到的目标集群。当 "deliveryType": "automated" 时，资源返回此参数。

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

唯一的 24 进制数字字符串，用于标识指定 targetClusterName 的目标项目。

响应

请求样本

内容类型
application/json
{
  • "deliveryType": "automated",
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8"
}

响应样本

内容类型
application/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 密钥必须具有“项目所有者”角色。

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

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

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

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

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/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 密钥必须具有“项目只读”角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

返回一个无服务器实例的一个快照

从指定项目中返回一个无服务器实例的一个快照。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/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 或更高版本上的迁移将跳过源集群上的任何时间序列集合。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

要创建的一个迁移。

必需
对象 （目的地）

描述迁移目标的文档。

dropEnabled
必需
布尔

指示迁移过程是否在迁移开始之前从目标集群删除所有集合的标志。

migrationHosts
数组 字符串 = 1 个列项

用于此迁移的迁移主机列表。

对象 （ShardingRequest）

当从副本集源迁移到 MongoDB 6.0 或更高版本上的分片集群目标时，在目标集群上配置分片的文档。如果您不希望对目标集群上的任何集合进行分片，请将其留空。

必需
对象 （来源）

描述迁移来源的文档。

响应

请求样本

内容类型
application/json
{
  • "destination": {
    },
  • "dropEnabled": true,
  • "migrationHosts": [
    ],
  • "sharding": {
    },
  • "source": {
    }
}

响应样本

内容类型
application/json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "lagTimeSeconds": 0,
  • "migrationHosts": [
    ],
  • "readyForCutover": true,
  • "status": "NEW"
}

验证一个迁移请求

验证提供的凭据、可用磁盘空间、MongoDB 版本等是否满足迁移请求的要求。如果检查通过，则可以继续迁移。您的 API 密钥必须具有“组织所有者”角色才能成功调用此资源。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

有待验证的一次迁移。

必需
对象 （目的地）

描述迁移目标的文档。

dropEnabled
必需
布尔

指示迁移过程是否在迁移开始之前从目标集群删除所有集合的标志。

migrationHosts
数组 字符串 = 1 个列项

用于此迁移的迁移主机列表。

对象 （ShardingRequest）

当从副本集源迁移到 MongoDB 6.0 或更高版本上的分片集群目标时，在目标集群上配置分片的文档。如果您不希望对目标集群上的任何集合进行分片，请将其留空。

必需
对象 （来源）

描述迁移来源的文档。

响应

请求样本

内容类型
application/json
{
  • "destination": {
    },
  • "dropEnabled": true,
  • "migrationHosts": [
    ],
  • "sharding": {
    },
  • "source": {
    }
}

响应样本

内容类型
application/json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "errorMessage": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "sourceGroupId": "32b6e34b3d91647abb20e7b8",
  • "status": "PENDING"
}

返回一个迁移验证任务

返回一个迁移验证作业的状态。您的 API 密钥必须具有“组织所有者”角色才能成功调用此资源。

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

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

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

validationId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 507f1f77bcf86cd799439011

唯一的 24 位十六进制数字字符串，用于标识该验证作业。

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

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

响应

响应样本

内容类型
application/json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "errorMessage": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "sourceGroupId": "32b6e34b3d91647abb20e7b8",
  • "status": "PENDING"
}

返回一个迁移作业

返回一个集群迁移作业的详细信息。每个推送实时迁移作业都使用一个迁移主机。 您的 API 密钥必须具有“组织成员”角色才能成功调用此资源。

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

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

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

liveMigrationId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 6296fb4c7c7aa997cf94e9a8

用于标识该迁移的唯一的 24 位十六进制数字字符串。

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

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

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

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

响应

响应样本

内容类型
application/json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "lagTimeSeconds": 0,
  • "migrationHosts": [
    ],
  • "readyForCutover": true,
  • "status": "NEW"
}

切换已迁移的集群

将迁移的集群切换到 MongoDB Atlas。确认切换何时完成。切换完成后，MongoDB Atlas 将完成实时迁移进程，并停止与源集群同步。您的 API 密钥必须具有“组织所有者”角色才能成功调用此资源。

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

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

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

liveMigrationId
必需
字符串 = 24 个字符 ^([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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

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

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

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

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

响应

响应样本

内容类型
application/json
[
  • {
    }
]

删除一个链接令牌

删除一个组织链接及其关联的公用 API 密钥。MongoDB Atlas 仅将链接令牌用于推送实时迁移。实时迁移（推送）可让您将数据从 Cloud Manager 或 Ops Manager 安全地推送到 MongoDB Atlas。您的 API 密钥必须具有“组织所有者”角色才能成功调用此资源。

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

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

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

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

响应

响应样本

内容类型
application/json
{ }

创建一个链接令牌

创建一个链接令牌，其中包含完成链接所需的所有信息。MongoDB Atlas 仅将链接令牌用于推送实时迁移。实时迁移（推送）允许您安全地将数据从 Cloud Manager 或 Ops Manager 推送到 MongoDB Atlas。您的 API 密钥必须具有“组织所有者”角色才能成功调用此资源。

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

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

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

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

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

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

请求正文模式：application/json

与迁移相关的 IP 地址访问列表条目。

accessListIps
数组 字符串

与 API 密钥相关联的 IP 地址访问列表条目。

响应

请求样本

内容类型
application/json
{
  • "accessListIps": [
    ]
}

响应样本

内容类型
application/json
{
  • "linkToken": "string"
}

云提供商访问

返回、添加、授权和删除 Atlas 中的 AWS IAM 角色。

返回所有云提供商访问角色

返回有权访问指定项目的所有云提供商访问角色。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "awsIamRoles": [
    ],
  • "azureServicePrincipals": [
    ]
}

创建一个云提供商访问角色

为指定的云提供商创建一个访问角色。某些 MongoDB Cloud 功能使用这些云提供商访问角色进行身份验证。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

设置对云提供商的访问权限
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

为指定的云提供商创建一个角色。

提供商名称
必需
字符串

用于标识角色的云提供商的人类可读标签。

响应

请求样本

内容类型
application/json
例子
{
  • "providerName": "AWS"
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

云服务提供商
必需
字符串
枚举： "AWS" "AZURE" "GCP"

人类可读标签，用于标识要取消授权的角色的云提供商。

roleId
必需
字符串 = 24 个字符 ^([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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

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

用于标识角色的唯一的 24 位十六进制数字字符串。

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

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

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

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

响应

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

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

用于标识角色的唯一的 24 位十六进制数字字符串。

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

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

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

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

请求正文模式：application/json

授予指定访问角色对指定项目的访问权限。

提供商名称
必需
字符串

用于标识角色的云提供商的人类可读标签。

iamAssumedRoleArn
字符串 [ 20 .. 2048 ] 个字符

Amazon 资源名称 (ARN)，用于标识 MongoDB Cloud 在访问您的 AWS 账户中的资源时所使用的 Amazon Web Services (AWS) 身份和访问管理 (IAM) 角色。

响应

请求样本

内容类型
application/json
例子
{
  • "providerName": "AWS",
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2022-01-01T00:00:00Z",
  • "state": "START_REQUESTED"
}

返回一次停电模拟

返回一个集群的一次停电模拟。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2022-01-01T00:00:00Z",
  • "state": "START_REQUESTED"
}

开始停电模拟

开始集群停电模拟。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

描述中断模拟。

数组 对象 (AtlasClusterOutageSimulationOutageFilter) non-empty

指定集群中断模拟类型的设置列表。

响应

请求样本

内容类型
application/json
{
  • "outageFilters": [
    ]
}

响应样本

内容类型
application/json
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2022-01-01T00:00:00Z",
  • "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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

返回一个项目中的所有集群

返回您有权访问的特定项目中所有集群的详细信息。 集群包含一组维护相同数据集的主机。 响应不包括多云集群。要返回多云集群，请使用获取所有高级集群。 要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

创建一个集群

在特定项目中创建一个集群。 集群包含一组维护相同数据集的主机。 此资源不会创建多云集群。 要创建多云集群，请使用创建一个高级集群。 要使用此资源，请求的 API 密钥必须具有项目所有者角色。

部署 M10+ 专用集群时，如果所选提供商和区域不存在 VPC 或 VPC 对等连接，Atlas 会为该提供商和区域创建 VPC。Atlas 为 VPC 分配无类别域间路由 (CIDR) 块。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

要为指定项目中的一个集群创建的详细信息。

acceptDataRisksAndForceReplicaSetReconfig
字符串 <date-time>

如果由于区域停电而需要重新配置以重新获得主节点，请与拓扑结构重新配置一起提交此字段，以请求新的区域抗停电拓扑。如果复制的写入操作（甚至多数提交的写入操作）尚未复制到新的主节点，则在大多数可选举节点中断期间强制重新配置会带来数据丢失的风险。MongoDB Atlas 文档包含更多信息。要继续执行存在该风险的操作，请将 acceptDataRisksAndForceReplicaSetReconfig 设置为当前日期。

在区域中断期间重新配置副本集
对象 （集群自动缩放设置）

集群可扩展的实例大小范围。

集群自动伸缩
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 控制台不显示您的标签。

集群标签已弃用，并将在未来版本中删除。我们强烈建议您改用资源标签。

mongoDBMajorVersion
字符串

集群的主要 MongoDB 版本。

创建时：从 MongoDB 的可用版本中进行选择，或者在 MongoDB Cloud 平台上，对当前建议的默认值保持不作指定。推荐的版本是最新的长期支持版本。在整个发布周期中，默认值并不保证是最新发布的版本。有关特定项目中可用的版本，请参阅链接的文档或使用项目 LTS 版本端点的 API 端点。

更新时：一次只能增加 1 个主要版本的版本。 如果将集群固定到比当前 MongoDB 版本低一个主要版本的 MongoDB 功能兼容版本，则 MongoDB 版本可以降级到上一个主要版本。

Atlas 中可用的 MongoDB 版本
MongoDB 版本
字符串([\d]+\.[\d]+\.[\d]+)

集群运行的 MongoDB 版本。

名称
字符串 [ 1 .. 64 ] 个字符 ^[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/json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "labels": [
    ],
  • "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/json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "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"
}

返回所有云提供商地区

返回指定云提供商在指定层级的可用区域列表。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

升级一个共享层集群

将指定项目中的共享层集群升级为专用集群(M 10 +)。要使用此资源，请求的API密钥必须具有“项目集群经理”角色。每个项目最多支持 25 个集群。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

指定项目中共享层集群升级的详细信息。

acceptDataRisksAndForceReplicaSetReconfig
字符串 <date-time>

如果由于区域停电而需要重新配置以重新获得主节点，请与拓扑结构重新配置一起提交此字段，以请求新的区域抗停电拓扑。如果复制的写入操作（甚至多数提交的写入操作）尚未复制到新的主节点，则在大多数可选举节点中断期间强制重新配置会带来数据丢失的风险。MongoDB Atlas 文档包含更多信息。要继续执行存在该风险的操作，请将 acceptDataRisksAndForceReplicaSetReconfig 设置为当前日期。

在区域中断期间重新配置副本集
对象 （集群自动缩放设置）

集群可扩展的实例大小范围。

集群自动伸缩
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 控制台不显示您的标签。

集群标签已弃用，并将在未来版本中删除。我们强烈建议您改用资源标签。

mongoDBMajorVersion
字符串

集群的主要 MongoDB 版本。

创建时：从 MongoDB 的可用版本中进行选择，或者在 MongoDB Cloud 平台上，对当前建议的默认值保持不作指定。推荐的版本是最新的长期支持版本。在整个发布周期中，默认值并不保证是最新发布的版本。有关特定项目中可用的版本，请参阅链接的文档或使用项目 LTS 版本端点的 API 端点。

更新时：一次只能增加 1 个主要版本的版本。 如果将集群固定到比当前 MongoDB 版本低一个主要版本的 MongoDB 功能兼容版本，则 MongoDB 版本可以降级到上一个主要版本。

Atlas 中可用的 MongoDB 版本
MongoDB 版本
字符串([\d]+\.[\d]+\.[\d]+)

集群运行的 MongoDB 版本。

名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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/json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "labels": [
    ],
  • "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/json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "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"
}

将一个共享层集群升级到无服务器实例

将共享层集群升级为指定项目中的无服务器实例。如需使用此资源，请求的“API 密钥”必须具有“项目集群管理器”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

指定项目中共享层集群升级的详细信息。

名称
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

必需
对象 （无服务器实例的云服务提供商设置）

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

对象 (无服务器备份选项）

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

数组 对象 (Resource Tag)

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

terminationProtectionEnabled
布尔
默认： false

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

响应

请求样本

内容类型
application/json
{
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

响应样本

内容类型
application/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 密钥必须具有项目所有者角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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 密钥必须具有“项目只读”角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "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"
}

更新一个集群的配置

更新指定项目中一个集群的详细信息。 集群包含一组维护相同数据集的主机。 此资源不会更新多云集群。要更新多云集群，请使用“更新一个高级集群”。 您一次只能升级集群一个主要版本。 您无法跳过任何主要版本。 每个主要版本都包含一些可能无法与以前版本向后兼容的功能。 查看发布说明，了解可能影响应用程序的更改。 升级 MongoDB 主要版本后，将无法降级到以前的版本。

从 MongoDB 版本 4.2 开始，旧版备份已被弃用，取而代之的是云备份。当您升级到 4.2 或更高版本时，如果您的备份系统当前设置为旧版备份，则它会升级到云备份。升级后，所有现有的旧版备份快照仍然可用。它们会根据您的保留策略随时间推移而过期。 您的备份策略将重置为默认安排。如果您在旧版备份中使用了自定义备份策略，则必须按照云备份文档中概述的步骤重新创建该策略。

要使用此资源，请求的 API 密钥必须具有项目集群经理角色。此功能不适用于M0免费层级集群、 M2和M5共享层级集群。

跨地区集群的节点总数对每个项目有特定的限制。MongoDB Cloud 将一个项目中其他区域的节点总数限制为 40 个。 此总数不包括相互通信的 Google Cloud Platform 地区、免费集群或共享集群。任意两个地区之间的节点总数必须满足此限制。例如，如果一个项目的集群中的节点分布在三个地区：地区 A 30 个节点、地区 B 10 个节点和地区 C 5 个节点，则你只能再向地区 C 添加 5 个节点，因为如果你排除 地区 C， ，地区 A + 地区 B = 40。 如果不包括地区 B、地区 A + 地区 C = 35，<= 40。 如果不包括地区 A、地区 B + 地区 C = 15，<= 40。 每种添加了 5 个节点的地区组合仍符合每个项目的限制：地区 A + B = 40、地区 A + C = 40 和地区 B + C = 20。 如果一个项目有一个或多个集群跨越其他区域的 40 个或更多节点，则无法在该项目中创建多区域集群。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

要为指定项目中的一个集群更新的详细信息。

acceptDataRisksAndForceReplicaSetReconfig
字符串 <date-time>

如果由于区域停电而需要重新配置以重新获得主节点，请与拓扑结构重新配置一起提交此字段，以请求新的区域抗停电拓扑。如果复制的写入操作（甚至多数提交的写入操作）尚未复制到新的主节点，则在大多数可选举节点中断期间强制重新配置会带来数据丢失的风险。MongoDB Atlas 文档包含更多信息。要继续执行存在该风险的操作，请将 acceptDataRisksAndForceReplicaSetReconfig 设置为当前日期。

在区域中断期间重新配置副本集
对象 （集群自动缩放设置）

集群可扩展的实例大小范围。

集群自动伸缩
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 控制台不显示您的标签。

集群标签已弃用，并将在未来版本中删除。我们强烈建议您改用资源标签。

mongoDBMajorVersion
字符串

集群的主要 MongoDB 版本。

创建时：从 MongoDB 的可用版本中进行选择，或者在 MongoDB Cloud 平台上，对当前建议的默认值保持不作指定。推荐的版本是最新的长期支持版本。在整个发布周期中，默认值并不保证是最新发布的版本。有关特定项目中可用的版本，请参阅链接的文档或使用项目 LTS 版本端点的 API 端点。

更新时：一次只能增加 1 个主要版本的版本。 如果将集群固定到比当前 MongoDB 版本低一个主要版本的 MongoDB 功能兼容版本，则 MongoDB 版本可以降级到上一个主要版本。

Atlas 中可用的 MongoDB 版本
MongoDB 版本
字符串([\d]+\.[\d]+\.[\d]+)

集群运行的 MongoDB 版本。

名称
字符串 [ 1 .. 64 ] 个字符 ^[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/json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "labels": [
    ],
  • "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/json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "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"
}

返回单个集群的高级配置选项

返回指定项目中一个集群的高级配置详细信息。集群包含一组维护相同数据集的主机。高级配置详细信息包括读/写关注（write concern）、索引和oplog限制以及其他数据库设置。此功能不适用于 M0 免费集群、M2 和 M5 共享层级集群、Flex 集群或无服务器集群。要使用此资源，请求的API密钥必须具有“项目只读”角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  • "chunkMigrationConcurrency": 0,
  • "customOpensslCipherConfigTls12": [
    ],
  • "defaultMaxTimeMS": 0,
  • "defaultReadConcern": "local",
  • "defaultWriteConcern": "string",
  • "failIndexKeyTooLong": true,
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": true,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "queryStatsLogVerbosity": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 0,
  • "tlsCipherConfigMode": "CUSTOM",
  • "transactionLifetimeLimitSeconds": 1
}

更新一个集群的高级配置选项

更新指定项目中一个集群的高级配置详细信息。集群包含一组维护相同数据集的主机。高级配置详细信息包括读/写关注（write concern）、索引和oplog限制以及其他数据库设置。要使用此资源，请求的API密钥必须具有“项目集群经理”角色。此功能不适用于 M0 免费集群、M2 和 M5 共享层级集群、Flex 集群或无服务器集群。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

要为指定项目中的一个集群添加的高级配置详细信息。

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 集群参数。
默认读关注
字符串
默认： "available"
枚举： "local" "available"

为该集群的读操作设置从 MongoDB 请求的默认确认级别。

MongoDB 4.4 集群默认为 available。MongoDB 5.0 及更高版本集群默认为 local。

该选项对应于全局默认读关注。
默认写关注
字符串

当没有写入操作被驱动程序指定时，请求 MongoDB 确认的默认级别。

该选项对应于隐式默认写关注。
failIndexKeyTooLong
布尔
已弃用
默认： true

指示是否可以插入或更新所有索引条目不超过 1024 字节的文档的标志。如果将其设置为 False，则 mongod 会写入超过此限制的文档，但不会将其编入索引。此参数已从 MongoDB 4.4 中删除。

该选项对应于“mongod”配置文件中的“failIndexKeyTooLong”选项。
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/json
{
  • "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  • "chunkMigrationConcurrency": 0,
  • "customOpensslCipherConfigTls12": [
    ],
  • "defaultMaxTimeMS": 0,
  • "defaultReadConcern": "local",
  • "defaultWriteConcern": "string",
  • "failIndexKeyTooLong": true,
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": true,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "queryStatsLogVerbosity": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 0,
  • "tlsCipherConfigMode": "CUSTOM",
  • "transactionLifetimeLimitSeconds": 1
}

响应样本

内容类型
application/json
{
  • "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  • "chunkMigrationConcurrency": 0,
  • "customOpensslCipherConfigTls12": [
    ],
  • "defaultMaxTimeMS": 0,
  • "defaultReadConcern": "local",
  • "defaultWriteConcern": "string",
  • "failIndexKeyTooLong": true,
  • "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 密钥必须具有项目集群管理员角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{}

将样本数据集请求加载到集群中

请求将 MongoDB 样本数据集加载到指定集群。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

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

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

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

名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

可读的标签，用于标识您加载样本数据集的集群。

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

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

响应

响应样本

内容类型
application/json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "errorMessage": "string",
  • "state": "WORKING"
}

检查集群样本数据集请求的状态

检查将样本数据集加载到一个集群的进度。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

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

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

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

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

唯一的 24 位十六进制数字字符串，用于标识已加载的样本数据集。

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

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

响应

响应样本

内容类型
application/json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "errorMessage": "string",
  • "state": "WORKING"
}

自定义数据库角色

返回、添加、编辑和删除自定义数据库用户权限角色。使用自定义角色来指定 MongoDB Cloud 内置角色无法描述的自定义操作集。您可以在项目级别为项目中的所有集群确定自定义角色。此资源支持 MongoDB 权限操作的子集。您可以创建自定义角色操作子集。要创建更广泛的自定义角色操作列表，请使用 MongoDB Cloud 用户界面。自定义角色必须包括所有项目集群都支持的操作，并且与项目集群使用的每个 MongoDB 版本兼容。例如，如果您的项目具有 MongoDB 4.2 集群，则您无法创建使用 MongoDB 4.4 中引入的操作的自定义角色。

返回一个项目中的所有自定义角色

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

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
[
  • {
    }
]

创建一个自定义角色

在指定项目中创新一个自定义角色。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

在指定项目中创建一个自定义角色。

数组 对象 （数据库特权动作）

角色授予的各个权限操作的列表。

数组 对象 （继承角色） unique

该自定义角色继承的内置角色列表。

roleName
必需
字符串

标识请求角色的可读标签。此名称必须是此项目中此自定义角色的唯一名称。

响应

请求样本

内容类型
application/json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

响应样本

内容类型
application/json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

从一个项目中删除一个自定义角色

删除指定项目中的一个自定义角色。如果删除自定义角色会导致一个或多个子角色没有父角色或操作，则无法删除该角色。如果删除自定义角色会导致一个或多个数据库用户没有角色，则也不能删除。要使用此资源，请求的 API 密钥必须具有“项目 Atlas 管理员”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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
必需
字符串 = 24 个字符 ^([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
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

更新一个项目中的一个自定义角色

在指定项目中更新一个自定义角色。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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

在指定项目中更新一个自定义角色。

数组 对象 （数据库特权动作）

角色授予的各个权限操作的列表。

数组 对象 （继承角色） unique

该自定义角色继承的内置角色列表。

响应

请求样本

内容类型
application/json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ]
}

响应样本

内容类型
application/json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

Data Federation

返回、添加、编辑和删除联合数据库实例。此资源需要您的项目 ID。联合数据库实例配置的更改会影响成本。

返回一个项目中的所有联合数据库实例

返回指定项目中的所有联合数据库实例的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”或更高权限的角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
[
  • {
    }
]

在一个项目中创建一个联合数据库实例

在指定的项目中创建一个联合数据库实例。要使用此资源，请求的 API 密钥必须具有项目所有者或项目图表管理员角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

在指定项目中创建一个联合数据库实例的详细信息。

对象 （Data Federation 云提供商）

托管此联合数据库实例的云提供商。

对象 (DataLakeDataProcessRegion)

有关联邦数据库实例路由客户端连接的云提供商区域的信息。

名称
字符串

人类可读标签，用于标识联合数据库实例。

对象 (DataLakeStorage)

每个数据存储的配置信息及其到 MongoDB Cloud 数据库的映射。

响应

请求样本

内容类型
application/json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "storage": {
    }
}

响应样本

内容类型
application/json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

从一个项目中删除一个联合数据库实例

从指定项目中删除一个联合数据库实例。要使用此资源，请求的 API 密钥必须具有项目所有者或项目图表管理员角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{ }

返回一个项目中的一个联合数据库实例

返回指定项目中一个联合数据库实例的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”或“项目图表管理员”角色。

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

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

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

租户名称
必需
字符串

人类可读标签，用于标识要返回的“联合数据库”。

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

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

响应

响应样本

内容类型
application/json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

创建一个项目中的一个联合数据库实例

更新指定项目中一个联合数据库实例的详细信息。要使用此资源，请求的 API 密钥必须具有项目所有者角色或更高角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

要在指定项目中更新的一个联合数据库的详细信息。

对象 （Data Federation 云提供商）

托管此联合数据库实例的云提供商。

对象 (DataLakeDataProcessRegion)

有关联邦数据库实例路由客户端连接的云提供商区域的信息。

名称
字符串

人类可读标签，用于标识联合数据库实例。

对象 (DataLakeStorage)

每个数据存储的配置信息及其到 MongoDB Cloud 数据库的映射。

响应

请求样本

内容类型
application/json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "storage": {
    }
}

响应样本

内容类型
application/json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

返回一个联合数据库实例的所有查询限制

返回指定项目中联合数据库实例的查询限制。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
[
  • {
    }
]

删除一个联合数据库实例的一个查询限制

删除一个联合数据库实例的一个查询限制。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{ }

返回一个项目中的一个联合数据库实例查询限制

为指定项目中的指定联合数据库实例返回一个查询限制的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "maximumLimit": 0,
  • "name": "string",
  • "overrunPolicy": "BLOCK",
  • "tenantName": "string",
  • "value": 0
}

为一个联合数据库实例配置一个查询限制

为一个联合数据库实例创建或更新一个查询限制。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

为一个联合数据库实例创建或更新一个查询限制。

overrunPolicy
字符串
枚举： "BLOCK" “BLOCK_AND_KILL”

仅用于 Data Federation 限制。超过使用限制时应执行的操作。如果限制跨度设置为 QUERY，则会忽略此限制，因为 MongoDB Cloud 会在查询超过使用限制时停止查询。

值
必需
整型 <int64>

要设置限制的金额。

响应

请求样本

内容类型
application/json
{
  • "overrunPolicy": "BLOCK",
  • "value": 0
}

响应样本

内容类型
application/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: 应用程序/gzip”。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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
必需
字符串 = 24 个字符 ^([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/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
必需
字符串 = 24 个字符 ^([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/json

用于将联合数据库实例和在线存档添加到指定项目的私有端点。

azureLinkId
字符串

标识Azure私有端点连接的链接ID 。

comment
字符串

与此私有端点关联的人类可读字符串。

customerEndpointDNSName
字符串

人类可读标签，用于标识客户 VPC 端点 DNS 名称。如果已定义，则还必须为区域指定一个值。

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

用于连接到Azure私有端点的IP解决。

endpointId
必需
字符串 = 22 个字符 ^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/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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

从一个项目删除一个联合数据库实例和在线归档私有端点

删除指定项目中联合数据库实例或在线归档的一个私有端点。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

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

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

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

endpointId
必需
字符串 = 22 个字符 ^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/json
{ }

返回一个项目中的一个联合数据库实例和在线存档私有端点

返回指定项目中联合数据库实例或在线归档的指定私有端点。要使用此资源，请求的 API 密钥必须具有“项目只读”或“项目图表管理员”角色。

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

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

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

endpointId
必需
字符串 = 22 个字符 ^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/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

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

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

响应

响应样本

内容类型
application/json
[
  • {
    }
]

创建一个数据湖管道已弃用

创建一个 Atlas 数据湖管道。

数据湖管道已弃用。请参阅数据湖弃用指南。
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

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

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

请求正文模式：application/json

创建一个 Atlas 数据湖管道。

对象 (数据集保留政策）

预定数据湖管道的数据集保留策略。

名称
字符串

该“数据湖管道”的名称。

对象 （摄取目标）

Atlas 数据湖管道的摄取目标。

对象 （摄取来源）

Atlas 数据湖管道的摄取来源。

数组 对象 （字段转换）

要为此 Data Lake 管道排除的字段。

响应

请求样本

内容类型
application/json
{
  • "datasetRetentionPolicy": {
    },
  • "name": "string",
  • "sink": { },
  • "source": {
    },
  • "transformations": [
    ]
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串 [ 1 .. 64 ] 个字符 ^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

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

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

响应

响应样本

内容类型
application/json
{ }

返回一个数据湖管道已弃用

返回指定项目中的数据湖管道的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

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

pipelineName
必需
字符串 [ 1 .. 64 ] 个字符 ^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

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

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

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

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

响应

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串 [ 1 .. 64 ] 个字符 ^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

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

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

请求正文模式：application/json

更新一个数据湖管道。

对象 (数据集保留政策）

预定数据湖管道的数据集保留策略。

名称
字符串

该“数据湖管道”的名称。

对象 （摄取目标）

Atlas 数据湖管道的摄取目标。

对象 （摄取来源）

Atlas 数据湖管道的摄取来源。

数组 对象 （字段转换）

要为此 Data Lake 管道排除的字段。

响应

请求样本

内容类型
application/json
{
  • "datasetRetentionPolicy": {
    },
  • "name": "string",
  • "sink": { },
  • "source": {
    },
  • "transformations": [
    ]
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串 [ 1 .. 64 ] 个字符 ^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

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

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

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

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

响应

响应样本

内容类型
application/json
[
  • {
    }
]

返回一个数据湖管道的可用备份快照已弃用

返回可用于触发按需管道运行的备份快照列表。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

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

pipelineName
必需
字符串 [ 1 .. 64 ] 个字符 ^[^/\\ "$]{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>
示例： completedAfter=2022-01-01T00:00:00Z

MongoDB Cloud 在该日期和时间之后创建了快照。如果指定，MongoDB Cloud 仅返回在此时间和日期之后创建的可用备份快照。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

暂停一个 Data Lake 管道已弃用

暂停指定项目内数据湖管道的摄取。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

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

pipelineName
必需
字符串 [ 1 .. 64 ] 个字符 ^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

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

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

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

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

响应

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串 [ 1 .. 64 ] 个字符 ^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

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

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

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

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

响应

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串 [ 1 .. 64 ] 个字符 ^[^/\\ "$]{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>
示例： createdBefore=2022-01-01T00:00:00Z

如果指定，Atlas 只返回在此时间和日期之前启动的“数据湖管道”运行。

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

删除管道运行数据集已弃用

删除 Atlas 在指定管道运行期间生成的数据集。

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

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

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

pipelineName
必需
字符串 [ 1 .. 64 ] 个字符 ^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

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

唯一的 24 位十六进制字符串，用于标识 Atlas 数据湖管道运行。

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

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

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

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

响应

响应样本

内容类型
application/json
{ }

返回一个数据湖管道运行已弃用

返回指定项目中一个数据湖管道运行的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

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

pipelineName
必需
字符串 [ 1 .. 64 ] 个字符 ^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

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

唯一的 24 位十六进制字符串，用于标识 Atlas 数据湖管道运行。

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

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

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

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

响应

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

pipelineName
必需
字符串 [ 1 .. 64 ] 个字符 ^[^/\\ "$]{1,64}$

用于标识 Atlas 数据湖管道的人类可读标签。

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

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

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

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

请求正文模式：application/json

触发快照的单次摄取运行。

对象 (数据集保留政策）

预定数据湖管道的数据集保留策略。

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

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

响应

请求样本

内容类型
application/json
{
  • "datasetRetentionPolicy": {
    },
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

创建一个项目中的一个数据库用户

创建指定项目中的一个数据库用户。此 MongoDB Cloud 支持每个项目最多 100 个数据库用户。如果某个项目需要超过 100 个数据库用户，请联系支持部门。要使用此资源，请求的 API 密钥必须具有项目所有者或项目图表管理员角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/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 个字符 ^([a-f0-9]{24})$

用于标识项目的唯一的 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/json
例子

AWS IAM 身份验证

{
  • "awsIAMType": "USER",
  • "databaseName": "$external",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user"
}

响应样本

内容类型
application/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
必需
字符串 = 24 个字符 ^([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/json
{ }

从一个项目中返回一个数据库用户

返回属于指定项目的一个数据库用户。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/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
必需
字符串 = 24 个字符 ^([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/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 个字符 ^([a-f0-9]{24})$

用于标识项目的唯一的 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/json
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "oidcAuthType": "NONE",
  • "password": "stringst",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "string",
  • "x509Type": "NONE"
}

响应样本

内容类型
application/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"
}

使用客户密钥管理进行静态加密

返回和编辑使用客户密钥管理配置的静态加密。无论您是否使用自己的密钥管理，MongoDB Cloud 都会加密所有存储。

为一个项目返回使用客户管理密钥的一项静态加密配置

使用您通过云提供商管理的密钥返回静态加密配置。即使您不使用自己的密钥管理，MongoDB Cloud 也会加密所有存储。此资源要求请求的 API 密钥具有项目所有者角色。

仅限于 M10 或更高版本：MongoDB Cloud 将此功能限制为 M10 或更高版本的专用集群层级。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "awsKms": {
    },
  • "azureKeyVault": {},
  • "googleCloudKms": {
    }
}

为一个项目更新使用客户托管密钥的静态加密配置

使用您通过云提供商管理的密钥更新静态加密配置。即使您不使用自己的密钥管理，MongoDB Cloud 也会加密所有存储。此资源要求请求的 API 密钥具有项目所有者角色。此功能不适用于 M0 免费集群、M2、M5 或无服务器集群。

使用客户密钥管理提供程序为 MongoDB Cloud 项目配置至少一项静态加密后，项目所有者可以为需要加密的每个 MongoDB Cloud 集群启用使用客户密钥管理的静态加密。使用客户密钥管理提供程序的静态加密不必与集群云服务提供商匹配。MongoDB Cloud 不会自动轮换用户管理的加密密钥。使用客户密钥管理提供程序的文档和密钥轮换最佳实践指南，遵循您首选的静态加密。当您在 MongoDB Cloud 项目中使用密钥管理配置使用客户密钥管理的静态加密时，MongoDB Cloud 会自动创建 90 天密钥轮换警报。无论您是否使用自己的密钥管理，MongoDB Cloud 都会加密所有存储。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

所需参数取决于是否有人启用了使用客户密钥管理的静态加密：

如果已使用客户密钥管理 (CMK) 启用静态加密，Atlas 需要所需加密提供商的所有参数。

  • 如需使用“AWS 密钥管理服务”(KMS)，MongoDB Cloud 需要 awsKms 对象中的所有字段。
  • 要使用 Azure Key Vault，MongoDB Cloud 需要 azureKeyVault 对象中的所有字段。
  • 要使用 Google Cloud Key Management Service (KMS)，MongoDB Cloud 需要 googleCloudKms 对象中的所有字段。

如果启用了使用客户密钥管理的静态加密，管理员只能传递 awsKms、azureKeyVault 或 googleCloudKms 对象中已更改的字段，以更新此端点的配置。

对象 (AWSKMSConfiguration)

Amazon Web Services (AWS) KMS 配置详细信息和指定项目的静态加密配置集。

Amazon Web Services Key Management Service
对象 (AzureKeyVault)

定义使用 Azure Key Vault (AKV) 的静态加密配置的详细信息。

Azure Key Vault
对象 (GoogleCloudKMS)

定义使用 Google Cloud Key Management Service (KMS) 的静态加密配置的详细信息。

Google Cloud Key Management Service

响应

请求样本

内容类型
application/json
{
  • "awsKms": {
    },
  • "azureKeyVault": {},
  • "googleCloudKms": {
    }
}

响应样本

内容类型
application/json
{
  • "awsKms": {
    },
  • "azureKeyVault": {},
  • "googleCloudKms": {
    }
}

事件(Events)

返回事件。此集合仍在修订中，可能会更改。

返回一个项目中的所有事件

返回指定项目的所有事件。事件用于标识重要的数据库、计费或安全活动或状态更改。要使用此资源，请求的API密钥必须具有“项目只读”角色。

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

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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 格式的标记。

clusterNames
数组 字符串[ items [ 1 .. 64 ] characters ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

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

数组 警报审核类型（对象）或警报审核类型（对象）或API用户事件类型（对象）或服务帐户事件类型（对象）或App Services事件类型（对象）或自动索引事件类型（对象）或自动化配置事件类型（对象）或 AWS 对等 Vpc 审核类型（对象）或Azure对等网络审核类型（对象）或计费事件类型（对象）或集群连接审核类型（对象）或集群事件类型（对象）或 Cps 备份事件类型（对象） ）或数据浏览器访问的事件类型（对象）或 CPS 备份合规性策略事件类型（对象）或磁盘备份事件类型（对象）或加密事件类型（对象）或导出存储桶审核类型（对象）或 FTS 索引审核类型（对象） ）或GCP对等 Vpc 审核类型（对象）或群组审核类型（对象）或群组事件类型（对象）或群组集成事件类型（对象）或主机事件类型（对象）或主机指标事件类型（对象）或索引构建审核类型 (对象）或 NDS 审核类型（对象）或 NDS DB Check 审核类型（对象）或 NDS 数据验证审核类型（对象）或 NDS 自动扩展审核类型（对象）或 NDS 维护窗口审核类型（对象）或 NDS 无服务器自动扩展审核类型（对象）或 NDS 无服务器实例审核类型（对象）或 NDS 自动伸缩 审核类型（对象）或 NDS 租户端点服务部署 审核类型（对象）或 NDS x 509 用户身份验证事件类型（对象）或在线存档事件类型（对象）或私有链接审核类型（对象）或主动操作事件类型（对象）或 ReplicaSet 事件类型（对象）或搜索部署审核类型（对象）或无服务器部署审核类型（对象）或无服务器事件类型（对象） ）、设置无服务器审核类型（对象）、流事件类型（对象）、流处理器事件类型（对象）、支持案例事件类型（对象）、支持事件类型（对象）、团队事件类型（对象）、租户备份p 事件类型（对象）或用户事件类型（对象）或版本审核类型（对象）或资源事件类型（对象）或访问事件类型（对象） (EventTypeForNdsGroup)

此时记录的事件类别。

重要提示：事件类型值的完整列表经常更改。

数组 警报审核类型（对象）或警报审核类型（对象）或API用户事件类型（对象）或服务帐户事件类型（对象）或App Services事件类型（对象）或自动索引事件类型（对象）或自动化配置事件类型（对象）或 AWS 对等 Vpc 审核类型（对象）或Azure对等网络审核类型（对象）或计费事件类型（对象）或集群连接审核类型（对象）或集群事件类型（对象）或 Cps 备份事件类型（对象） ）或数据浏览器访问的事件类型（对象）或 CPS 备份合规性策略事件类型（对象）或磁盘备份事件类型（对象）或加密事件类型（对象）或导出存储桶审核类型（对象）或 FTS 索引审核类型（对象） ）或GCP对等 Vpc 审核类型（对象）或群组审核类型（对象）或群组事件类型（对象）或群组集成事件类型（对象）或主机事件类型（对象）或主机指标事件类型（对象）或索引构建审核类型 (对象）或 NDS 审核类型（对象）或 NDS DB Check 审核类型（对象）或 NDS 数据验证审核类型（对象）或 NDS 自动扩展审核类型（对象）或 NDS 维护窗口审核类型（对象）或 NDS 无服务器自动扩展审核类型（对象）或 NDS 无服务器实例审核类型（对象）或 NDS 自动伸缩 审核类型（对象）或 NDS 租户端点服务部署 审核类型（对象）或 NDS x 509 用户身份验证事件类型（对象）或在线存档事件类型（对象）或私有链接审核类型（对象）或主动操作事件类型（对象）或 ReplicaSet 事件类型（对象）或搜索部署审核类型（对象）或无服务器部署审核类型（对象）或无服务器事件类型（对象） ）、设置无服务器审核类型（对象）、流事件类型（对象）、流处理器事件类型（对象）、支持案例事件类型（对象）、支持事件类型（对象）、团队事件类型（对象）、租户备份p 事件类型（对象）或用户事件类型（对象）或版本审核类型（对象）或资源事件类型（对象）或访问事件类型（对象） (EventTypeForNdsGroup)

希望从查询结果中排除的事件类别，如 CLUSTER_CREATED

重要提示：事件类型名称会经常变更。检查事件类型的完整列表，确认您正确指定了事件类型。

includeRaw
布尔
默认： false

指示是否在输出中包含原始文档的标记。原始文档包含有关事件的其他元信息。

maxDate
字符串 <date-time>

MongoDB Cloud 停止返回事件的日期和时间。此参数使用 UTC 格式的 ISO 8601 时间戳。

minDate
字符串 <date-time>

MongoDB Cloud 开始返回事件的日期和时间。此参数使用 UTC 格式的 ISO 8601 时间戳。

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

从一个项目中返回一个事件

为指定项目返回一个事件。事件用于标识重要的数据库、计费或安全活动或状态更改。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

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

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

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

唯一的 24 位十六进制数字字符串，用于标识要返回的事件。使用 /events 端点检索已通过身份验证的用户可以访问的所有事件。

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

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

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

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

includeRaw
布尔
默认： false

指示是否在输出中包含原始文档的标记。原始文档包含有关事件的其他元信息。

响应

响应样本

内容类型
application/json
例子
{
  • "apiKeyId": "32b6e34b3d91647abb20e7b8",
  • "created": "2019-08-24T14:15:22Z",
  • "eventTypeName": "AUTO_INDEXING_ENABLED",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "isGlobalAdmin": false,
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "publicKey": "test.user@mongodb.com",
  • "raw": {
    },
  • "remoteAddress": "216.172.40.186",
  • "userId": "32b6e34b3d91647abb20e7b8",
  • "username": "test.user@mongodb.com"
}

从一个组织返回所有事件

返回指定组织的所有事件。事件标识重要的数据库、计费或安全活动或状态更改。要使用此资源，请求的 API 密钥必须具有“组织成员”角色。

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

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

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
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 格式的标记。

数组 警报审核类型（对象）或警报审核类型（对象）或 API 用户事件类型（对象）或服务帐户事件类型（对象）或计费事件类型（对象）或联合设置事件类型（对象）或组审核类型（对象）或 Mlab 迁移审核类型（对象）或 NDS 审核类型（对象）或组织事件类型（对象）或合作伙伴事件类型（对象）或支持事件类型（对象）或团队事件类型（对象）或用户事件类型（对象）或资源事件类型（对象）或 Atlas 资源策略审核类型（对象） （EventTypeForOrg）

此时记录的事件类别。

重要提示：事件类型值的完整列表经常更改。

includeRaw
布尔
默认： false

指示是否在输出中包含原始文档的标记。原始文档包含有关事件的其他元信息。

maxDate
字符串 <date-time>

MongoDB Cloud 停止返回事件的日期和时间。此参数使用 UTC 格式的 ISO 8601 时间戳。

minDate
字符串 <date-time>
示例： minDate= 2021 - 11 - 17 T 23 : 15 : 00.06 Z

MongoDB Cloud 开始返回事件的日期和时间。此参数使用 UTC 格式的 ISO 8601 时间戳。

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

从一个组织返回一个事件

返回指定组织的所有事件。事件用于标识重要的数据库、计费或安全活动或状态更改。要使用此资源，请求的 API 密钥必须具有组织成员角色。

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

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

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

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

唯一的 24 位十六进制数字字符串，用于标识要返回的事件。使用 /events 端点检索已通过身份验证的用户可以访问的所有事件。

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

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

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

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

includeRaw
布尔
默认： false

指示是否在输出中包含原始文档的标记。原始文档包含有关事件的其他元信息。

响应

响应样本

内容类型
application/json
例子
{
  • "apiKeyId": "32b6e34b3d91647abb20e7b8",
  • "created": "2019-08-24T14:15:22Z",
  • "eventTypeName": "FEDERATION_SETTINGS_CREATED",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "isGlobalAdmin": false,
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "publicKey": "test.user@mongodb.com",
  • "raw": {
    },
  • "remoteAddress": "216.172.40.186",
  • "userId": "32b6e34b3d91647abb20e7b8",
  • "username": "test.user@mongodb.com"
}

联合身份验证

返回、添加、编辑和删除与联合相关的功能，例如角色映射和连接的组织配置。

删除一个联合设置实例

删除联合设置实例和所有关联数据，包括身份提供程序和域。要使用此资源，请求的 API 密钥必须在最后一个剩余的连接组织中具有“组织所有者”角色。注意：如果联合中有多个连接的组织，则对该资源的请求将会失败。

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

用于标识联合的唯一的 24 位十六进制数字字符串。

响应

响应样本

内容类型
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服务账户
路径参数
federationSettingsId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 55fa922fb343282757d9554e

用于标识联合的唯一的 24 位十六进制数字字符串。

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

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

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

响应每页返回的列项数。

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

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

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

删除连接到一个联合的一个组织配置

从指定联合中删除一个已连接的组织配置。要使用此资源，请求的 API 密钥必须具有组织所有者角色。注意：如果联合中仅存在一个已连接的组织，则此请求将失败。

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

用于标识联合的唯一的 24 位十六进制数字字符串。

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

唯一的 24 位十六进制数字字符串，用于标识要删除的连接组织配置。

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

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

响应

响应样本

内容类型
application/json
{ }

返回连接到一个联合的一个组织配置

返回指定联合中指定的已连接组织配置。要使用此资源，请求的 API 密钥必须在一个已连接的组织中具有组织所有者角色。

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

用于标识联合的唯一的 24 位十六进制数字字符串。

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

唯一的 24 位十六进制数字字符串，用于标识要返回的连接组织配置。

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

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

响应

响应样本

内容类型
application/json
{
  • "dataAccessIdentityProviderIds": [
    ],
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "stringstringstringst",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

更新连接到一个联合的一个组织配置

从指定联合中更新一个连接的组织配置。要使用此资源，请求的 API 密钥必须具有组织所有者角色。

请注意，如果组织配置中没有关联身份提供商，则无法使用此资源更新角色映射或发布授权角色授予。

注意：如果请求中未提供，则 domainRestrictionEnabled 字段默认为 false。

注意：如果未提供 identityProviderId 字段，则会断开组织和身份供应商的连接。

注意：如果 dataAccessIdentityProviderIds 字段中缺少当前已连接的数据访问身份提供商，则会断开连接。

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

用于标识联合的唯一的 24 位十六进制数字字符串。

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

唯一的 24 位十六进制数字字符串，用于标识要更新的连接组织配置。

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

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

请求正文模式：application/json

要更新的连接组织配置。

dataAccessIdentityProviderIds
数组 字符串 unique [ 列项 = 24 个字符 ^([a-f0-9]{24})$ ]

代表可用于该组织数据访问的身份提供者的唯一 ID 集合。

domainAllowList
数组 字符串 unique

根据电子邮件地址限制用户加入组织的批准域。

domainRestrictionEnabled
必需
布尔

指示是否为此连接的组织启用域限制的值。

identityProviderId
字符串 = 20 个字符 ^([a-f0-9]{20})$

旧有的 20 位十六进制数字字符串，用于标识此已连接的组织配置所关联的用户界面访问身份提供者。通过单击已配置身份提供者的 IdP ID 行中的信息图标，可以在“联合管理控制台” > “身份提供者”选项卡中找到此 ID。

postAuthRoleGrants
数组 字符串 unique
列项枚举： “ORG_OWNER” "ORG_MEMBER" “ORG_GROUP_CREATOR” "ORG_BILLING_ADMIN" “ORG_BILLING_READ_ONLY” "ORG_READ_ONLY"

身份验证后向该组织中的用户授予的 Atlas 角色。角色是一个人类可读的标签，用于标识 MongoDB Cloud 授予特定 MongoDB Cloud 用户的权限集合。这些角色只能是组织特定的角色。

数组 对象 （联邦身份验证角色映射） unique

在此组织中配置的角色映射。

数组 对象 （联合用户）

包含电子邮件地址与允许列表中的任何域都不匹配的用户的列表。

响应

请求样本

内容类型
application/json
{
  • "dataAccessIdentityProviderIds": [
    ],
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "stringstringstringst",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

响应样本

内容类型
application/json
{
  • "dataAccessIdentityProviderIds": [
    ],
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "stringstringstringst",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

返回一个组织的所有角色映射

为指定联合中的指定组织返回所有角色映射。要使用此资源，请求的 API 密钥必须具有“组织所有者”角色。

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

用于标识联合的唯一的 24 位十六进制数字字符串。

orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

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

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

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

将一个角色映射添加到一个组织

添加指定联合中指定组织中的一个角色映射。要使用此资源，请求的 API 密钥必须具有组织所有者角色。

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

用于标识联合的唯一的 24 位十六进制数字字符串。

orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

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

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

请求正文模式：application/json

要创建的角色映射。

externalGroupName
必需
字符串 [ 1 .. 200 ] 个字符

唯一的人类可读标签，用于标识应用此角色映射的身份提供程序群组。

数组 对象 （RoleAssignment） unique

Atlas 角色以及与每个角色关联的组和组织的唯一标识符。数组中必须至少有一个元素包含“组织”角色及其相应的 orgId。数组中的每个元素都可以具有 orgId 或 groupId 的值，但不能同时具有两者的值。

响应

请求样本

内容类型
application/json
{
  • "externalGroupName": "string",
  • "roleAssignments": [
    ]
}

响应样本

内容类型
application/json
{
  • "externalGroupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "roleAssignments": [
    ]
}

删除一个组织中的一个角色映射

删除指定联合中指定组织的一个角色映射。要使用此资源，请求的 API 密钥必须具有“组织所有者”角色。

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

用于标识联合的唯一的 24 位十六进制数字字符串。

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

唯一的 24 位十六进制数字字符串，用于标识要删除的角色映射。

orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

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

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

响应

响应样本

内容类型
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服务账户
路径参数
federationSettingsId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 55fa922fb343282757d9554e

用于标识联合的唯一的 24 位十六进制数字字符串。

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

唯一的 24 位十六进制数字字符串，用于标识要返回的角色映射。

orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

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

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

响应

响应样本

内容类型
application/json
{
  • "externalGroupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "roleAssignments": [
    ]
}

更新一个组织中的一项角色映射

更新指定联合中指定组织中的一个角色映射。要使用此资源，请求的 API 密钥必须具有组织所有者角色。

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

用于标识联合的唯一的 24 位十六进制数字字符串。

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

唯一的 24 位十六进制数字字符串，用于标识要更新的角色映射。

orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

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

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

请求正文模式：application/json

要更新的角色映射。

externalGroupName
必需
字符串 [ 1 .. 200 ] 个字符

唯一的人类可读标签，用于标识应用此角色映射的身份提供程序群组。

数组 对象 （RoleAssignment） unique

Atlas 角色以及与每个角色关联的组和组织的唯一标识符。数组中必须至少有一个元素包含“组织”角色及其相应的 orgId。数组中的每个元素都可以具有 orgId 或 groupId 的值，但不能同时具有两者的值。

响应

请求样本

内容类型
application/json
{
  • "externalGroupName": "string",
  • "roleAssignments": [
    ]
}

响应样本

内容类型
application/json
{
  • "externalGroupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "roleAssignments": [
    ]
}

返回一个联合中的所有身份提供程序

返回指定联合中具有提供的协议和类型的所有身份提供程序。如果未指定 protocol，则仅返回 SAML 身份提供程序。如果未指定 idpType，则仅返回 WORKFORCE 身份提供程序。要使用该资源，请求的 API 密钥必须具有连接的组织之一的组织所有者角色。

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

用于标识联合的唯一的 24 位十六进制数字字符串。

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

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

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

响应每页返回的列项数。

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

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

protocol
数组 字符串
列项枚举： "SAML" "OIDC"

目标身份提供程序的协议。

idpType
数组 字符串
列项枚举： "WORKFORCE" "WORKLOAD"

目标身份提供程序的类型。

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

返回一个 SAML 身份提供程序

从指定联合中返回一个 SAML 身份提供商。要使用此资源，请求的 API 密钥必须在连接的组织之一中具有组织所有者角色。

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

用于标识联合的唯一的 24 位十六进制数字字符串。

identityProviderId
必需
字符串 = 20 个字符 ^([a-f0-9]{20})$
示例： c2777a9eca931f29fc2f

旧版 20 位十六进制数字字符串，用于标识身份提供程序。通过单击已配置身份提供程序的 IdP ID 行中的信息图标，可以在联合管理控制台 > 身份提供程序标签页中找到此 ID。

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

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

响应

响应样本

内容类型
application/json
{
  • "acsUrl": "string",
  • "associatedDomains": [
    ],
  • "associatedOrgs": [
    ],
  • "audienceUri": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "displayName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "idpType": "WORKFORCE",
  • "issuerUri": "string",
  • "oktaIdpId": "stringstringstringst",
  • "pemFileInfo": {
    },
  • "protocol": "SAML",
  • "requestBinding": "HTTP-POST",
  • "responseSignatureAlgorithm": "SHA-1",
  • "slug": "string",
  • "ssoDebugEnabled": true,
  • "ssoUrl": "string",
  • "status": "ACTIVE",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

返回一个身份提供程序的元数据

返回指定联邦中一个身份提供者的元数据。要使用此资源，请求的 API 密钥必须在连接的组织之一中具有组织所有者角色。

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

用于标识联合的唯一的 24 位十六进制数字字符串。

identityProviderId
必需
字符串 = 20 个字符 ^([a-f0-9]{20})$
示例： c2777a9eca931f29fc2f

旧版 20 位十六进制数字字符串，用于标识身份提供程序。通过单击已配置身份提供程序的 IdP ID 行中的信息图标，可以在联合管理控制台 > 身份提供程序标签页中找到此 ID。

响应

响应样本

内容类型
application/json
"string"

返回一个组织的联合设置

返回指定机构的联合设置信息。要使用此资源，请求 API 密钥必须在已连接的组织中具有组织所有者角色。

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

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

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

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

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

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

响应

响应样本

内容类型
application/json
{
  • "federatedDomains": [
    ],
  • "hasRoleMappings": true,
  • "id": "32b6e34b3d91647abb20e7b8",
  • "identityProviderId": "c2777a9eca931f29fc2f",
  • "identityProviderStatus": "ACTIVE"
}

Atlas 全球集群

返回、添加和删除“全局集群”托管的命名空间和自定义区域映射。“全局集群”中的每个集合都与托管的命名空间相关联。创建“全局集群”托管的命名空间时，MongoDB Cloud 会为该命名空间创建空集合。创建托管命名空间并不会用数据填充集合。同样，删除托管命名空间时不会删除相关的集合。MongoDB Cloud 会使用所需的位置字段和自定义分片键对空集合分片。例如，如果自定义分片键是 city，那么复合分片键就是 location, city。每个“全局集群”还与一个或多个“全局写入区域”相关联。当用户创建“全局集群”时，MongoDB Cloud 会自动将每个位置代码映射到最近的地理区域。自定义区域映射允许管理员覆盖这些自动映射。例如，有用例可能需要将位置代码映射到地理位置遥远的区域。管理员可以在创建或修改“全局集群”时，使用下面的 API 和“全局集群配置”窗格管理自定义区域映射。

返回所有全局集群数据

返回指定全局集群的所有托管命名空间和自定义区域映射。 托管命名空间使用数据库名称、点分隔符和collection名称来标识collection。自定义区域映射将 ISO 3166-2 位置代码与全球集群中的区域进行匹配。 要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

从一个全球集群中删除所有自定义区域映射。

删除指定全局集群的所有自定义区域映射。自定义区域映射将一个 ISO 3166-2 位置代码与全局集群中的一个区域相匹配。删除自定义区域映射可恢复默认映射。默认情况下，MongoDB Cloud 会将每个位置代码映射到最近的地理区域。要使用该资源，请求的 API 密钥必须具有项目所有者角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

将自定义区域映射添加到一个全局集群

将一个或多个自定义区域映射添加到指定的全局集群。 自定义区域映射将一个 ISO 3166-2 位置代码与全球集群中的区域进行匹配。 默认情况下，MongoDB Cloud 会将每个位置代码映射到最近的地理区域。 要使用此资源，请求的 API 密钥必须具有项目所有者角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

要添加到指定全局集群的自定义区域映射。

数组 对象 （Atlas 全球集群区域）

包含以逗号分隔的键值对的列表，用于将区域映射到地理区域。这些键值对将 ISO 3166-1a2 位置代码与 ISO 3166-2 子行政区代码（如有可能）映射到所需自定义区域的人类可读标签上。MongoDB Cloud 默认将 ISO 3166-1a2 代码映射到最近的地理区域。包含可覆盖默认映射的此参数。

如果不存在自定义区域，则此参数会返回空对象。

响应

请求样本

内容类型
application/json
{
  • "customZoneMappings": [
    ]
}

响应样本

内容类型
application/json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

从一个全局集群中删除一个托管命名空间

删除指定全局集群内的一个托管命名空间。托管命名空间使用数据库名称、点分隔符和集合名称来标识集合。删除托管命名空间不会删除关联的集合或数据。要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。

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

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

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

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

标识此全局集群的人类可读标签。

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

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

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

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

db
字符串

用于标识包含该集合的数据库的人类可读标签。

集合
字符串

用于标识与托管命名空间关联的集合的人类可读标签。

响应

响应样本

内容类型
application/json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

在一个全局集群中创建一个托管命名空间

创建指定全局集群中的一个托管命名空间。托管命名空间使用数据库名称、点分隔符和集合名称来标识集合。要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

在指定全局集群中创建的托管命名空间。

集合
必需
字符串

用于管理此全局集群中的集合的人工可读标签。

db
必需
字符串

用于管理此全局集群的数据库的人工可读标签。

isCustomShardKeyHashed
布尔
默认： false

指示是否有人对指定collection的自定义分片键进行哈希处理的标志。如果将此值设置为false ，MongoDB Cloud 将使用范围分片。

哈希分片键
isShardKeyUnique
布尔
默认： false

指示是否有人对自定义分片键进行哈希处理的标志。 如果此参数返回false ，则该集群使用范围分片。

numInitialChunks
整型 <int64> <= 8192

使用哈希分片键对空collection进行分片时，最初创建的最小数据块数。

全球集群分片
presplitHashedZones
布尔
默认： false

该标志指示 MongoDB Cloud 是否应为空或不存在的集合创建和分配初始数据段。MongoDB Cloud 根据集合的定义区域和区域范围来分发数据。

哈希片键

响应

请求样本

内容类型
application/json
{
  • "collection": "string",
  • "db": "string",
  • "isCustomShardKeyHashed": false,
  • "isShardKeyUnique": false,
  • "numInitialChunks": 8192,
  • "presplitHashedZones": false
}

响应样本

内容类型
application/json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

从一个全球集群中删除所有自定义区域映射。

删除指定全局集群的所有自定义区域映射。自定义区域映射将一个 ISO 3166-2 位置代码与全局集群中的一个区域相匹配。删除自定义区域映射可恢复默认映射。默认情况下，MongoDB Cloud 会将每个位置代码映射到最近的地理区域。要使用该资源，请求的 API 密钥必须具有项目所有者角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

从一个全局集群中删除一个托管命名空间

删除指定全局集群内的一个托管命名空间。托管命名空间使用数据库名称、点分隔符和集合名称来标识集合。删除托管命名空间不会删除关联的集合或数据。要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。

Atlas 全球集群
授权：
DigestAuth服务账户
路径参数
集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

groupId
必需
字符串 = 24 个字符 ^([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 格式的标记。

db
字符串

用于标识包含该集合的数据库的人类可读标签。

集合
字符串

用于标识与托管命名空间关联的集合的人类可读标签。

响应

响应样本

内容类型
application/json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

发票

返回发票。

返回一个组织的所有发票

返回 MongoDB 向指定组织开具的全部发票。此列表包括所有发票，无论发票状态如何。如需使用此资源，请求的 API 密钥必须具有“组织账单查看器”、“组织账单管理员”或“组织所有者”角色。如果您有跨组织设置，只要您有“组织账单管理员”或“组织负责人”角色，就可以查看链接的发票。计算发票的总欠款要将每张发票的欠款总额相加。它可以计算为包含在发票中的每笔付款的欠款总额。要计算付款的欠款金额可使用公式 totalBilledCents * unitPrice + salesTax - startingBalanceCents。

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

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
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 格式的标记。

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

指示是否在 linkedInvoices 字段中返回链接发票的标志。

statusNames
数组 字符串 unique
列项枚举： "PENDING" "Closed" "FORGIVEN" "FAILED" "PAID" "FREE" "PREPAID" "INVOICED"

要检索的发票的状态。省略返回所有状态的发票。

fromDate
字符串 <date>
示例： fromDate=2023-01-01

检索 startDate 大于或等于 fromDate 的发票。如果省略，发票返回将回溯到最早开始日期。

toDate
字符串 <date>
示例： toDate=2023-01-01

检索 endDates 小于或等于 toDate 的发票。 如果省略，发票返回将进一步到最晚结束日期。

sortBy
字符串
默认： "END_DATE"
枚举： “START_DATE” "END_DATE"

用于对返回的发票进行排序的字段。与 orderBy 参数结合使用可控制结果的顺序。

ORDER BY
字符串
默认： “desc”
枚举： “desc” "asc"
示例： orderBy=desc

用于对返回的发票进行排序的字段。与 sortBy 参数结合使用可控制结果的顺序。

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

返回一个组织的所有待处理发票

返回指定组织的当前计费周期内应计费用的所有发票。如需使用此资源，请求的 API 密钥必须具有“组织账单查看器”、“组织账单管理员”或“组织所有者”角色。如果您有跨组织设置，只要您有“组织账单管理员”或“组织负责人”角色，就可以查看链接的发票。

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

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

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

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

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

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

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

返回一张组织发票

返回 MongoDB 向指定组织开具的一张发票。用于标识发票的唯一的 24 位十六进制数字字符串。您可以选择以 JSON 或 CSV 格式接收此发票。如需使用此资源，请求的 API 密钥必须具有“组织账单查看器”、“组织账单管理员”或“组织所有者”角色。如果您有跨组织设置，并且具有“组织账单管理员”或“组织所有者”角色，则可以查询链接的发票。计算发票的总欠款金额 — 将发票中包含的每笔付款的总欠款金额加起来。要计算付款的欠款金额 — 使用公式 totalBilledCents * unitPrice + salesTax - startingBalanceCents。

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

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

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

唯一的 24 位十六进制数字字符串，用于标识提交给指定组织的发票。收费一般在第二天发出。

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

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

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

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

响应

响应样本

内容类型
{
  • "amountBilledCents": 0,
  • "amountPaidCents": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "creditsCents": 0,
  • "endDate": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lineItems": [
    ],
  • "linkedInvoices": [
    ],
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "payments": [
    ],
  • "refunds": [
    ],
  • "salesTaxCents": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "startingBalanceCents": 0,
  • "statusName": "PENDING",
  • "subtotalCents": 0,
  • "updated": "2019-08-24T14:15:22Z"
}

以 CSV 格式返回一张组织发票

返回 MongoDB 以 CSV 格式向指定组织开具的一张发票。用于标识发票的唯一的 24 位十六进制数字字符串。要使用此资源，请求的 API 密钥至少具有组织账单查看器、组织账单管理员或组织所有者角色。如果您有跨组织设置，并且具有组织账单管理员或组织所有者角色，则可以查询链接的发票。计算发票的总欠款要将发票中包含的每笔付款的总欠款相加。要计算付款的欠款金额可使用公式 totalBilledCents * unitPrice + salesTax - startingBalanceCents。

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

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

invoiceId
必需
字符串[0-9a-f]+

唯一的 24 位十六进制数字字符串，用于标识提交给指定组织的发票。收费一般在第二天发出。

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

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

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

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

响应

响应样本

内容类型
text/csv
发票编号,666acb8787ba43606905dcae,
账单期,“2024 年 6 月 1 日 - 2024 年 7 月 1 日”,
组织名称,测试 2,
组织 ID,666acb8787ba43606905dcac,

Date,使用日期,说明,注意,组织名称,组织 ID,项目,项目 ID,SKU,区域,集群,副本集(Replica Set),Config Server,应用程序,单位,单价,数量,折扣百分比,金额

LDAP 配置

返回、编辑、验证和删除 LDAP 配置。LDAP 配置定义了 MongoDB Cloud 通过 TLS 连接到 LDAP 服务器以进行用户身份验证和授权的设置。LDAP 服务器必须对 Internet 可见或通过 VPC 对等互连连接到 MongoDB 云集群。此外，LDAP 服务器必须使用 TLS。您必须具有 MongoDB Cloud 管理员用户权限才能使用这些端点。此外，要使用 LDAPS 配置用户身份验证和授权，您的集群必须运行 MongoDB 3.6 或更高版本。您已配置 LDAPS 的群组无法使用 MongoDB 3.6 或更低版本创建集群。

返回当前 LDAP 或 X.509 配置

返回指定项目的当前 LDAP 配置。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}

编辑 LDAP 或 X.509 配置

为指定项目编辑 LDAP 配置。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

更新此配置会触发数据库的滚动重启。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

为指定项目更新 LDAP 配置。

对象 （数据库用户 TLS 证书设置）

为数据库用户配置 TLS 证书的设置。

对象 （LDAP 安全设置）

适用于指定项目的基于传输层安全性 (TLS) 的轻量级目录访问协议 (LDAP) 配置详细信息。

响应

请求样本

内容类型
application/json
{
  • "customerX509": {
    },
  • "ldap": {
    }
}

响应样本

内容类型
application/json
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}

删除当前 LDAP 用户到 DN 的映射

从指定项目的 LDAP 配置中删除在 userToDNMapping 文档中捕获的当前 LDAP 标识名映射。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}

验证一个项目中的 LDAP 配置

为指定项目验证 LDAP 配置。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

要验证的指定项目的 LDAP 配置。

authzQueryTemplate
字符串
默认： "{USER}?memberOf?base"

MongoDB Cloud 应用轻型目录访问协议 (LDAP) 查询模板来创建 LDAP 查询，以返回与经过身份验证的 MongoDB 用户关联的 LDAP 组。MongoDB Cloud 仅使用此参数进行用户授权。

在“统一资源定位符”(URL) 中使用 {USER} 占位符来替代经过身份验证的用户名。查询与主机名指定的主机有关。按照 RFC 4515 和 RFC 4516 格式设置查询。

bindPassword
必需
字符串

MongoDB Cloud 用于验证 bindUsername 的密码。

bindUsername
必需
字符串^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:...

MongoDB Cloud 用于连接到 LDAP 主机的轻型目录访问协议 (LDAP) 用户的完整可分辨名称 (DN)。LDAP 可分辨名称的格式必须符合 RFC 2253。

RFC 2253
caCertificate
字符串

MongoDB Cloud 用于验证轻量级目录访问协议 (LDAP) 主机身份的证书颁发机构 (CA) 证书。MongoDB Cloud 允许自签名证书。要删除分配的值，请传递空字符串："caCertificate": ""。

主机名
必需
字符串^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:)...

用户可读的标签，用于标识轻量级目录访问协议 (LDAP) 主机的主机名或 Internet 协议 (IP) 地址。此主机必须能够访问 Internet 或具有与集群的 Virtual Private Cloud (VPC) 对等连接连接。

端口
必需
整型 <int32>
默认： 636

轻量级目录访问协议 (LDAP) 主机侦听客户端连接的 IANA 端口。

响应

请求样本

内容类型
application/json
{
  • "authzQueryTemplate": "{USER}?memberOf?base",
  • "bindPassword": "string",
  • "bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
  • "caCertificate": "string",
  • "hostname": "string",
  • "port": 636
}

响应样本

内容类型
application/json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "request": {
    },
  • "requestId": "32b6e34b3d91647abb20e7b8",
  • "status": "FAIL",
  • "validations": [
    ]
}

返回单个验证 LDAP 配置请求的状态

返回一个请求的状态，以验证指定项目的一个 LDAP 配置。 要使用此资源，请求的 API 密钥必须具有项目所有者角色。

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

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

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

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

标识验证 LDAP 配置请求的唯一字符串。

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

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

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

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

响应

响应样本

内容类型
application/json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "request": {
    },
  • "requestId": "32b6e34b3d91647abb20e7b8",
  • "status": "FAIL",
  • "validations": [
    ]
}

传统备份

管理传统备份快照、恢复作业、计划和检查点。

返回所有已弃用的传统备份检查点

返回指定项目中一个集群的所有传统备份检查点。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

返回一个旧版备份检查点已弃用

返回指定项目中一个集群的一个传统备份检查点。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

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

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

标识检查点的唯一 24 位十六进制数字字符串。

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "completed": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "parts": [
    ],
  • "restorable": true,
  • "started": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"
}

返回所有传统备份恢复作业已弃用

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

自 2020 年 3 月 23 日起，所有新集群只能使用云备份。当升级到 4.2 时，如果备份系统当前设置为传统备份，则它会升级到云备份。升级后，所有现有的传统备份快照仍然可用。它们会根据您的保留政策随时间推移而过期。您的备份政策将重置为默认计划。如果传统备份应用的是自定义备份政策，则须按照云备份文档中的步骤说明重新创建该政策。如果您使用 BATCH-ID 查询参数，则可以检索指定批处理中的所有恢复作业。为分片集群创建恢复作业时，MongoDB Cloud 会为每个分片创建一个单独的作业，并为配置服务器创建另一个作业。这些作业中的每一个都是批处理的一部分。但是，批处理不能包含副本集的恢复作业。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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 格式的标记。

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

唯一的 24 位十六进制数字字符串，用于标识要返回的恢复作业批次。为分片集群创建恢复作业时，应用程序会为每个分片创建单独的作业，再加上用于配置主机的作业，时间戳以 ISO 8601 日期和时间格式显示，采用 UTC 时区。其中每个作业都由单个批次组成。副本集的恢复作业不能作为批次的一部分。

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

创建一个传统备份恢复作业 已弃用

恢复指定项目中一个集群的一个传统备份。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。自 2020 年 3 月 23 日起，所有新集群只能使用云备份。当升级到 4.2 时，如果备份系统当前设置为传统备份，则它会升级到云备份。升级后，所有现有的传统备份快照仍然可用。它们会根据您的保留政策随时间推移而过期。您的备份政策将重置为默认计划。如果传统备份应用的是自定义备份政策，则须按照云备份文档中的程序重新创建该政策。此端点不支持为分片集群创建检查点恢复作业，也不支持为可查询备份快照创建恢复作业。如果通过在请求正文中指定 AUTOMATED_RESTORE 的 delivery.methodName 来创建自动恢复作业，MongoDB Cloud 会在恢复之前删除目标集群上的所有现有数据。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

用于恢复到指定项目中的一个集群的传统备份。

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

唯一的 24 位十六进制数字字符串，用于标识分片集群检查点。检查点表示要还原数据的时间点。此参数适用于 "delivery.methodName" : "AUTOMATED_RESTORE"。此参数仅适用于分片集群。

  • 如果您设置 checkpointId，则无法设置 oplogInc、oplogTs、snapshotId 或 pointInTimeUTCMillis。
  • 如果提供此参数，则此端点会将截至此检查点的所有数据还原到您在交付对象中指定的数据库。
必需
对象 （恢复快照交付元数据）

说明如何交付恢复的快照数据的方法和详细信息。

oplogInc
整型 <int32> >= 1

32 位递增序数，表示特定秒内的操作。与 oplogTs 配合使用时，这表示 MongoDB Cloud 将数据恢复到的时间点。此参数在 "delivery.methodName" : "AUTOMATED_RESTORE" 时适用。

  • 如果设置了 oplogInc，则必须设置 oplogTs，并且无法设置 checkpointId、snapshotId 或 pointInTimeUTCMillis。
  • 如果您提供此参数，则此端点会将截至且包括此 Oplog 时间戳在内的所有数据还原到您在交付对象中指定的数据库。
oplogTs
字符串^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9...

要还原此快照的日期和时间。此参数以 UTC 的 ISO 8601 格式表示其值，代表了 Oplog 时间戳的第一部分。与 oplogTs 配合使用时，这些信息代表要将数据恢复到的上一次数据库操作的时间点。此参数在"delivery.methodName" : "AUTOMATED_RESTORE"时适用。在副本集上对 local.oplog.rs 运行查询，以查找所需的时间戳。

  • 如果设置了 oplogTs，则必须设置 oplogInc，并且无法设置 checkpointId、snapshotId 或 pointInTimeUTCMillis。
  • 如果您提供此参数，则此端点会将截至且包括此 Oplog 时间戳在内的所有数据还原到您在交付对象中指定的数据库。
pointInTimeUTCMillis
整型 <int64> >= 1199145600000

要还原此快照的时间戳。该参数以自 UNIX 纪元以来经过的毫秒数表示其值。此时间戳必须在当前时间的最后 24 小时内。此参数适用于 "delivery.methodName" : "AUTOMATED_RESTORE"。

  • 如果提供此参数，此端点会将截至该时间点的所有数据恢复到在交付对象中指定的数据库中。
  • 如果设置了 pointInTimeUTCMillis，则无法设置 oplogInc、oplogTs、snapshotId 或 checkpointId。
snapshotId
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要恢复的快照。如果设置了 snapshotId，则无法设置 oplogInc、oplogTs、pointInTimeUTCMillis 或 checkpointId。

响应

请求样本

内容类型
application/json
{
  • "checkpointId": "32b6e34b3d91647abb20e7b8",
  • "delivery": {
    },
  • "oplogInc": 1,
  • "oplogTs": "string",
  • "pointInTimeUTCMillis": 1199145600000,
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

返回一项传统备份恢复作业已弃用

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

自 2020 年 3 月 23 日起，所有新集群只能使用云备份。当升级到 4.2 时，如果备份系统当前设置为传统备份，则它会升级到云备份。升级后，所有现有的传统备份快照仍然可用。它们会根据您的保留政策随时间推移而过期。您的备份政策将重置为默认计划。如果传统备份应用的是自定义备份政策，则须按照云备份文档中的步骤说明重新创建该政策。

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

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

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

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

人类可读标签，标识具有待返回的快照的集群。

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

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

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

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

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

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

响应

响应样本

内容类型
application/json
{
  • "batchId": "32b6e34b3d91647abb20e7b8",
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "delivery": {
    },
  • "encryptionEnabled": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hashes": [],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "statusName": "IN_PROGRESS",
  • "timestamp": {
    }
}

返回已弃用的单个快照计划

返回指定项目中一个集群的快照计划。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

自 2020 年 3 月 23 日起，所有新集群只能使用云备份。当升级到 4.2 时，如果备份系统当前设置为传统备份，则它会升级到云备份。升级后，所有现有的传统备份快照仍然可用。它们会根据您的保留政策随时间推移而过期。您的备份政策将重置为默认计划。如果传统备份应用的是自定义备份政策，则须按照云备份文档中的步骤说明重新创建该政策。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "clusterCheckpointIntervalMin": 15,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "dailySnapshotRetentionDays": 0,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "monthlySnapshotRetentionMonths": 0,
  • "pointInTimeWindowHours": 0,
  • "snapshotIntervalHours": 6,
  • "snapshotRetentionDays": 2,
  • "weeklySnapshotRetentionWeeks": 0
}

更新一个集群的快照计划已弃用

更新指定项目中一个集群的快照计划。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

自 2020 年 3 月 23 日起，所有新集群只能使用云备份。当升级到 4.2 时，如果备份系统当前设置为传统备份，则它会升级到云备份。升级后，所有现有的传统备份快照仍然可用。它们会根据您的保留政策随时间推移而过期。您的备份政策将重置为默认计划。如果传统备份应用的是自定义备份政策，则须按照云备份文档中的步骤说明重新创建该政策。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

更新指定项目中一个集群的快照计划。

clusterCheckpointIntervalMin
必需
整型 <int32>
枚举： 15 30 60

连续集群检查点之间的时间量（以分钟为单位）。此参数仅适用于分片集群。此数字决定了分片集群的连续云备份粒度。

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

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

dailySnapshotRetentionDays
必需
整型 <int32>
枚举： 0 3 4 5 6 7 15 30 60 90 120 180 360

保留每日快照的时间量。MongoDB Cloud 以天为单位表示此值。将此值设置为 0 以禁用每日快照保留。

monthlySnapshotRetentionMonths
必需
整型 <int32>
枚举： 0 1 2 3 4 5 6 7 8 9 10 11 12 13 18 24 36

MongoDB Cloud 必须保留每月快照的月数。将此值设置为 0 以禁用每月快照保留。

pointInTimeWindowHours
必需
整型 <int32>

MongoDB Cloud 可以创建连续云备份快照的当前时间之前的小时数。

snapshotIntervalHours
必需
整型 <int32>
枚举： 6 8 12 24

在拍摄另一个快照之前必须经过的小时数。

snapshotRetentionDays
必需
整型 <int32>
枚举： 2 3 4 5

MongoDB Cloud 必须保留最近快照的天数。

weeklySnapshotRetentionWeeks
必需
整型 <int32>
枚举： 0 1 2 3 4 5 6 7 8 12 16 20 24 52

MongoDB Cloud 必须保留每周快照的周数。将此值设置为 0 以禁用每周快照保留。

响应

请求样本

内容类型
application/json
{
  • "clusterCheckpointIntervalMin": 15,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "dailySnapshotRetentionDays": 0,
  • "monthlySnapshotRetentionMonths": 0,
  • "pointInTimeWindowHours": 0,
  • "snapshotIntervalHours": 6,
  • "snapshotRetentionDays": 2,
  • "weeklySnapshotRetentionWeeks": 0
}

响应样本

内容类型
application/json
{
  • "clusterCheckpointIntervalMin": 15,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "dailySnapshotRetentionDays": 0,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "monthlySnapshotRetentionMonths": 0,
  • "pointInTimeWindowHours": 0,
  • "snapshotIntervalHours": 6,
  • "snapshotRetentionDays": 2,
  • "weeklySnapshotRetentionWeeks": 0
}

返回所有传统备份快照已弃用

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

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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 格式的标记。

completed
字符串
默认： "true"
枚举： “全部” "true" "false"

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

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

删除一个传统备份快照已过时

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

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

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

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

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

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/json
{ }

返回一张已弃用的传统备份快照

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

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

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

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

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

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

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

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

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

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

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

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

响应

响应样本

内容类型
application/json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "complete": true,
  • "created": {
    },
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "incremental": true,
  • "lastOplogAppliedTimestamp": {
    },
  • "links": [],
  • "parts": [
    ]
}

更改单个已弃用的传统备份快照有效期

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

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

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

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

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

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

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

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

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

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

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

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

请求正文模式：application/json

更改一个传统备份快照的到期时间

doNotDelete
布尔

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

expires
字符串 <date-time>

MongoDB Cloud 删除快照的日期和时间。如果为 "doNotDelete" : true，则 MongoDB Cloud 将删除为此参数设置的任何值。

响应

请求样本

内容类型
application/json
{
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z"
}

响应样本

内容类型
application/json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "complete": true,
  • "created": {
    },
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "incremental": true,
  • "lastOplogAppliedTimestamp": {
    },
  • "links": [],
  • "parts": [
    ]
}

维护窗口

返回、编辑和删除维护窗口。MongoDB Cloud 执行的维护程序需要在每个副本集的维护窗口期间至少进行一次副本集选举。您最多可以将项目的计划维护事件推迟两次。推迟的维护事件会在您首选的维护窗口中发生，正好是之前计划的日期和时间一周后。

重置一个项目的一个维护窗口

重置指定项目的维护窗口。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。诸如安全补丁之类的紧急维护活动无法等待您选择的时间窗口。MongoDB Cloud 会在需要时启动这些维护活动。为集群安排了维护计划后，在当前维护工作完成之前，您无法更改维护窗口。MongoDB Cloud 执行的维护程序需要在每个副本集的维护窗口期间至少进行一次副本集选举。维护总是尽可能接近预定时间开始，但正在进行的集群更新或意外的系统问题可能会延迟开始时间。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

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

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

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

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

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

响应

响应样本

内容类型
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"
}

为一个项目返回一个维护窗口

返回指定项目的维护窗口。MongoDB Cloud 会在需要时启动这些维护活动。在当前维护工作完成之前，您不能更改维护窗口。MongoDB Cloud 执行的维护程序需要在每个副本集的维护窗口期间至少进行一次副本集选举。维护总是尽可能接近预定时间开始，但正在进行的集群更新或意外的系统问题可能会延迟开始时间。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "autoDeferOnceEnabled": true,
  • "dayOfWeek": 1,
  • "hourOfDay": 23,
  • "numberOfDeferrals": 0,
  • "protectedHours": {
    },
  • "startASAP": true,
  • "timeZoneId": "string"
}

更新一个项目的维护窗口

更新指定项目的维护窗口。诸如安全补丁之类的紧急维护活动无法等待您选择的窗口。MongoDB Cloud 会在需要时启动这些维护活动。为集群安排维护后，在当前维护工作完成之前，您无法更改维护窗口。MongoDB Cloud 执行的维护程序需要在每个副本集的维护窗口期间至少进行一次副本集选举。维护总是尽可能接近预定时间开始，但正在进行的集群更新或意外的系统问题可能会延迟开始时间。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

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

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

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

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

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

请求正文模式：application/json

更新指定项目的维护窗口。

autoDeferOnceEnabled
布尔

指示 MongoDB Cloud 是否应在启用所有维护窗口后将其推迟一周的标志。

dayOfWeek
必需
整型 <int32> [ 1 .. 7 ]

基于 1 的整数，表示维护窗口开始的具体星期几。

值 周中的某一天
1 星期日
2 星期一
3 星期二
4 星期三
5 星期四
6 星期五
7 星期六
hourOfDay
整型 <int32> [ 0 .. 23 ]

从零开始的整数，表示维护窗口按照 24 小时制开始的当天中的某个小时。午夜使用 0，中午使用 12。

对象 (ProtectedHours)

定义不会开始维护的窗口。

startASAP
布尔

标志，表示 MongoDB Cloud 是否在收到此请求后立即启动维护窗口。如需立即启动项目的维护窗口，MongoDB Cloud 必须安排了维护，而且您必须设置维护窗口。MongoDB Cloud 完成维护后，该标记会重置为 false。

响应

请求样本

内容类型
application/json
{
  • "autoDeferOnceEnabled": true,
  • "dayOfWeek": 1,
  • "hourOfDay": 23,
  • "protectedHours": {
    },
  • "startASAP": true
}

响应样本

内容类型
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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

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

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

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

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

响应

响应样本

内容类型
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"
}

为一个项目推迟一个维护窗口

推迟指定项目的维护窗口。诸如安全补丁之类的紧急维护活动无法等待您选择的窗口。MongoDB Cloud 会在需要时启动这些维护活动。为集群安排维护后，在当前维护工作完成之前，您无法更改维护窗口。MongoDB Cloud 执行的维护程序需要在每个副本集的维护窗口期间至少进行一次副本集选举。维护总是尽可能接近预定时间开始，但正在进行的集群更新或意外的系统问题可能会延迟开始时间。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

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

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

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

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

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

响应

响应样本

内容类型
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"
}

MongoDB Cloud 用户

返回、添加和编辑 MongoDB Cloud 用户。

创建一个 MongoDB Cloud 用户

创建一个 MongoDB Cloud 用户帐户。MongoDB Cloud 用户帐户仅授予对 MongoDB Cloud 应用程序的访问权限。要授予数据库访问权限，请创建数据库用户。MongoDB Cloud 会向您指定的用户发送电子邮件，邀请他们加入项目。受邀用户在接受邀请之前无权访问该项目。邀请将在 30 天后过期。

MongoDB Cloud 将 MongoDB Cloud 用户成员数限制为每个团队最多 250 名 MongoDB Cloud 用户。MongoDB Cloud 将 MongoDB Cloud 用户成员数限制为每个项目 500 个 MongoDB Cloud 用户和每个组织 500 个 MongoDB Cloud 用户，其中包括组织所有项目的成员数量总和。如果操作超出这些限制，MongoDB Cloud 会引发错误。例如，如果组织有 5 个项目，每个项目有 100 个 MongoDB Cloud 用户，并且每个 MongoDB Cloud 用户仅属于一个项目，那么如果不先从组织中删除现有 MongoDB Cloud 用户的情况下，您无法向此组织添加任何 MongoDB Cloud 用户。

要使用此资源，请求的 API 密钥可以具有任何角色。

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

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

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

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

请求正文模式：application/json

要创建的 MongoDB Cloud 用户帐户。

国家
必需
字符串^([A-Z]{2})$

两个字母字符，用于标识 MongoDB Cloud 用户的地理位置。此参数使用 ISO 3166-1a2 代码格式。

名
必需
字符串

属于 MongoDB Cloud 用户的名或姓。

姓
必需
字符串

属于 MongoDB Cloud 用户的姓氏。

mobileNumber
必需
字符串(?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1...

属于 MongoDB Cloud 用户的手机号码。

密码
必需
字符串 <password> >= 8 个字符

密码与用户名一起应用以登录 MongoDB Cloud。MongoDB Cloud 不会返回此参数，除非响应创建新的 MongoDB Cloud 用户。从 MongoDB Cloud 控制台设置密码后，只有 MongoDB Cloud 用户可以更新其密码。

数组 对象 （角色分配）

显示 MongoDB Cloud 用户角色以及该角色适用的相应组织或项目的对象列表。一个角色可应用于一个组织或一个项目，但不能同时应用于两者。

用户名
必需
字符串 <email>

代表 MongoDB Cloud 用户的用户名的电子邮件地址。

响应

请求样本

内容类型
application/json
{
  • "country": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "mobileNumber": "string",
  • "password": "pa$$word",
  • "roles": [
    ],
  • "username": "user@example.com"
}

响应样本

内容类型
application/json
{
  • "country": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "emailAddress": "user@example.com",
  • "firstName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastAuth": "2019-08-24T14:15:22Z",
  • "lastName": "string",
  • "links": [],
  • "mobileNumber": "string",
  • "password": "pa$$word",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

使用用户名返回一个 MongoDB Cloud 用户

返回具有指定用户名的一个 MongoDB Cloud 用户帐户的详细信息。您无法使用此端点返回有关 API 密钥的信息。要返回有关 API 密钥的信息，请使用返回一个组织 API 密钥端点。要使用此资源，请求的 API 密钥可以具有任何角色。

授权：
DigestAuth服务账户
路径参数
用户名
必需
字符串^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%...

MongoDB Cloud 用户账户的电子邮件地址。创建用户后不能修改该地址。

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

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

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

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

响应

响应样本

内容类型
application/json
{
  • "country": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "emailAddress": "user@example.com",
  • "firstName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastAuth": "2019-08-24T14:15:22Z",
  • "lastName": "string",
  • "links": [],
  • "mobileNumber": "string",
  • "password": "pa$$word",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

使用用户 ID 返回单个 MongoDB Cloud 用户

返回具有指定的用户唯一标识符的一个 MongoDB Cloud 用户帐户的详细信息。您无法使用此端点返回 API 密钥上的信息。要返回有关 API 密钥的信息，请使用返回一个组织 API 密钥端点。您可以随时找回自己的用户账户。如果您是 MongoDB Cloud 组织或项目的所有者，还可以找回具有该组织或项目成员资格的任何用户的用户个人资料。要使用此资源，请求的 API 密钥可以具有任何角色。

授权：
DigestAuth服务账户
路径参数
用户 ID
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

用于标识此用户的唯一的 24 位十六进制数字字符串。

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

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

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

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

响应

响应样本

内容类型
application/json
{
  • "country": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "emailAddress": "user@example.com",
  • "firstName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastAuth": "2019-08-24T14:15:22Z",
  • "lastName": "string",
  • "links": [],
  • "mobileNumber": "string",
  • "password": "pa$$word",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

监控和日志

返回数据库部署监控和日志记录数据。

下载一个项目中一台集群主机的日志

返回压缩 (.gz)日志文件，其中包含指定项目的指定托管的范围日志消息。 MongoDB每五分钟更新一次集群后端基础架构的进程和Atlas 审核日志。日志以长度约为五分钟的数据段存储，但此持续时间可能会有所不同。如果您轮询API中的日志文件，我们建议每五分钟轮询一次，即使连续轮询可能包含一些重叠的日志。此功能不适用于 M0 免费集群、M2、M5、Flex 或无服务器集群。要使用此资源，请求的API密钥必须具有“项目数据访问只读”或更高角色。该API不支持使用 json 响应模式直接调用。您必须使用以下格式的接受标头来请求gzip 响应模式：“Accept: 应用程序/vnd.atlas.YYYY-MM-DD+gzip”。

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

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

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

主机名
必需
字符串^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:)...

用户可读的标签，用于标识存储要下载的日志文件的主机。

logName
必需
字符串
枚举： “mongodb” "mongos" "mongodb-audit-log" "mongos-audit-log"

用户可读的标签，用于标识要返回的日志文件。要返回审核日志，请为指定项目启用数据库审核。

设置数据库审核
查询参数
envelope
布尔
默认： false
示例： envelope=false

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

endDate
整型 <int64> >= 1199145600

指定要检索的日志消息范围终点的日期和时间，单位为自 UNIX 纪元起经过的秒数。此值将默认为开始日期后 24 小时。如果还未指定开始日期，则该值将默认为请求的时间。

startDate
整型 <int64> >= 1199145600

指定要检索的日志消息范围起点的日期和时间，单位为自 UNIX 纪元起经过的秒数。此值将默认为结束日期前 24 小时。如果还未指定结束日期，则该值将默认为请求的时间前 24 小时。

响应

响应样本

内容类型
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"
}

返回一个流程的所有 Atlas Search 指标类型

返回可用于指定项目中一个流程的所有 Atlas Search 指标类型。您必须具有“项目只读”或更高角色才能查看 Atlas Search 指标类型。

授权：
DigestAuth服务账户
路径参数
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 端口。

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

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

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

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

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

响应

响应样本

内容类型
application/json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hardwareMetrics": [
    ],
  • "indexMetrics": [
    ],
  • "links": [],
  • "processId": "mongodb.example.com:27017",
  • "statusMetrics": [
    ]
}

返回单个命名空间的所有 Atlas Search 索引指标

返回指定进程中一个命名空间在指定时间范围内的 Atlas Search 索引指标。

授权：
DigestAuth服务账户
路径参数
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

用于标识集合的用户可读标签。

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

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

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

查询参数
粒度
必需
字符串
示例： granularity=PT1M

持续时间，用于指定 Atlas 报告指标的时间间隔。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。

period
字符串
示例： period=PT10H

Atlas 报告指标的持续时间。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。在未设置开始和结束时包含此参数。

开始
字符串 <date-time>

MongoDB Cloud 开始报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

end
字符串 <date-time>

MongoDB Cloud 停止报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

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

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

衡量标准
必需
数组 字符串 <= 10 个列项 unique
列项枚举： “INDEX_SIZE_ON_DISK” "NUMBER_OF_DELETES" “NUMBER_OF_ERROR_QUERIES” "NUMBER_OF_GETMORE_COMMANDS" "NUMBER_OF_INDEX_FIELDS" "NUMBER_OF_INSERTS" "NUMBER_OF_SUCCESS_QUERIES" "NUMBER_OF_UPDATES" "REPLICATION_LAG" “TOTAL_NUMBER_OF_QUERIES”

包含 MongoDB Atlas 报告的关联数据系列的测量值的列表。

响应

响应样本

内容类型
application/json
{
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "indexIds": [
    ],
  • "indexStatsMeasurements": [
    ],
  • "links": [],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

返回单个指定名称空间中单个索引的 Atlas Search 指标

返回指定进程上的一个命名空间和索引名称在提供的时间范围内的 Atlas Search 指标数据系列。您必须具有“项目只读”或更高角色才能查看 Atlas Search 指标类型。

授权：
DigestAuth服务账户
路径参数
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 端口。

indexName
必需
字符串
示例： myindex

用于标识索引的可读标签。

数据库名称
必需
字符串
示例： mydb

用于标识数据库的人类可读标签。

collectionName
必需
字符串
示例： mycoll

用于标识集合的用户可读标签。

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

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

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

查询参数
粒度
必需
字符串
示例： granularity=PT1M

持续时间，用于指定 Atlas 报告指标的时间间隔。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。

period
字符串
示例： period=PT10H

Atlas 报告指标的持续时间。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。在未设置开始和结束时包含此参数。

开始
字符串 <date-time>

MongoDB Cloud 开始报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

end
字符串 <date-time>

MongoDB Cloud 停止报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

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

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

衡量标准
必需
数组 字符串 <= 10 个列项 unique
列项枚举： “INDEX_SIZE_ON_DISK” "NUMBER_OF_DELETES" “NUMBER_OF_ERROR_QUERIES” "NUMBER_OF_GETMORE_COMMANDS" "NUMBER_OF_INDEX_FIELDS" "NUMBER_OF_INSERTS" "NUMBER_OF_SUCCESS_QUERIES" "NUMBER_OF_UPDATES" "REPLICATION_LAG" “TOTAL_NUMBER_OF_QUERIES”

包含 MongoDB Atlas 报告的关联数据系列的测量值的列表。

响应

响应样本

内容类型
application/json
{
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "indexIds": [
    ],
  • "indexStatsMeasurements": [
    ],
  • "links": [],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

返回 Atlas Search 硬件和状态指标

返回指定项目中某个进程在提供的时间范围内的 Atlas Search 硬件和状态数据系列。您必须具有“项目只读”或更高角色才能查看 Atlas Search 指标类型。

授权：
DigestAuth服务账户
路径参数
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 端口。

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

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

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

查询参数
粒度
必需
字符串
示例： granularity=PT1M

持续时间，用于指定 Atlas 报告指标的时间间隔。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。

period
字符串
示例： period=PT10H

Atlas 报告指标的持续时间。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。在未设置开始和结束时包含此参数。

开始
字符串 <date-time>

MongoDB Cloud 开始报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

end
字符串 <date-time>

MongoDB Cloud 停止报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

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

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

衡量标准
必需
数组 字符串 <= 10 个列项 unique
列项枚举： "FTS_DISK_USAGE" "FTS_PROCESS_CPU_KERNEL" "FTS_PROCESS_CPU_USER" "FTS_PROCESS_NORMALIZED_CPU_KERNEL" "FTS_PROCESS_NORMALIZED_CPU_USER" "FTS_PROCESS_RESIDENT_MEMORY" "FTS_PROCESS_SHARED_MEMORY" "FTS_PROCESS_VIRTUAL_MEMORY" "JVM_CURRENT_MEMORY" “JVM_MAX_MEMORY” "PAGE_FAULTS"

包含您希望 MongoDB Atlas 报告关联数据系列的指标的列表。如果不设置此参数，该资源将返回相关数据系列的所有硬件和状态指标。

响应

响应样本

内容类型
application/json
{
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hardwareMeasurements": [
    ],
  • "links": [],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z",
  • "statusMeasurements": [
    ]
}

返回一个项目中的所有 MongoDB 进程

返回指定项目的所有进程的详细信息。MongoDB 进程可以是 mongod 或 mongos。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

按 ID 返回单个 MongoDB 进程

返回指定项目对应的指定主机的进程。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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}\:...
示例： mongodb.example.com:27017

主机名和为 MongoDB 进程提供服务的互联网号码分配机构 (IANA) 端口的组合。主机必须是运行 MongoDB 进程 ( mongod 或 mongos ) 的主机的主机名、完全限定域名 (FQDN) 或 Internet 协议地址（IPv4 或 IPv6）。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。

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

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

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

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

响应

响应样本

内容类型
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostname": "string",
  • "id": "string",
  • "lastPing": "2019-08-24T14:15:22Z",
  • "links": [],
  • "port": 0,
  • "replicaSetName": "string",
  • "shardName": "string",
  • "typeName": "REPLICA_PRIMARY",
  • "userAlias": "string",
  • "version": "string"
}

返回一个 MongoDB 进程的可用数据库

返回在指定项目对应的指定主机上运行的数据库列表。M0免费集群、M2 、M5 和无服务器集群有一些操作限制。MongoDB Cloud 进程必须是 mongod。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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}\:...
示例： mongodb.example.com:27017

主机名和为 MongoDB 进程提供服务的互联网号码分配机构 (IANA) 端口的组合。主机必须是运行 MongoDB 进程 (mongod) 的主机的主机名、完全限定域名 (FQDN) 或 Internet 协议地址（IPv4 或 IPv6）。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。

查询参数
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/json
{}

为 MongoDB 进程返回一个数据库

返回在指定项目对应的指定主机上运行的一个数据库。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

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

数据库名称
必需
字符串

用户可读标签，用于标识指定 MongoDB 进程所服务的数据库。

processId
必需
字符串^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
示例： mongodb.example.com:27017

主机名和为 MongoDB 进程提供服务的互联网号码分配机构 (IANA) 端口的组合。主机必须是运行 MongoDB 进程 ( mongod 或 mongos ) 的主机的主机名、完全限定域名 (FQDN) 或 Internet 协议地址（IPv4 或 IPv6）。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。

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

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

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

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

响应

响应样本

内容类型
application/json
{}

返回一个 MongoDB 进程的一个数据库的测量值

返回指定项目的指定主机的一个数据库的测量值。根据 MongoDB dbStats 命令输出返回数据库的磁盘上存储空间。要计算某些指标系列，Atlas 会计算每两个相邻点之间的比率。对于这些指标系列，第一个数据点具有 null 值，因为 Atlas 无法计算给定查询时间范围的第一个数据点的比率。Atlas 每 20 分钟检索一次数据库指标，但会在必要时降低频率以优化数据库性能。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

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

数据库名称
必需
字符串

用户可读标签，用于标识指定 MongoDB 进程所服务的数据库。

processId
必需
字符串^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
示例： mongodb.example.com:27017

主机名和为 MongoDB 进程提供服务的互联网号码分配机构 (IANA) 端口的组合。主机必须是运行 MongoDB 进程 ( mongod 或 mongos ) 的主机的主机名、完全限定域名 (FQDN) 或 Internet 协议地址（IPv4 或 IPv6）。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。

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

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

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

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

m
数组 字符串 [1.. 10] 个列项 unique
列项枚举： "DATABASE_AVERAGE_OBJECT_SIZE" "DATABASE_COLLECTION_COUNT" "DATABASE_DATA_SIZE" “DATABASE_STORAGE_SIZE” "DATABASE_INDEX_SIZE" "DATABASE_INDEX_COUNT" “DATABASE_EXTENT_COUNT” "DATABASE_OBJECT_COUNT" "DATABASE_VIEW_COUNT"

为该 MongoDB 进程请求的一个或多个度量类型。如果省略，资源将返回所有度量值。如需为 m 指定多个值，请为每个值重复输入 m 参数。指定适用于指定主机的度量值。如果指定了任何无效的度量值，MongoDB Cloud 将返回错误信息。

粒度
必需
字符串
示例： granularity=PT1M

持续时间，用于指定 Atlas 报告指标的时间间隔。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。

period
字符串
示例： period=PT10H

Atlas 报告指标的持续时间。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。在未设置开始和结束时包含此参数。

开始
字符串 <date-time>

MongoDB Cloud 开始报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

end
字符串 <date-time>

MongoDB Cloud 停止报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

响应

响应样本

内容类型
application/json
{
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostId": "mongodb.example.com:27017",
  • "links": [],
  • "measurements": [
    ],
  • "partitionName": "string",
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

返回一个 MongoDB 进程的可用磁盘

返回指定项目对应的指定主机的磁盘或分区列表。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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}\:...
示例： mongodb.example.com:27017

主机名和为 MongoDB 进程提供服务的互联网号码分配机构 (IANA) 端口的组合。主机必须是运行 MongoDB 进程 ( mongod 或 mongos ) 的主机的主机名、完全限定域名 (FQDN) 或 Internet 协议地址（IPv4 或 IPv6）。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。

查询参数
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/json
{}

返回一个磁盘的测量值

返回指定项目的指定主机的一个磁盘或分区的测量详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
partitionName
必需
字符串

测量所适用的磁盘或分区的用户可读标签。

groupId
必需
字符串 = 24 个字符 ^([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}\:...
示例： mongodb.example.com:27017

主机名和为 MongoDB 进程提供服务的互联网号码分配机构 (IANA) 端口的组合。主机必须是运行 MongoDB 进程 ( mongod 或 mongos ) 的主机的主机名、完全限定域名 (FQDN) 或 Internet 协议地址（IPv4 或 IPv6）。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。

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

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

响应

响应样本

内容类型
application/json
{}

返回一个 MongoDB 进程的一个磁盘的测量值

返回指定项目的指定主机的一个磁盘或分区的测量值。返回的值可以是以下值之一：

  • 用于 MongoDB 进程的磁盘分区的 I/O 操作吞吐量
  • 向磁盘分区发出请求和由磁盘分区提出请求的时间百分比
  • 用于 MongoDB 进程的磁盘分区的每种操作类型的延迟
  • 磁盘分区上用于 MongoDB 进程的可用和已用磁盘空间量

要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

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

partitionName
必需
字符串

测量所适用的磁盘或分区的用户可读标签。

processId
必需
字符串^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
示例： mongodb.example.com:27017

主机名和为 MongoDB 进程提供服务的互联网号码分配机构 (IANA) 端口的组合。主机必须是运行 MongoDB 进程 ( mongod 或 mongos ) 的主机的主机名、完全限定域名 (FQDN) 或 Internet 协议地址（IPv4 或 IPv6）。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。

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

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

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

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

m
数组 字符串 [1.. 10] 个列项 unique
列项枚举： "DISK_PARTITION_IOPS_READ" "MAX_DISK_PARTITION_IOPS_READ" "DISK_PARTITION_IOPS_WRITE" "MAX_DISK_PARTITION_IOPS_WRITE" "DISK_PARTITION_IOPS_TOTAL" "MAX_DISK_PARTITION_IOPS_TOTAL" "DISK_PARTITION_LATENCY_READ" “MAX_DISK_PARTITION_LATENCY_READ” "DISK_PARTITION_LATENCY_WRITE" "MAX_DISK_PARTITION_LATENCY_WRITE" "DISK_PARTITION_SPACE_FREE" "MAX_DISK_PARTITION_SPACE_FREE" "DISK_PARTITION_SPACE_USED" "MAX_DISK_PARTITION_SPACE_USED" "DISK_PARTITION_SPACE_PERCENT_FREE" "MAX_DISK_PARTITION_SPACE_PERCENT_FREE" "DISK_PARTITION_SPACE_PERCENT_USED" “MAX_DISK_PARTITION_SPACE_PERCENT_USED” "DISK_PARTITION_THROUGHPUT_READ" “DISK_PARTITION_THROUGHPUT_WRITE” "DISK_QUEUE_DEPTH"

为该 MongoDB 进程请求的一个或多个度量类型。如果省略，资源将返回所有度量值。如需为 m 指定多个值，请为每个值重复输入 m 参数。指定适用于指定主机的度量值。如果指定了任何无效的度量值，MongoDB Cloud 将返回错误信息。

period
字符串
示例： period=PT10H

Atlas 报告指标的持续时间。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。在未设置开始和结束时包含此参数。

粒度
必需
字符串
示例： granularity=PT1M

持续时间，用于指定 Atlas 报告指标的时间间隔。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。

开始
字符串 <date-time>

MongoDB Cloud 开始报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

end
字符串 <date-time>

MongoDB Cloud 停止报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

响应

响应样本

内容类型
application/json
{
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostId": "mongodb.example.com:27017",
  • "links": [],
  • "measurements": [
    ],
  • "partitionName": "string",
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

返回一个 MongoDB 进程的测量值

返回指定项目对应的指定主机的每个进程的磁盘、分区或主机的测量值。返回值可以是下列值之一：

  • 用于 MongoDB 进程的磁盘分区的 I/O 操作吞吐量
  • 向磁盘分区发出请求和由磁盘分区提出请求的时间百分比
  • 用于 MongoDB 进程的磁盘分区的每种操作类型的延迟
  • 磁盘分区上用于 MongoDB 进程的可用和已用磁盘空间量
  • 主机的测量值，例如 CPU 使用率或 I/O 操作次数

要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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}\:...
示例： mongodb.example.com:27017

主机名和为 MongoDB 进程提供服务的互联网号码分配机构 (IANA) 端口的组合。主机必须是运行 MongoDB 进程 ( mongod 或 mongos ) 的主机的主机名、完全限定域名 (FQDN) 或 Internet 协议地址（IPv4 或 IPv6）。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。

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

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

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

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

m
数组 字符串 [1.. 10] 个列项 unique
列项枚举： "ASSERT_MSG" "ASSERT_REGULAR" "ASSERT_USER" "ASSERT_WARNING" "BACKGROUND_FLUSH_AVG" "CACHE_BYTES_READ_INTO" "CACHE_BYTES_WRITTEN_FROM" "CACHE_DIRTY_BYTES" “CACHE_USED_BYTES” "CACHE_FILL_RATIO" "DIRTY_FILL_RATIO" "COMPUTED_MEMORY" “CONNECTIONS” "CURSORS_TOTAL_OPEN" "CURSORS_TOTAL_TIMED_OUT" "DB_DATA_SIZE_TOTAL" "DB_STORAGE_TOTAL" "DOCUMENT_METRICS_DELETED" "DOCUMENT_METRICS_INSERTED" "DOCUMENT_METRICS_RETURNED" "DOCUMENT_METRICS_UPDATED" "EXTRA_INFO_PAGE_FAULTS" "FTS_DISK_UTILIZATION" “FTS_MEMORY_MAPPED” “FTS_MEMORY_RESIDENT” "FTS_MEMORY_VIRTUAL" "FTS_PROCESS_CPU_KERNEL" "FTS_PROCESS_CPU_USER" "FTS_PROCESS_NORMALIZED_CPU_KERNEL" "FTS_PROCESS_NORMALIZED_CPU_USER" "GLOBAL_ACCESSES_NOT_IN_MEMORY" “GLOBAL_LOCK_CURRENT_QUEUE_READERS” "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" "INDEX_COUNTERS_BTREE_ACCESSES" "INDEX_COUNTERS_BTREE_HITS" "INDEX_COUNTERS_BTREE_MISS_RATIO" "INDEX_COUNTERS_BTREE_MISSES" "JOURNALING_COMMITS_IN_WRITE_LOCK" "JOURNALING_MB" "JOURNALING_WRITE_DATA_FILES_MB" "MAX_PROCESS_CPU_CHILDREN_KERNEL" "MAX_PROCESS_CPU_CHILDREN_USER" "MAX_PROCESS_CPU_KERNEL" "MAX_PROCESS_CPU_USER" "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL" "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER" "MAX_PROCESS_NORMALIZED_CPU_KERNEL" "MAX_PROCESS_NORMALIZED_CPU_USER" "MAX_SWAP_USAGE_FREE" "MAX_SWAP_USAGE_USED " “MAX_SYSTEM_CPU_GUEST” "MAX_SYSTEM_CPU_IOWAIT" "MAX_SYSTEM_CPU_IRQ" "MAX_SYSTEM_CPU_KERNEL" "MAX_SYSTEM_CPU_SOFTIRQ" "MAX_SYSTEM_CPU_STEAL" "MAX_SYSTEM_CPU_USER" "MAX_SYSTEM_MEMORY_AVAILABLE" "MAX_SYSTEM_MEMORY_FREE" “MAX_SYSTEM_MEMORY_USED” "MAX_SYSTEM_NETWORK_IN" "MAX_SYSTEM_NETWORK_OUT" "MAX_SYSTEM_NORMALIZED_CPU_GUEST" "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT" "MAX_SYSTEM_NORMALIZED_CPU_IRQ" "MAX_SYSTEM_NORMALIZED_CPU_KERNEL" "MAX_SYSTEM_NORMALIZED_CPU_NICE" "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ" "MAX_SYSTEM_NORMALIZED_CPU_STEAL" "MAX_SYSTEM_NORMALIZED_CPU_USER" "MEMORY_MAPPED" "MEMORY_RESIDENT" "MEMORY_VIRTUAL" "NETWORK_BYTES_IN" "NETWORK_BYTES_OUT" "NETWORK_NUM_REQUESTS" "OP_EXECUTION_TIME_COMMANDS" "OP_EXECUTION_TIME_READS" "OP_EXECUTION_TIME_WRITES" "OPCOUNTER_CMD" "OPCOUNTER_DELETE" "OPCOUNTER_TTL_DELETED" "OPCOUNTER_GETMORE" "OPCOUNTER_INSERT" "OPCOUNTER_QUERY" "OPCOUNTER_REPL_CMD" "OPCOUNTER_REPL_DELETE" "OPCOUNTER_REPL_INSERT" "OPCOUNTER_REPL_UPDATE" "OPCOUNTER_UPDATE" "OPERATIONS_SCAN_AND_ORDER" "OPERATIONS_QUERIES_KILLED" "OPLOG_MASTER_LAG_TIME_DIFF" "OPLOG_MASTER_TIME" "OPLOG_RATE_GB_PER_HOUR" "OPLOG_SLAVE_LAG_MASTER_TIME" "OPLOG_REPLICATION_LAG" "PROCESS_CPU_CHILDREN_KERNEL" "PROCESS_CPU_CHILDREN_USER" "PROCESS_CPU_KERNEL" "PROCESS_CPU_USER" "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL" "PROCESS_NORMALIZED_CPU_CHILDREN_USER" "PROCESS_NORMALIZED_CPU_KERNEL" "PROCESS_NORMALIZED_CPU_USER" "QUERY_EXECUTOR_SCANNED" "QUERY_EXECUTOR_SCANNED_OBJECTS" "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" “QUERY_TARGETING_SCANNED_PER_RETURNED” “RESTARTS_IN_LAST_HOUR” "SWAP_USAGE_FREE" "SWAP_USAGE_USED" "SYSTEM_CPU_GUEST" "SYSTEM_CPU_IOWAIT" "SYSTEM_CPU_IRQ" "SYSTEM_CPU_KERNEL" "SYSTEM_CPU_NICE" "SYSTEM_CPU_SOFTIRQ" "SYSTEM_CPU_STEAL" "SYSTEM_CPU_USER" "SYSTEM_MEMORY_AVAILABLE" "SYSTEM_MEMORY_FREE" "SYSTEM_MEMORY_USED" “SYSTEM_NETWORK_IN” "SYSTEM_NETWORK_OUT" "SYSTEM_NORMALIZED_CPU_GUEST" "SYSTEM_NORMALIZED_CPU_IOWAIT" "SYSTEM_NORMALIZED_CPU_IRQ" “SYSTEM_NORMALIZED_CPU_KERNEL” “SYSTEM_NORMALIZED_CPU_NICE” "SYSTEM_NORMALIZED_CPU_SOFTIRQ" “SYSTEM_NORMALIZED_CPU_STEAL” "SYSTEM_NORMALIZED_CPU_USER" "TICKETS_AVAILABLE_READS" "TICKETS_AVAILABLE_WRITE" "OPERATION_THROTTLING_REJECTED_OPERATIONS" "QUERY_SPILL_TO_DISK_DURING_SORT"

为该 MongoDB 进程请求的一个或多个度量类型。如果省略，资源将返回所有度量值。如需为 m 指定多个值，请为每个值重复输入 m 参数。指定适用于指定主机的度量值。如果指定了任何无效的度量值，MongoDB Cloud 将返回错误信息。

period
字符串
示例： period=PT10H

Atlas 报告指标的持续时间。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。在未设置开始和结束时包含此参数。

粒度
必需
字符串
示例： granularity=PT1M

持续时间，用于指定 Atlas 报告指标的时间间隔。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。

开始
字符串 <date-time>

MongoDB Cloud 开始报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

end
字符串 <date-time>

MongoDB Cloud 停止报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。

响应

响应样本

内容类型
application/json
{
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostId": "mongodb.example.com:27017",
  • "links": [],
  • "measurements": [
    ],
  • "partitionName": "string",
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

下载一个项目中一台集群主机的日志

返回压缩 (.gz)日志文件，其中包含指定项目的指定托管的范围日志消息。 MongoDB每五分钟更新一次集群后端基础架构的进程和Atlas 审核日志。日志以长度约为五分钟的数据段存储，但此持续时间可能会有所不同。如果您轮询API中的日志文件，我们建议每五分钟轮询一次，即使连续轮询可能包含一些重叠的日志。此功能不适用于 M0 免费集群、M2、M5、Flex 或无服务器集群。要使用此资源，请求的API密钥必须具有“项目数据访问只读”或更高角色。该API不支持使用 json 响应模式直接调用。您必须使用以下格式的接受标头来请求gzip 响应模式：“Accept: 应用程序/vnd.atlas.YYYY-MM-DD+gzip”。

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

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

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

主机名
必需
字符串^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:)...

用户可读的标签，用于标识存储要下载的日志文件的主机。

logName
必需
字符串
枚举： “mongodb” "mongos" "mongodb-audit-log" "mongos-audit-log"

用户可读的标签，用于标识要返回的日志文件。要返回审核日志，请为指定项目启用数据库审核。

设置数据库审核
查询参数
envelope
布尔
默认： false
示例： envelope=false

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

endDate
整型 <int64> >= 1199145600

指定要检索的日志消息范围终点的日期和时间，单位为自 UNIX 纪元起经过的秒数。此值将默认为开始日期后 24 小时。如果还未指定开始日期，则该值将默认为请求的时间。

startDate
整型 <int64> >= 1199145600

指定要检索的日志消息范围起点的日期和时间，单位为自 UNIX 纪元起经过的秒数。此值将默认为结束日期前 24 小时。如果还未指定结束日期，则该值将默认为请求的时间前 24 小时。

响应

响应样本

内容类型
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"
}

多云集群

返回、添加、编辑或删除多云集群。更改集群配置可能会影响成本。

跨地区集群的节点总数对每个项目有特定的限制。MongoDB Cloud 将一个项目中其他地区的节点总数限制为 40 个。此总数不包括相互通信的 Google Cloud Platform 地区、共享层级集群或无服务器集群。任意两个地区之间的节点总数必须满足此限制。例如，如果一个项目的集群中的节点分布在三个地区：地区 A 30 个节点、地区 B 10 个节点和地区 C 5 个节点，则你只能再向地区 C 添加 5 个节点，因为如果你排除 地区 C， ，地区 A + 地区 B = 40。 如果不包括地区 B、地区 A + 地区 C = 35，<= 40。 如果不包括地区 A、地区 B + 地区 C = 15，<= 40。 添加了 5 个节点的每个地区组合仍符合每个项目的约束条件。 地区 A + B = 40。 地区 A + C = 40。 地区 B + C = 20。 如果一个项目有一个或多个集群跨越其他地区的 40 个或更多节点，则无法在该项目中创建多区域集群。每个项目最多支持 25 个数据库部署。

如果您的 MongoDB Cloud 项目包含使用特定 MongoDB 版本中引入的操作的自定义角色，则必须先删除该角色，然后才能使用早期 MongoDB 版本创建集群。 2020 年 7 月之后创建的 MongoDB Cloud 集群默认使用 TLS 1.2 版本。 创建集群时，MongoDB Cloud 会在项目中为部署集群的云提供商创建一个网络容器（如果尚不存在）。

返回一个项目中的所有集群

返回您可以访问的特定项目中所有集群的详细信息。集群包含一组维护相同数据集的主机。响应包括多云集群。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。此功能不适用于无服务器集群。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

从一个项目创建一个集群

在指定项目中创建一个集群。集群包含一组维护相同数据集的主机。此资源可以创建多云集群。每个项目最多支持 25 个数据库部署。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。此功能不适用于无服务器集群。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

在特定项目中创建的集群。

acceptDataRisksAndForceReplicaSetReconfig
字符串 <date-time>

如果由于区域停电而需要重新配置以重新获得主节点，请与拓扑结构重新配置一起提交此字段，以请求新的区域抗停电拓扑。如果复制的写入操作（甚至多数提交的写入操作）尚未复制到新的主节点，则在大多数可选举节点中断期间强制重新配置会带来数据丢失的风险。MongoDB Atlas 文档包含更多信息。要继续执行存在该风险的操作，请将 acceptDataRisksAndForceReplicaSetReconfig 设置为当前日期。

在区域中断期间重新配置副本集
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 分片集群配置服务器
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"

管理客户密钥的云服务提供商，为集群提供额外的静态加密层。要为静态加密启用客户密钥管理，集群的 replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 设置必须为 M10 或更高，且 "backupEnabled" : false 或完全省略。

使用客户密钥管理进行静态加密
globalClusterSelfManagedSharding
布尔

设置该字段，用于在创建新的全球集群时配置分片管理模式。

当设置为 false 时，管理模式设置为 Atlas-托管分片。此模式可全面托管全球集群的分片，旨在提供无缝部署体验。

当设置为真时，管理模式设置为自我托管分片。此模式将分片的管理权交给您，旨在提供先进、灵活的部署体验。

一旦集群部署完毕，此设置就无法更改。

创建全球集群
数组 对象 （组件标签）
已弃用

长度在 1 到 255 个字符之间的键值对集合，用于标记和分类集群。MongoDB Cloud 控制台不显示您的标签。

集群标签已弃用，并将在未来版本中删除。我们强烈建议您改用资源标签。

mongoDBMajorVersion
字符串

集群的主要 MongoDB 版本。

创建时：从 MongoDB 的可用版本中进行选择，或者在 MongoDB Cloud 平台上，对当前建议的默认值保持不作指定。推荐的版本是最新的长期支持版本。在整个发布周期中，默认值并不保证是最新发布的版本。有关特定项目中可用的版本，请参阅链接的文档或使用项目 LTS 版本端点的 API 端点。

更新时：一次只能增加 1 个主要版本的版本。 如果将集群固定到比当前 MongoDB 版本低一个主要版本的 MongoDB 功能兼容版本，则 MongoDB 版本可以降级到上一个主要版本。

Atlas 中可用的 MongoDB 版本
名称
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

paused
布尔

指示集群是否已暂停的标志。

pitEnabled
布尔

指示集群是否使用连续云备份的标志。

持续的云备份
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/json

多云集群

{
  • "clusterType": "REPLICASET",
  • "links": [ ],
  • "name": "multiCloud",
  • "replicationSpecs": [
    ]
}

响应样本

内容类型
application/json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "backupEnabled": false,
  • "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": "string",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

从一个项目删除一个集群

从指定项目中删除一个集群。 必须禁用终止保护才能删除集群。 要使用此资源，请求的 API 密钥必须具有项目所有者角色。 此功能不适用于无服务器集群。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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 密钥必须具有“项目只读”角色。此功能不适用于无服务器集群。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "backupEnabled": false,
  • "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": "string",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

从一个项目修改一个集群

更新指定项目中一个集群的详细信息。集群包含一组维护相同数据集的主机。此资源可以更新多云集群。要更新集群的终止保护，请求的 API 密钥必须具有项目所有者角色。对于所有其他更新，请求的 API 密钥必须具有项目集群管理员角色。您无法修改已暂停的集群（paused : true）。您必须调用此端点来设置 paused : false。在此端点使用 paused : false 响应后，您可以再次调用它以对集群进行更改。此功能不适用于无服务器集群。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

指定项目中要更新的集群。

acceptDataRisksAndForceReplicaSetReconfig
字符串 <date-time>

如果由于区域停电而需要重新配置以重新获得主节点，请与拓扑结构重新配置一起提交此字段，以请求新的区域抗停电拓扑。如果复制的写入操作（甚至多数提交的写入操作）尚未复制到新的主节点，则在大多数可选举节点中断期间强制重新配置会带来数据丢失的风险。MongoDB Atlas 文档包含更多信息。要继续执行存在该风险的操作，请将 acceptDataRisksAndForceReplicaSetReconfig 设置为当前日期。

在区域中断期间重新配置副本集
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 分片集群配置服务器
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"

管理客户密钥的云服务提供商，为集群提供额外的静态加密层。要为静态加密启用客户密钥管理，集群的 replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 设置必须为 M10 或更高，且 "backupEnabled" : false 或完全省略。

使用客户密钥管理进行静态加密
globalClusterSelfManagedSharding
布尔

设置该字段，用于在创建新的全球集群时配置分片管理模式。

当设置为 false 时，管理模式设置为 Atlas-托管分片。此模式可全面托管全球集群的分片，旨在提供无缝部署体验。

当设置为真时，管理模式设置为自我托管分片。此模式将分片的管理权交给您，旨在提供先进、灵活的部署体验。

一旦集群部署完毕，此设置就无法更改。

创建全球集群
数组 对象 （组件标签）
已弃用

长度在 1 到 255 个字符之间的键值对集合，用于标记和分类集群。MongoDB Cloud 控制台不显示您的标签。

集群标签已弃用，并将在未来版本中删除。我们强烈建议您改用资源标签。

mongoDBMajorVersion
字符串

集群的主要 MongoDB 版本。

创建时：从 MongoDB 的可用版本中进行选择，或者在 MongoDB Cloud 平台上，对当前建议的默认值保持不作指定。推荐的版本是最新的长期支持版本。在整个发布周期中，默认值并不保证是最新发布的版本。有关特定项目中可用的版本，请参阅链接的文档或使用项目 LTS 版本端点的 API 端点。

更新时：一次只能增加 1 个主要版本的版本。 如果将集群固定到比当前 MongoDB 版本低一个主要版本的 MongoDB 功能兼容版本，则 MongoDB 版本可以降级到上一个主要版本。

Atlas 中可用的 MongoDB 版本
名称
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

paused
布尔

指示集群是否已暂停的标志。

pitEnabled
布尔

指示集群是否使用连续云备份的标志。

持续的云备份
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/json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "configServerManagementMode": "ATLAS_MANAGED",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "labels": [
    ],
  • "mongoDBMajorVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

响应样本

内容类型
application/json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "backupEnabled": false,
  • "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": "string",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicaSetScalingStrategy": "SEQUENTIAL",
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

测试一个集群的故障转移

为指定项目中的指定集群启动故障转移测试。集群包含一组维护相同数据集的主机。故障转移测试检查 MongoDB Cloud 如何处理集群主节点的故障。在测试过程中，MongoDB Cloud 关闭主节点并选举新的主节点。要使用此资源，请求的 API 密钥必须具有项目集群管理员角色。

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

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

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

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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"
}

网络对等

返回、添加、编辑和删除网络对等互联容器和对等互联连接。部署 M10+ 专用集群时，如果所选提供商和区域不存在 VPC 或 VPC 对等连接，Atlas 会为该提供商和区域创建 VPC。Atlas 为 VPC 分配无类别域间路由 (CIDR) 块。

在一个云提供商的一个项目中返回所有网络对等互连容器

返回指定云提供商的指定项目中所有网络对等互连容器的详细信息。如果不指定云提供商，则 MongoDB Cloud 将返回有关 Amazon Web Services (AWS) 项目中所有网络对等互连容器的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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 格式的标记。

提供商名称
必需
字符串
默认： "AWS"
枚举： "AWS" "AZURE" "GCP"

为所需的网络对等互连容器提供服务的云服务提供商。

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

创建一个新的网络对等容器

在指定的项目中创建一个新的网络对等互连容器。MongoDB Cloud 可以在网络对等互连容器中部署网络对等连接。GCP 上每个项目可以有一个容器。AWS 和 Azure 可以为每个云提供商区域提供一个容器。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

在指定的项目中创建一个新的网络对等互连容器。

提供商名称
字符串

为所需的网络对等互连容器提供服务的云服务提供商。

AtlasCidrBlock
字符串^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a...

以无类域间路由 (CIDR) 表示法表示的 IP 地址，MongoDB Cloud 在项目中将其用于网络对等互连容器。MongoDB Cloud 会为部署到该云提供商的所有项目集群分配此范围内的 IP 地址。如果此项目中存在 M10 或更大的集群或网络对等连接，MongoDB Cloud 会锁定此值。

这些 CIDR 区块必须在根据 RFC 1918 保留的范围内。AWS 和 Azure 进一步将区块限制在 /24 和 /21 范围之间。

要修改 CIDR 区块，目标项目不能具有：

  • 任何 M10 或更大的集群
  • 任何其他 VPC 对等连接

您还可以创建新项目并创建网络对等连接，以设置该项目所需的 MongoDB Cloud 网络对等互连容器 CIDR 区块。MongoDB Cloud 根据 CIDR 区块和为项目选择的地区，限制每个网络对等连接的 MongoDB 节点数量。

示例：Amazon Web Services (AWS) 区域中的一个项目支持三个可用区域和 MongoDB CIDR 网络对等互连容器区块，其限制为 /24 相当于 27 个三节点副本集。

regionName
必需
字符串
枚举： "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "CA_CENTRAL_1" "EU_NORTH_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_CENTRAL_1" "EU_CENTRAL_2" "SA_EAST_1" "AP_EAST_1" "AP_SOUTHEAST_2" "AP_SOUTHEAST_3" "AP_SOUTHEAST_4" "AP_NORTHEAST_1" "AP_NORTHEAST_2" "AP_NORTHEAST_3" "AP_SOUTHEAST_1" "AP_SOUTH_1" "AP_SOUTH_2" "CN_NORTH_1" "CN_NORTHWEST_1" "ME_CENTRAL_1" "ME_SOUTH_1" "AF_SOUTH_1" "EU_SOUTH_1" "EU_SOUTH_2" "IL_CENTRAL_1" "CA_WEST_1" "GLOBAL" "US_GOV_WEST_1" "US_GOV_EAST_1"

Amazon Web Services (AWS) 定义 MongoDB Cloud 部署此网络对等互连容器的地理区域。

响应

请求样本

内容类型
application/json
例子
{
  • "providerName": "AWS",
  • "atlasCidrBlock": "string",
  • "region": "US_CENTRAL",
  • "regionName": "US_EAST_1"
}

响应样本

内容类型
application/json
例子
{
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "provisioned": true,
  • "atlasCidrBlock": "string",
  • "azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
  • "region": "US_CENTRAL",
  • "vnetName": "stringstringstringstringstringstringst",
  • "regionName": "US_EAST_1",
  • "vpcId": "vpc-b555d3b0d9cb783b0"
}

返回一个项目中的所有网络对等互连容器

返回有关指定项目中所有网络对等互连容器的详细信息。网络对等互连容器包含网络对等连接。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

删除一个网络对等互连容器

删除指定项目中的一个网络对等互连容器。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

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

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

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

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

唯一的 24 位十六进制数字字符串，用于标识要删除的 MongoDB Cloud 网络容器。

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

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

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

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

响应

响应样本

内容类型
application/json
{ }

返回一个网络对等互连容器

返回有关指定项目中一个网络对等互连容器的详细信息。网络对等互连容器包含网络对等连接。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

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

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

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

containerId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

唯一的 24 位十六进制数字字符串，用于标识 MongoDB 云网络容器。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
例子
{
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "provisioned": true,
  • "atlasCidrBlock": "string",
  • "azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
  • "region": "US_CENTRAL",
  • "vnetName": "stringstringstringstringstringstringst",
  • "regionName": "US_EAST_1",
  • "vpcId": "vpc-b555d3b0d9cb783b0"
}

更新一个网络对等互连容器

更新指定项目中一个指定网络对等互连容器的网络详细信息和标签。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

containerId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

唯一的 24 位十六进制数字字符串，用于标识要删除的 MongoDB Cloud 网络容器。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

更新指定项目中一个指定网络对等互连容器的网络详细信息和标签。

提供商名称
字符串

为所需的网络对等互连容器提供服务的云服务提供商。

AtlasCidrBlock
字符串^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a...

以无类域间路由 (CIDR) 表示法表示的 IP 地址，MongoDB Cloud 在项目中将其用于网络对等互连容器。MongoDB Cloud 会为部署到该云提供商的所有项目集群分配此范围内的 IP 地址。如果此项目中存在 M10 或更大的集群或网络对等连接，MongoDB Cloud 会锁定此值。

这些 CIDR 区块必须在根据 RFC 1918 保留的范围内。AWS 和 Azure 进一步将区块限制在 /24 和 /21 范围之间。

要修改 CIDR 区块，目标项目不能具有：

  • 任何 M10 或更大的集群
  • 任何其他 VPC 对等连接

您还可以创建新项目并创建网络对等连接，以设置该项目所需的 MongoDB Cloud 网络对等互连容器 CIDR 区块。MongoDB Cloud 根据 CIDR 区块和为项目选择的地区，限制每个网络对等连接的 MongoDB 节点数量。

示例：Amazon Web Services (AWS) 区域中的一个项目支持三个可用区域和 MongoDB CIDR 网络对等互连容器区块，其限制为 /24 相当于 27 个三节点副本集。

regionName
必需
字符串
枚举： "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "CA_CENTRAL_1" "EU_NORTH_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_CENTRAL_1" "EU_CENTRAL_2" "SA_EAST_1" "AP_EAST_1" "AP_SOUTHEAST_2" "AP_SOUTHEAST_3" "AP_SOUTHEAST_4" "AP_NORTHEAST_1" "AP_NORTHEAST_2" "AP_NORTHEAST_3" "AP_SOUTHEAST_1" "AP_SOUTH_1" "AP_SOUTH_2" "CN_NORTH_1" "CN_NORTHWEST_1" "ME_CENTRAL_1" "ME_SOUTH_1" "AF_SOUTH_1" "EU_SOUTH_1" "EU_SOUTH_2" "IL_CENTRAL_1" "CA_WEST_1" "GLOBAL" "US_GOV_WEST_1" "US_GOV_EAST_1"

Amazon Web Services (AWS) 定义 MongoDB Cloud 部署此网络对等互连容器的地理区域。

响应

请求样本

内容类型
application/json
例子
{
  • "providerName": "AWS",
  • "atlasCidrBlock": "string",
  • "region": "US_CENTRAL",
  • "regionName": "US_EAST_1"
}

响应样本

内容类型
application/json
例子
{
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "provisioned": true,
  • "atlasCidrBlock": "string",
  • "azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
  • "region": "US_CENTRAL",
  • "vnetName": "stringstringstringstringstringstringst",
  • "regionName": "US_EAST_1",
  • "vpcId": "vpc-b555d3b0d9cb783b0"
}

返回一个项目中的所有网络对等连接

返回有关指定项目中所有网络对等连接的详细信息。网络对等互连允许多个云托管应用程序安全地连接到同一项目。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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 格式的标记。

提供商名称
字符串
默认： "AWS"
枚举： "AWS" "AZURE" "GCP"

用于此 VPC 对等连接的云服务提供商。

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

创建一个新的网络对等连接

在指定项目中创建一个新的网络对等连接。网络对等互连允许多个云托管应用程序安全地连接到同一项目。要使用此资源，请求的 API 密钥必须具有项目所有者角色。要了解有关注意事项和先决条件的详情，请参阅网络对等互连文档。

Azure 网络对等互连先决条件
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

创建一个网络对等连接。

accepterRegionName
必需
字符串

您与 MongoDB Cloud VPC 对等互连的“虚拟对等连接”(VPC) 所在的 Amazon Web Services (AWS) 区域。如果您的 VPC 和 MongoDB Cloud VPC 位于同一区域，则资源返回 null。

awsAccountId
必需
字符串 = 12 个字符 ^[0-9]{12}$

唯一的 12 位字符串，用于标识拥有与 MongoDB Cloud VPC 对等的 VPC 的 Amazon Web Services (AWS) 帐户。

containerId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识包含指定网络对等连接的 MongoDB Cloud 网络容器。

提供商名称
字符串

为所需的网络对等连接提供服务的云服务提供商。

routeTableCidrBlock
必需
字符串^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

以您想要与 MongoDB Cloud VPC 对等互连的 VPC 的子网的无类别域间路由 (CIDR) 表示法表示的互联网协议 (IP) 地址。

vpcId
必需
字符串 >= 5 个字符 ^vpc-[0-9a-f]{17}$

用于标识 Amazon Web Services (AWS) 上您想要与 MongoDB Cloud VPC 对等互连的 VPC 的唯一字符串。

响应

请求样本

内容类型
application/json
例子
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "vpcId": "string"
}

响应样本

内容类型
application/json
例子
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "connectionId": "string",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "errorStateName": "REJECTED",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "statusName": "INITIATING",
  • "vpcId": "string"
}

删除一个现有网络对等连接

在指定项目中删除一个网络对等连接。如果删除与项目关联的最后一个网络对等连接，MongoDB Cloud 还会从项目 IP 访问列表中删除所有 AWS 安全组。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

peerId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要删除的网络对等连接。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{ }

返回一个项目中的一个网络对等连接

返回指定项目中一个指定网络对等连接的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

peerId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要检索的网络对等连接。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
例子
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "connectionId": "string",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "errorStateName": "REJECTED",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "statusName": "INITIATING",
  • "vpcId": "string"
}

更新一个新的网络对等连接

更新指定项目中的一个指定网络对等连接。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

peerId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要更新的网络对等连接。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

修改一个网络对等连接。

accepterRegionName
必需
字符串

您与 MongoDB Cloud VPC 对等互连的“虚拟对等连接”(VPC) 所在的 Amazon Web Services (AWS) 区域。如果您的 VPC 和 MongoDB Cloud VPC 位于同一区域，则资源返回 null。

awsAccountId
必需
字符串 = 12 个字符 ^[0-9]{12}$

唯一的 12 位字符串，用于标识拥有与 MongoDB Cloud VPC 对等的 VPC 的 Amazon Web Services (AWS) 帐户。

containerId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识包含指定网络对等连接的 MongoDB Cloud 网络容器。

提供商名称
字符串

为所需的网络对等连接提供服务的云服务提供商。

routeTableCidrBlock
必需
字符串^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

以您想要与 MongoDB Cloud VPC 对等互连的 VPC 的子网的无类别域间路由 (CIDR) 表示法表示的互联网协议 (IP) 地址。

vpcId
必需
字符串 >= 5 个字符 ^vpc-[0-9a-f]{17}$

用于标识 Amazon Web Services (AWS) 上您想要与 MongoDB Cloud VPC 对等互连的 VPC 的唯一字符串。

响应

请求样本

内容类型
application/json
例子
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "vpcId": "string"
}

响应样本

内容类型
application/json
例子
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "connectionId": "string",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "errorStateName": "REJECTED",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "statusName": "INITIATING",
  • "vpcId": "string"
}

为一个项目验证仅通过对等互连连接已弃用

验证是否有人将指定项目设置为仅通过对等互连连接模式。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

对连接字符串的更改
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "enabled": true
}

为一个项目禁用仅通过对等互连模式连接已弃用

为指定项目禁用“仅通过对等互连连接”模式。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

对连接字符串的更改
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

为指定项目禁用“仅通过对等互连连接”模式。

enabled
必需
布尔

指示某人是否已为指定项目启用仅通过对等互连模式连接的标志。

响应

请求样本

内容类型
application/json
{
  • "enabled": true
}

响应样本

内容类型
application/json
{
  • "enabled": true
}

Online Archive

返回、添加、编辑或删除在线存档。

返回一个集群的所有在线归档

返回所有在线归档的详细信息。此归档将来自一个集群的数据存储在一个项目中。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

Online Archive
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

创建一个在线存档

创建一个在线归档。此归档将来自一个集群的数据存储在一个项目中。要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。

Online Archive
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

创建一个在线归档。

collName
必需
字符串

用户可读标签，用于标识您为其创建在线存档的集合。

collectionType
字符串
默认： “标准”
枚举： "TIMESERIES" “标准”

要返回的 MongoDB 数据库集合的分类。

如果将该参数设置为 TIMESERIES，则设置 "criteria.type" : "date" 和 "criteria.dateFormat" : "ISODATE"。

必需
对象 （CriteriaView）

MongoDB Cloud 存档数据的规则。

使用 criteria.type 字段选择 MongoDB Cloud 选择存档数据的方式。使用数据年龄或 MongoDB 查询选择数据。"criteria.type": "DATE"根据日期选择要存档的文档。"criteria.type": "CUSTOM"根据自定义 JSON 查询选择要存档的文档。当"collectionType": "TIMESERIES"时，MongoDB Cloud 不支持"criteria.type": "CUSTOM"。

对象 (DataExpirationRuleView)

用于指定何时从存档中删除数据的规则。

对象 （CreateDataProcessRegionView）

用于配置要存储存档数据的区域的设置。

dbName
必需
字符串

包含在线存档的集合的数据库的可读标签。

数组 对象 （在线存档分区） non-empty

包含用于在集合中以逻辑方式划分数据的文档参数的列表。分区提供对基础集合数据的粗略过滤。若要划分数据，请指定经常查询的参数。如果您“指定 :criteria.type”：在 CREATE ONE ONLINE ARCHIVE 端点中输入“DATE”，然后您可以指定最多三个用于查询的参数。其中一个参数必须是 DATE 值，这是本例中是必需值。如果您“指定 :criteria.type”：在 CREATE ONE ONLINE ARCHIVE 端点中输入“CUSTOM”，然后您可以指定最多两个用于查询的参数。不使用“:criteria.type”的查询：“DATE”或“:criteria.type”：“CUSTOM”参数会使 MongoDB 扫描所有存档文档的完整集合。这需要更多时间，同时增加了您的成本。

paused
布尔

标志，表示该在线存档是否处于暂停状态。如果该集合有另一个活动的在线存档，则恢复请求将失败。如需暂停活动在线存档或恢复已暂停的在线存档，必须包含此参数。如需暂停活动存档，请将此设置为 true。如需恢复暂停的存档，请将此设置为 false。

对象 （在线存档计划）

存档过程发生的常规频率和持续时间。

响应

请求样本

内容类型
application/json
{
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dbName": "string",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    }
}

响应样本

内容类型
application/json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dataSetName": "string",
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    },
  • "state": "PENDING"
}

下载在线存档查询日志

下载量指定在线存档的查询日志。 要使用此资源，请求的API密钥必须具有“项目数据访问只读”或更高角色。 该API不支持使用JSON响应模式直接调用。 您必须使用以下格式的接受标头来请求gzip 响应模式：“Accept: 应用程序/gzip”。

Online Archive
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读的标签，用于标识包含您要从一个在线存档返回其查询日志的集合的集群。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

startDate
整型 <int64> >= 1199145600
示例： startDate=1636481348

指定要返回的日志消息范围起始点的日期和时间。该资源以自 UNIX 纪元以来经过的秒数来表示该值。

endDate
整型 <int64> >= 1199145600
示例： endDate=1636481348

指定要返回的日志消息范围结束点的日期和时间。该资源以自 UNIX 纪元以来经过的秒数来表示该值。

archiveOnly
布尔
默认： false

标志，用于表示仅下载在线存档的查询日志，还是同时下载在线存档和集群的查询日志。

响应

响应样本

内容类型
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 密钥必须具有项目数据访问管理员角色。

Online Archive
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

archiveId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要删除的在线存档。

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{ }

返回一个在线存档

返回一个群集的一个在线存档。此归档将来自一个集群的数据存储在一个项目中。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

Online Archive
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

archiveId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要返回的在线存档。

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dataSetName": "string",
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    },
  • "state": "PENDING"
}

更新一个在线存档

更新、暂停或恢复一个在线归档。此存档将来自一个集群的数据存储在一个项目中。要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。

Online Archive
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

archiveId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字串，用于标识要更新的在线归档。

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

更新、暂停或恢复一个在线存档。

对象 （CriteriaView）

MongoDB Cloud 存档数据的规则。

使用 criteria.type 字段选择 MongoDB Cloud 选择存档数据的方式。使用数据年龄或 MongoDB 查询选择数据。"criteria.type": "DATE"根据日期选择要存档的文档。"criteria.type": "CUSTOM"根据自定义 JSON 查询选择要存档的文档。当"collectionType": "TIMESERIES"时，MongoDB Cloud 不支持"criteria.type": "CUSTOM"。

对象 (DataExpirationRuleView)

用于指定何时从存档中删除数据的规则。

paused
布尔

标志，表示该在线存档是否处于暂停状态。如果该集合有另一个活动的在线存档，则恢复请求将失败。如需暂停活动在线存档或恢复已暂停的在线存档，必须包含此参数。如需暂停活动存档，请将此设置为 true。如需恢复暂停的存档，请将此设置为 false。

对象 （在线存档计划）

存档过程发生的常规频率和持续时间。

响应

请求样本

内容类型
application/json
{
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "paused": true,
  • "schedule": {
    }
}

响应样本

内容类型
application/json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dataSetName": "string",
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    },
  • "state": "PENDING"
}

组织

在 MongoDB Cloud 中返回、添加和编辑组织单位。

返回所有组织

返回请求的 API 密钥有权访问的所有组织。要使用此资源，请求的 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/json
{}

创建一个组织

在 MongoDB Cloud 中创建一个组织并将其链接到请求的 API 密钥所属的组织。要使用此资源，请求的 API 密钥必须具有“组织所有者”角色。请求的 API 密钥所属的组织必须是付费组织。要了解更多信息，请参阅 MongoDB Atlas 文档中的配置付费组织。

授权：
DigestAuth服务账户
查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

要创建的组织。

对象 (CreateAtlasOrganizationApiKey)

要创建的编程 API 密钥的详细信息。

federationSettingsId
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识将新创建的组织链接到的联合。如果指定，新组织的建议组织所有者必须在与联合关联的组织中具有组织所有者角色。

名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

用于标识组织的人类可读标签。

orgOwnerId
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要分配“组织所有者”角色的 MongoDB Cloud 用户。该用户必须与调用的 API 密钥属于同一组织。如果提供 federationSettingsId，则该用户必须在指定联盟的组织中拥有“组织所有者”角色。只有使用程序化 API 密钥进行身份验证时才需要此参数。

skipDefaultAlertsSettings
布尔
默认： false

禁用自动创建警报。设立为 true 时，不会自动创建组织级别的警报。

响应

请求样本

内容类型
application/json
{
  • "apiKey": {
    },
  • "federationSettingsId": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "orgOwnerId": "32b6e34b3d91647abb20e7b8",
  • "skipDefaultAlertsSettings": false
}

响应样本

内容类型
application/json
{
  • "apiKey": {
    },
  • "federationSettingsId": "32b6e34b3d91647abb20e7b8",
  • "orgOwnerId": "32b6e34b3d91647abb20e7b8",
  • "organization": {
    },
  • "skipDefaultAlertsSettings": false
}

删除一个组织

删除一个指定机构。MongoDB Cloud 对该资源施加了以下限制：

  • 无法删除具有活动项目的组织。
  • 在删除组织之前，必须先删除该组织中的所有项目。要使用此资源，请求的 API 密钥必须具有“组织所有者”角色。
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

响应

响应样本

内容类型
application/json
{ }

返回一个组织

返回请求 API 密钥具有访问权限的一个组织。要使用此资源，请求的 API 密钥必须具有“组织成员”角色。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{
  • "id": "32b6e34b3d91647abb20e7b8",
  • "isDeleted": true,
  • "links": [],
  • "name": "string",
  • "skipDefaultAlertsSettings": false
}

更新一个组织

更新一个组织。要使用此资源，请求的API密钥必须具有“组织所有者”角色。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

要更新的有关指定组织的详细信息。

名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

用于标识组织的人类可读标签。

skipDefaultAlertsSettings
布尔
默认： false

禁用自动创建警报。设立为 true 时，不会自动创建组织级别的警报。

响应

请求样本

内容类型
application/json
{
  • "name": "string",
  • "skipDefaultAlertsSettings": false
}

响应样本

内容类型
application/json
{
  • "id": "32b6e34b3d91647abb20e7b8",
  • "isDeleted": true,
  • "links": [],
  • "name": "string",
  • "skipDefaultAlertsSettings": false
}

返回一个组织中的一个或多个项目

返回指定组织中的多个项目。每个组织可以有多个项目。使用项目来：

  • 将不同环境（如开发环境、测试环境或生产环境）相互隔离。
  • 将不同的 MongoDB Cloud 用户或团队与不同的环境关联，或者为不同环境中的 MongoDB Cloud 用户授予不同权限。
  • 维护单独的集群安全配置。
  • 创建不同的警报设置。

要使用此资源，请求的 API 密钥必须具有“组织成员”角色。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

返回所有组织邀请

返回指定组织的所有待处理邀请。要使用此资源，请求的 API 密钥必须具有“组织所有者”角色。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

用户名
字符串 <email>

受邀加入本组织的用户帐号的电子邮件地址。如果排除此参数，该资源将返回所有待发邀请。

响应

响应样本

内容类型
application/json
[
  • {
    }
]

更新一份组织邀请

更新对指定组织的一个待处理邀请的详细信息。如要指定邀请，请提供受邀用户的用户名。要使用此资源，请求的 API 密钥必须具有组织所有者角色。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

更新对指定组织的一个待处理邀请的详细信息。

数组 对象 (OrganizationInvitationGroupRoleAssignmentsRequest)

用户接受组织邀请后将加入的项目列表。

角色
数组 字符串 unique
列项枚举： “ORG_OWNER” "ORG_MEMBER" “ORG_GROUP_CREATOR” "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

要分配给该 MongoDB Cloud 用户的一个或多个组织级别角色。

teamIds
数组 字符串 unique [ 列项 = 24 个字符 ^([a-f0-9]{24})$ ]

您想要邀请所需 MongoDB Cloud 用户加入的团队列表。

用户名
字符串 <email>

所需 MongoDB Cloud 用户的电子邮件地址。

响应

请求样本

内容类型
application/json
{
  • "groupRoleAssignments": [
    ],
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

响应样本

内容类型
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

邀请一个 MongoDB 云用户加入一个 Atlas 组织

邀请一个 MongoDB Cloud 用户加入指定组织。用户必须接受邀请才能访问指定组织内的信息。要使用此资源，请求的 API 密钥必须具有组织所有者角色。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

邀请一个 MongoDB Cloud 用户加入指定组织。

数组 对象 (OrganizationInvitationGroupRoleAssignmentsRequest)

用户接受组织邀请后将加入的项目列表。

角色
数组 字符串 unique
列项枚举： “ORG_OWNER” "ORG_MEMBER" “ORG_GROUP_CREATOR” "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

要分配给该 MongoDB Cloud 用户的一个或多个组织级别角色。

teamIds
数组 字符串 unique [ 列项 = 24 个字符 ^([a-f0-9]{24})$ ]

您想要邀请所需 MongoDB Cloud 用户加入的团队列表。

用户名
字符串 <email>

所需 MongoDB Cloud 用户的电子邮件地址。

响应

请求样本

内容类型
application/json
{
  • "groupRoleAssignments": [
    ],
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

响应样本

内容类型
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

取消一份组织邀请

取消发送给指定 MongoDB Cloud 用户的一项待处理邀请以加入组织。您无法取消用户已接受的邀请。要使用此资源，请求的 API 密钥必须具有组织所有者角色。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

invitationId
必需
字符串

标识该邀请的唯一 24 位十六进制数字字符串。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{ }

返回所有组织邀请

返回指定组织的一个待处理邀请的详细信息。要使用此资源，请求的 API 密钥必须具有组织所有者角色。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

invitationId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

标识该邀请的唯一 24 位十六进制数字字符串。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

响应

响应样本

内容类型
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

按邀请 ID 更新一个组织邀请

更新对指定组织的一个待处理邀请的详细信息。若要指定哪个邀请，请提供该邀请的唯一标识字符串。使用“返回所有组织邀请”端点检索所有待处理组织邀请的 ID。要使用此资源，请求的 API 密钥必须具有组织所有者角色。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

invitationId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

标识该邀请的唯一 24 位十六进制数字字符串。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

更新对指定组织的一个待处理邀请的详细信息。

数组 对象 (OrganizationInvitationGroupRoleAssignmentsRequest)

用户接受组织邀请后将加入的项目列表。

角色
数组 字符串 unique
列项枚举： “ORG_OWNER” "ORG_MEMBER" “ORG_GROUP_CREATOR” "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

要分配给该 MongoDB Cloud 用户的一个或多个组织级别角色。

teamIds
数组 字符串 unique [ 列项 = 24 个字符 ^([a-f0-9]{24})$ ]

您想要邀请所需 MongoDB Cloud 用户加入的团队列表。

响应

请求样本

内容类型
application/json
{
  • "groupRoleAssignments": [
    ],
  • "roles": [
    ],
  • "teamIds": [
    ]
}

响应样本

内容类型
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

返回一个组织的设置

返回有关指定组织设置的详细信息。要使用此资源，请求的 API 密钥必须具有组织所有者角色。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{
  • "apiAccessListRequired": true,
  • "genAIFeaturesEnabled": true,
  • "maxServiceAccountSecretValidityInHours": 8,
  • "multiFactorAuthRequired": true,
  • "restrictEmployeeAccess": true,
  • "securityContact": "string"
}

更新一个组织的设置

更新组织设置。要使用此资源，请求的 API 密钥必须具有组织所有者角色。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

要更新指定组织设置的详细信息。

apiAccessListRequired
布尔

指示是否要求 API 操作源自添加到指定组织的 API 访问列表中的 IP 地址的标志。

genAIFeaturesEnabled
布尔
默认： true

指示该组织是否有权访问权限生成AI功能的标志。 此设置仅适用于Atlas商业版，并且默认处于启用状态。 开启此设置后，项目所有者也许能够在项目级别启用或禁用单个AI功能。

生成式 AI 常见问题解答
maxServiceAccountSecretValidityInHours
整型 <int32> [ 8 .. 8760 ]

一个数字，表示指定组织内新的Atlas Admin API服务帐户密钥在过期之前的最长时间（以小时为单位）。

multiFactorAuthRequired
布尔

指示是否要求用户在访问指定组织之前设置多重身份验证 (MFA)的标记。如需了解更多信息，请访问：https://www.mongodb.com/zh-cn/docs/atlas/security-multi-factor-authentication/。

restrictEmployeeAccess
布尔

该标志指示是否阻止 MongoDB 支持团队在未获得明确许可的情况下访问指定组织中任何部署的 Atlas 基础架构和集群日志。启用此设置后，您可以授予 MongoDB 支持团队 24 小时绕过访问 Atlas 部署的权限，以解决支持问题。如需了解更多信息，请访问：https://www.mongodb.com/zh-cn/docs/atlas/security-restrict-support-access/。

securityContact
字符串

string字符串，为指定组织指定单个电子邮件解决，用于接收安全相关通知。指定安全联系并不授予他们授权或访问权限Atlas以进行安全决策或批准。 string空字符串有效，会清除现有安全联系（如有）。

响应

请求样本

内容类型
application/json
{
  • "apiAccessListRequired": true,
  • "genAIFeaturesEnabled": true,
  • "maxServiceAccountSecretValidityInHours": 8,
  • "multiFactorAuthRequired": true,
  • "restrictEmployeeAccess": true,
  • "securityContact": "string"
}

响应样本

内容类型
application/json
{
  • "apiAccessListRequired": true,
  • "genAIFeaturesEnabled": true,
  • "maxServiceAccountSecretValidityInHours": 8,
  • "multiFactorAuthRequired": true,
  • "restrictEmployeeAccess": true,
  • "securityContact": "string"
}

返回一个组织中的所有 MongoDB Cloud 用户

返回与指定组织关联的 MongoDB Cloud 用户的详细信息。返回的每个 MongoDB Cloud 用户必须属于指定组织或指定组织内的项目。要使用此资源，请求的 API 密钥必须具有“组织成员”角色。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

从一个组织中删除一个 MongoDB Cloud 用户

从指定组织中删除一名 MongoDB Cloud 用户。要使用此资源，请求的 API 密钥必须具有“组织用户管理员”角色。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

用户 ID
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要删除的用户。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{ }

性能顾问

返回数据库部署的建议索引和慢速查询数据。还可启用或禁用 MongoDB 云托管的慢速操作阈值。要查看示例查询中的字段值，必须具有项目数据访问只读角色或更高角色。否则，MongoDB Cloud 将返回已编辑的数据而不是字段值。

禁用托管慢速操作阈值

禁用 MongoDB Cloud 为指定项目计算的慢操作阈值。该阈值确定性能优化顾问和查询分析器认为哪些操作速度较慢。启用后，MongoDB Cloud 会使用集群上操作的平均执行时间来确定运行缓慢的查询。因此，该阈值与您的集群工作负载更为相关。默认情况下，专用集群 (M10+) 的慢操作阈值处于启用状态。禁用后，MongoDB Cloud 会将任何耗时超过 100 毫秒的操作视为缓慢。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/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 对指定项目使用其慢操作阈值。该阈值确定性能优化顾问和查询分析器认为哪些操作速度较慢。启用后，MongoDB Cloud 会使用集群上操作的平均执行时间来确定运行缓慢的查询。因此，该阈值与您的集群工作负载更为相关。默认情况下，专用集群 (M10+) 的慢操作阈值处于启用状态。禁用后，MongoDB Cloud 会将任何耗时超过 100 毫秒的操作视为缓慢。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/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"
}

返回一个主机的所有命名空间

对于在指定主机上查询速度较慢的集合，最多返回 20 个命名空间。如果您指定未收到任何数据库读取操作的副本集的从节点，则端点不会返回任何命名空间。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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}\:...

为 MongoDB 进程提供服务的主机和端口的组合。主机必须是运行 MongoDB 进程（mongod 或 mongos）的主机的主机名、FQDN、IPv4 地址或 IPv6 地址。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

duration
整型 <int64>

查询在集群的托管命名空间中查找建议索引的时间长度。此参数以毫秒为单位。

  • 如果不指定 since 参数，则端点将返回涵盖当前时间之前持续时间的数据。
  • 如果您既不指定 duration 也不指定 since 参数，该端点将返回过去 24 小时的数据。
since
整型 <int64> >= 1199145600000

查询检索建议索引的日期和时间。该参数以自 UNIX 纪元以来经过的毫秒数表示其值。

  • 如果不指定持续时间参数，端点将返回从 since 值到当前时间的数据。
  • 如果您既不指定 duration 也不指定 since 参数，该端点将返回过去 24 小时的数据。

响应

响应样本

内容类型
application/json
{
  • "namespaces": [
    ]
}

返回慢查询

返回 Performance Advisor 和查询分析器识别的慢速查询的日志行。 性能优化顾问会监控 MongoDB 认为其速度缓慢的查询，并建议使用新索引来提高查询性能。MongoDB Cloud 根据集群上的平均操作时间确定慢速查询的阈值。 这将启用与工作负载相关的建议。 要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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}\:...

为 MongoDB 进程提供服务的主机和端口的组合。主机必须是运行 MongoDB 进程（mongod 或 mongos）的主机的主机名、FQDN、IPv4 地址或 IPv6 地址。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

duration
整型 <int64>

查询在集群的托管命名空间中查找慢查询的时间长度。此参数以毫秒为单位。

  • 如果不指定 since 参数，则端点将返回涵盖当前时间之前持续时间的数据。
  • 如果您既不指定 duration 也不指定 since 参数，该端点将返回过去 24 小时的数据。
namespaces
数组 字符串

要从中检索慢速查询的命名空间。命名空间由一个数据库和一个集合资源组成，写作 .: <database>.<collection>。要包含多个命名空间，请多次传递该参数，并在每个命名空间之间用与号 (&) 分隔。省略此参数可返回所有命名空间的结果。

nLogs
整型 <int64> [ 0 .. 20000 ]
默认： 20000

日志中要返回的最大行数。

since
整型 <int64> >= 1199145600000

查询检索慢查询开始的日期和时间。该参数以自 UNIX 纪元以来经过的毫秒数表示其值。

  • 如果不指定持续时间参数，端点将返回从 since 值到当前时间的数据。
  • 如果您既不指定 duration 也不指定 since 参数，该端点将返回过去 24 小时的数据。

响应

响应样本

内容类型
application/json
{
  • "slowQueries": [
    ]
}

返回建议的索引

返回性能优化顾问建议的索引。性能优化顾问会监控 MongoDB 认为其速度缓慢的查询，并建议使用新索引来提高查询性能。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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}\:...

为 MongoDB 进程提供服务的主机和端口的组合。主机必须是运行 MongoDB 进程（mongod 或 mongos）的主机的主机名、FQDN、IPv4 地址或 IPv6 地址。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。

查询参数
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 格式的标记。

duration
整型 <int64>

查询在集群的托管命名空间中查找建议索引的时间长度。此参数以毫秒为单位。

  • 如果不指定 since 参数，则端点将返回涵盖当前时间之前持续时间的数据。
  • 如果您既不指定 duration 也不指定 since 参数，该端点将返回过去 24 小时的数据。
namespaces
数组 字符串

从中检索建议索引的命名空间。命名空间由一个数据库和一个集合资源组成，写作 .: <database>.<collection>。要包含多个命名空间，请多次传递该参数，并在每个命名空间之间用与号 (&) 分隔。省略此参数可返回所有命名空间的结果。

nExamples
整型 <int64>
默认： 5

从建议的索引中受益的示例查询的最大数量。

nIndexes
整型 <int64>

指示要建议的最大索引的数字。

since
整型 <int64> >= 1199145600000

查询检索建议索引的日期和时间。该参数以自 UNIX 纪元以来经过的毫秒数表示其值。

  • 如果不指定持续时间参数，端点将返回从 since 值到当前时间的数据。
  • 如果您既不指定 duration 也不指定 since 参数，该端点将返回过去 24 小时的数据。

响应

响应样本

内容类型
application/json
{
  • "shapes": [
    ],
  • "suggestedIndexes": [
    ]
}

私有端点服务

返回、添加、编辑和删除私有端点服务。

为一个提供商创建一个私有端点服务

为指定的云服务提供商创建一个私有端点服务。该云服务提供商负责管理项目的私有端点服务。当您创建私有端点服务时，MongoDB Cloud 会在项目中为您为其创建私有端点服务的云提供商创建一个网络容器（如果尚不存在）。要详细了解 MongoDB Cloud 中的私有端点术语，请参阅“私有端点概念”。要使用该资源，请求的 API 密钥必须具有项目所有者角色。

私有端点概念
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

为指定的云服务提供商创建一个私有端点。

提供商名称
必需
字符串
枚举： "AWS" "AZURE" "GCP"

人类可读标签，用于标识您要为其创建私有端点服务的云服务提供商。

区域
必需
字符串

您要在其中创建私有端点服务的云提供商区域。Amazon Web Services、Google Cloud Platform 和 Microsoft Azure 接受的区域值各不相同。

响应

请求样本

内容类型
application/json
{
  • "providerName": "AWS",
  • "region": "string"
}

响应样本

内容类型
application/json
例子
{
  • "cloudProvider": "AWS",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "interfaceEndpoints": [
    ],
  • "regionName": "string",
  • "status": "INITIATING"
}

返回区域化私有端点状态

检查指定云服务提供商中的每个区域是否可以创建多个私有端点。云服务提供商负责管理项目的私有端点。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "enabled": true
}

切换区域化私有端点状态

启用或禁用在一个项目的所有云服务提供商的每个区域创建多个私有端点的功能。云服务提供商负责管理项目的私有端点。启用此设置后，现有多区域和全局分片集群的连接字符串会发生变化。必须更新应用程序才能使用新的连接字符串。这可能会导致停机。要使用此资源，请求的 API 密钥必须具有项目所有者角色，并且部署中的所有集群都必须是分片集群。启用后，您将无法创建副本集。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

启用或禁用在一个项目的所有云服务提供商的每个区域创建多个私有端点的功能。

enabled
必需
布尔

指示某人是否为指定项目启用区域化私有端点设置的标志。

  • 将此值设置为 true 以启用区域化私有端点。这样就可以在一个云提供商区域内创建多个私有端点。您需要启用此设置才能连接到多区域和全球 MongoDB Cloud 分片集群。启用区域化私有端点会带来以下限制：

    • 您的应用程序必须对现有的多区域和全局分片集群使用新的连接字符串。这可能会导致停机。

    • 您的 MongoDB Cloud 项目不能包含副本集，您也不能在此项目中创建新的副本集。

    • 如果存在以下情况，则无法禁用此设置：

      • 在多个区域内有多个私有端点
      • 一个地区中的多个私有端点，以及一个或多个地区中的一个私有端点。

  • 将此值设置为 false 以禁用区域化私有端点。

响应

请求样本

内容类型
application/json
{
  • "enabled": true
}

响应样本

内容类型
application/json
{
  • "enabled": true
}

返回一个提供者的所有私有端点服务

返回指定云服务提供商的所有私有端点服务的名称、接口和状态。该云服务提供商负责管理项目的私有端点服务。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

云服务提供商
必需
字符串
默认： "AWS"
枚举： "AWS" "AZURE" "GCP"

管理此私有端点服务的云服务提供商。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
[
  • {
    }
]

为一个提供商返回一个私有端点服务

从指定项目中删除一个私有端点服务。此云服务提供商托管属于此项目的私有端点服务。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

云服务提供商
必需
字符串
默认： "AWS"
枚举： "AWS" "AZURE" "GCP"

管理此私有端点服务的云服务提供商。

endpointServiceId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要删除的私有端点服务。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{ }

返回一个提供者的一个私有端点服务

返回一个项目中指定的私有端点服务的名称、接口和状态。该云服务提供商托管属于项目的私有端点服务。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

云服务提供商
必需
字符串
默认： "AWS"
枚举： "AWS" "AZURE" "GCP"

管理此私有端点服务的云服务提供商。

endpointServiceId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要返回的私有端点服务。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
例子
{
  • "cloudProvider": "AWS",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "interfaceEndpoints": [
    ],
  • "regionName": "string",
  • "status": "INITIATING"
}

为一个提供商删除一个私有端点

为指定的云服务提供商创建一项私有端点服务。该云服务提供商管理私有端点服务，而私有端点服务又管理项目的私有端点。 要使用此资源，请求的 API 密钥必须具有项目所有者角色。要了解有关注意事项、限制和先决条件的更多信息，请参阅有关设置专用端点的 MongoDB 文档。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

云服务提供商
必需
字符串
默认： "AWS"
枚举： "AWS" "AZURE" "GCP"

管理此私有端点的云服务提供商。

endpointServiceId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字串，用于标识您想要创建的私有端点对应的私有端点服务。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

为指定的云服务提供商创建一个私有端点。

以下其中之一
对象 AWS 递归

响应

请求样本

内容类型
application/json
例子
{
  • "id": "vpce-3bf78b0ddee411ba1"
}

响应样本

内容类型
application/json
例子
{
  • "cloudProvider": "AWS",
  • "connectionStatus": "PENDING_ACCEPTANCE",
  • "deleteRequested": true,
  • "errorMessage": "string",
  • "interfaceEndpointId": "32b6e34b3d91647abb20e7b8"
}

为一个提供商删除一个私有端点

从由指定云服务提供商托管的指定项目和私有端点服务中删除一个私有端点。当从给定的私有端点服务中删除最后一个私有端点时，该私有端点服务也会被删除。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

云服务提供商
必需
字符串
默认： "AWS"
枚举： "AWS" "AZURE" "GCP"

管理此私有端点的云服务提供商。

endpointId
必需
字符串^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF]...

唯一字符串，用于标识要删除的私有端点。对于 AWS 和 Azure，endpointId 参数的格式有所不同。您必须对 Azure 私有端点的 endpointId 进行 URL 编码。

endpointServiceId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字串，用于标识要从中删除一个私有端点的私有端点服务。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{ }

为一个提供商返回一个私有端点

返回指定私有端点的连接状态。私有端点服务管理着属于由一个云服务提供商托管的某个项目的私有端点。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

云服务提供商
必需
字符串
默认： "AWS"
枚举： "AWS" "AZURE" "GCP"

管理此私有端点的云服务提供商。

endpointId
必需
字符串^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF]...

用于标识要返回的私有端点的唯一字符串。对于 AWS 和 Azure，endpointId 参数的格式有所不同。您必须对 Azure 私有端点的 endpointId 进行 URL 编码。

endpointServiceId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字串，用于标识要为其返回私有端点的私有端点服务。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
例子
{
  • "cloudProvider": "AWS",
  • "connectionStatus": "PENDING_ACCEPTANCE",
  • "deleteRequested": true,
  • "errorMessage": "string",
  • "interfaceEndpointId": "32b6e34b3d91647abb20e7b8"
}

编程 API 密钥。

返回、添加、编辑和删除访问令牌以使用 MongoDB Cloud API。MongoDB Cloud 将这些密钥应用于组织。这些资源可以在指定项目内返回、分配这些密钥，或撤销这些密钥的使用。

返回分配给一个项目的所有组织 API 密钥

返回分配给指定项目的所有组织 API 密钥。在与 API 密钥关联的项目中具有项目所有者角色的用户可以使用组织 API 密钥来访问有关资源。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

编程 API 密钥。
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

创建一个组织 API 密钥并将其分配给一个项目

创建指定的组织 API 密钥并将其分配到指定项目。在与 API 密钥关联的项目中具有项目所有者角色的用户可以使用组织 API 密钥来访问有关资源。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

创建并分配给指定项目的组织 API 密钥。

desc
必需
字符串 [ 1 .. 250 ] 个字符

有人创建此项目 API 密钥时说明的用途或提供的解释。

角色
必需
数组 字符串 non-empty
列项枚举： “ORG_OWNER” "ORG_MEMBER" “ORG_GROUP_CREATOR” "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN" "GROUP_ATLAS_ADMIN" "GROUP_AUTOMATION_ADMIN" "GROUP_BACKUP_ADMIN" "GROUP_MONITORING_ADMIN" "GROUP_OWNER" "GROUP_READ_ONLY" "GROUP_USER_ADMIN" "GROUP_BILLING_ADMIN" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_CHARTS_ADMIN" "GROUP_CLUSTER_MANAGER" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_STREAM_PROCESSING_OWNER"

授予此 API 密钥的角色列表。您如果提供此列表，请至少提供一个角色并确保每个角色都适用于该项目。

响应

请求样本

内容类型
application/json
{
  • "desc": "string",
  • "roles": [
    ]
}

响应样本

内容类型
application/json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

取消指定单个项目中单个组织的 API 密钥

从指定项目中删除一个组织 API 密钥。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

编程 API 密钥。
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

apiUserId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要从一个项目取消分配的此组织 API 密钥。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{ }

更新一个组织 API 密钥在一个项目中的角色

更新您为指定项目指定的组织 API 密钥的角色。您必须为项目指定至少一个有效的角色。如果您未在此请求中包含任何角色，而这些角色之前已在您为项目指定的组织 API 密钥中设置，则应用程序会删除这些角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

apiUserId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要从一个项目取消分配的此组织 API 密钥。

查询参数
pageNum
整型 >= 1
默认： 1
示例： pageNum=1

显示响应返回的当前总对象集的页面编号。

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

includeCount
布尔
默认： true
示例： includeCount=true

标志，用于指示响应是否返回响应中的列项总数 (totalCount)。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

请求正文模式：application/json

要更新的组织 API 密钥。此请求至少需要两个正文参数之一。

desc
字符串 [ 1 .. 250 ] 个字符

有人创建此项目 API 密钥时提供的目的或解释。

角色
数组 字符串
列项枚举： “ORG_OWNER” "ORG_MEMBER" “ORG_GROUP_CREATOR” "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN" "GROUP_ATLAS_ADMIN" "GROUP_AUTOMATION_ADMIN" "GROUP_BACKUP_ADMIN" "GROUP_MONITORING_ADMIN" "GROUP_OWNER" "GROUP_READ_ONLY" "GROUP_USER_ADMIN" "GROUP_BILLING_ADMIN" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_CHARTS_ADMIN" "GROUP_CLUSTER_MANAGER" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_STREAM_PROCESSING_OWNER"

授予此 API 密钥的角色列表。您如果提供此列表，请至少提供一个角色并确保每个角色都适用于该项目。

响应

请求样本

内容类型
application/json
{
  • "desc": "string",
  • "roles": [
    ]
}

响应样本

内容类型
application/json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

为单个项目分配单个组织 API 密钥

将指定的组织 API 密钥分配到指定项目。然后，在与 API 密钥关联的项目中具有“项目所有者”角色的用户可以使用组织 API 密钥来访问有关资源。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

apiUserId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要分配给一个项目的此组织 API 密钥。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

将分配给指定项目的组织 API 密钥。

阵列
角色
数组 字符串
列项枚举： "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_STREAM_PROCESSING_OWNER" "GROUP_OWNER" "GROUP_READ_ONLY"

授予此 API 密钥的角色列表。您如果提供此列表，请至少提供一个角色并确保每个角色都适用于该项目。

响应

请求样本

内容类型
application/json
[
  • {
    }
]

响应样本

内容类型
application/json
{ }

返回所有组织 API 密钥

返回指定组织的所有组织 API 密钥。 组织 API 密钥允许对组织进行编程访问。您无法使用API密钥通过控制台登录MongoDB Cloud。 要使用此资源，请求的 API 密钥必须具有组织成员角色。

编程 API 密钥。
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

创建一个组织 API 密钥

为指定组织创建一个 API 密钥。组织 API 密钥授予对组织的编程访问权限。您无法使用 API 密钥登录控制台。要使用此资源，请求的 API 密钥必须具有组织所有者角色。

编程 API 密钥。
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

要创建的组织 API 密钥。

desc
必需
字符串 [ 1 .. 250 ] 个字符

有人创建此组织 API 密钥时提供的目的或解释。

角色
必需
数组 字符串 non-empty
列项枚举： “ORG_OWNER” "ORG_MEMBER" “ORG_GROUP_CREATOR” "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN"

授予此 API 密钥的角色列表。您如果提供此列表，请至少提供一个角色并确保每个角色都适用于该组织。

响应

请求样本

内容类型
application/json
{
  • "desc": "string",
  • "roles": [
    ]
}

响应样本

内容类型
application/json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

删除一个组织 API 密钥

从指定组织中删除一个组织 API 密钥。当您从一个组织中删除 API 密钥时，MongoDB Cloud 还会从使用该密钥的任何项目中删除该密钥。要使用此资源，请求的 API 密钥必须具有组织所有者角色。

配置 Atlas API 访问权限
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

apiUserId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识此组织 API 密钥。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{ }

返回一个组织 API 密钥

返回一个组织 API 密钥。组织 API 密钥授予对组织的编程访问权限。您无法使用 API 密钥通过用户界面登录 MongoDB Cloud。请求的 API 密钥必须具备组织成员角色，才能使用此资源。

编程 API 密钥。
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

apiUserId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要更新的组织 API 密钥。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

更新一个组织 API 密钥

更新指定组织中的一个组织 API 密钥。组织 API 密钥授予对组织的编程访问权限。要使用此资源，请求的 API 密钥必须具有组织所有者角色。

编程 API 密钥。
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

apiUserId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要更新的组织 API 密钥。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

要更新的组织 API 密钥。此请求至少需要两个正文参数之一。

desc
字符串 [ 1 .. 250 ] 个字符

有人创建此组织 API 密钥时说明的用途或提供的解释。

角色
数组 字符串
列项枚举： “ORG_OWNER” "ORG_MEMBER" “ORG_GROUP_CREATOR” "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN"

授予此 API 密钥的角色列表。您如果提供此列表，请至少提供一个角色并确保每个角色都适用于该组织。

响应

请求样本

内容类型
application/json
{
  • "desc": "string",
  • "roles": [
    ]
}

响应样本

内容类型
application/json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

返回一个组织 API 密钥的所有访问列表条目

返回您为指定的组织 API 密钥配置的所有访问列表条目。 要使用此资源，请求的 API 密钥必须具有组织成员角色。

编程 API 密钥。
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

apiUserId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 进制数字字符串，用于标识您要为其返回访问列表条目的组织 API 密钥。

查询参数
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/json
{}

为一个组织 API 密钥创建访问列表条目

为指定的组织 API 密钥创建访问列表条目。资源要求所有 API 请求均源自该 API 访问列表上的 IP 地址。要使用此资源，请求的 API 密钥必须具有“读取写入”角色。

授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

apiUserId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 进制数字字符串，用于标识您要创建新访问列表条目对应的组织 API 密钥。

查询参数
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/json

要为指定的组织 API 密钥创建的访问列表条目。

阵列
cidrBlock
字符串^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a...

要添加到 API 密钥访问列表的网络地址范围。此参数要求使用 Internet 协议第 4 版或第 6 版地址的无类别域间路由 (CIDR) 表示法表示范围。您可以为此参数或 ipAddress 设置值，但不能在同一请求中同时为这两个参数设置值。

IP 地址
字符串^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

要添加到该 API 密钥访问列表中的网络地址。此参数要求将地址表示为一个互联网协议版本 4 或版本 6 地址。您可以为此参数或 cidrBlock 设置值，但不能在同一请求中同时设置两者。

响应

请求样本

内容类型
application/json
[
  • {
    }
]

响应样本

内容类型
application/json
{}

删除一个组织 API 密钥的一个访问列表条目

从指定的组织 API 密钥中删除指定的访问列表条目。资源要求所有 API 请求均源自 API 访问列表上的 IP 地址。要使用此资源，请求的 API 密钥必须具有“读写”角色。此外，您无法从请求的组织 API 密钥中删除请求的 IP 地址。

配置 Atlas API 访问权限
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

apiUserId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 进制数字字符串，用于标识您要删除的访问列表条目对应的组织 API 密钥。

IP 地址
必需
字符串^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
示例： 192.0.2.0%2F24

一个 IP 地址或多个 IP 地址表示为一个 CIDR 区块，用于限制对指定组织 API 资源的请求。添加有子网掩码（如 192.0.2.0/24）的 CIDR 区块时，请使用 URL 编码的值 %2F 代替正斜线 /。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{ }

为一个组织 API 密钥返回一个访问列表条目

返回指定的组织 API 密钥的一个访问列表条目。资源要求所有 API 请求均源自 API 访问列表上的 IP 地址。要使用此资源，请求的 API 密钥必须具有“组织成员”角色。

配置 Atlas API 访问权限
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

IP 地址
必需
字符串^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
示例： 192.0.2.0%2F24

一个 IP 地址或多个 IP 地址表示为一个 CIDR 区块，用于限制对指定组织 API 资源的请求。添加有子网掩码（如 192.0.2.0/24）的 CIDR 区块时，请使用 URL 编码的值 %2F 代替正斜线 /。

apiUserId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 进制数字字符串，用于标识您要为其返回访问列表条目的组织 API 密钥。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{
  • "cidrBlock": "203.0.113.0/24",
  • "count": 1,
  • "created": "2019-08-24T14:15:22Z",
  • "ipAddress": "203.0.113.10",
  • "lastUsed": "2019-08-24T14:15:22Z",
  • "lastUsedAddress": "203.0.113.10",
  • "links": []
}

项目 IP 访问列表

返回、添加、编辑和删除对 Atlas 中数据库部署的网络访问限制。此资源将替换白名单资源。Atlas 于 2021 年 7 月删除了白名单。更新您的应用程序以使用此新资源。此资源管理项目的 IP 访问列表，并支持创建临时访问列表条目，这些条目会在用户可配置的 7 天期限内自动过期。

返回项目 IP 访问列表

从指定项目的 IP 访问列表中返回所有访问列表条目。项目 IP 访问列表中的每个条目都包含一个 IP 地址或一个 CIDR 表示的 IP 地址区块。MongoDB Cloud 仅允许客户端从列入项目 IP 访问列表中的 IP 地址连接到集群。要使用此资源，请求的 API 密钥必须具有“项目只读”或“项目图表管理员”角色。此资源将替换白名单资源。MongoDB Cloud 于 2021 年 7 月删除了白名单。更新您的应用程序以使用此新资源。/groups/{GROUP-ID}/accessList 端点管理数据库 IP 访问列表。此端点与 orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist 端点不同，后者管理 MongoDB Cloud 组织的访问列表。

IP 访问列表
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{}

将条目添加到项目 IP 访问列表

为指定项目添加一个或多个访问列表条目。MongoDB Cloud 仅允许客户端从列入项目 IP 访问列表中的 IP 地址连接到集群。将每个条目写入一个 IP 地址或一个以 CIDR 表示的 IP 地址区块。要使用此资源，请求的 API 密钥必须具有“项目所有者”或“项目图表管理员”角色。此资源将替换白名单资源。MongoDB Cloud 于 2021 年 7 月删除了白名单。更新您的应用程序以使用此新资源。/groups/{GROUP-ID}/accessList 端点管理数据库 IP 访问列表。此端点与 orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist 端点不同，后者管理 MongoDB Cloud 组织的访问列表。此端点不支持并发 POST 请求。您必须同步提交多个 POST 请求。

IP 访问列表
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

要添加到指定项目的一个或多个访问列表条目。

阵列
awsSecurityGroup
字符串^([0-9]*/)?sg-([0-9]*)

要添加到项目的 IP 访问列表的 Amazon Web Services (AWS) 安全群组的唯一字符串。您的 IP 访问列表条目可以是 1 个 awsSecurityGroup、1 个 cidrBlock 或 1 个 ipAddress。您必须先为项目配置虚拟专用连接 (VPC) 对等互连，然后才能将 AWS 安全群组添加到 IP 访问列表。您无法将 AWS 安全群组设置为临时访问列表条目。如果设置 cidrBlock 或 ipAddress，请勿设置此参数。

cidrBlock
字符串^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...

您想要添加到项目 IP 访问列表的 IP 地址范围，采用无类域间路由 (CIDR) 表示法。您的 IP 访问列表条目可以是 1 个 awsSecurityGroup、1 个 cidrBlock 或 1 个 ipAddress。如果设置了 awsSecurityGroup 或 ipAddress，请勿设置此参数。

comment
字符串 <= 80 个字符

解释此 IP 访问列表条目的用途或范围的注释。

deleteAfterDate
字符串 <date-time>

MongoDB Cloud 删除临时访问列表条目的日期和时间。此参数以 ISO 8601 时间戳格式（UTC 格式）表示其值，可以包括时区名称。该日期必须晚于当前日期，但不得晚于您提交此请求后的一周。如果您在创建此 IP 访问列表条目时指定了到期日期，则资源会返回此参数。

IP 地址
字符串^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

要添加到项目 IP 访问列表的 IP 地址。您的 IP 访问列表条目可以是 1 个 awsSecurityGroup、1 个 cidrBlock 或 1 个 ipAddress。如果设置了 awsSecurityGroup 或 cidrBlock，请勿设置此参数。

响应

请求样本

内容类型
application/json
[
  • {
    }
]

响应样本

内容类型
application/json
{}

从单个项目 IP 访问列表中删除单个条目

从指定项目的 IP 访问列表中删除一个访问列表条目。项目 IP 访问列表中的每个条目都包含一个 IP 地址、一个 CIDR 表示的 IP 地址区块或一个 AWS 安全群组 ID。MongoDB Cloud 仅允许客户端从列入项目 IP 访问列表中的 IP 地址连接到集群。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。此资源将替换白名单资源。MongoDB Cloud 于 2021 年 7 月删除了白名单。更新您的应用程序以使用此新资源。/groups/{GROUP-ID}/accessList 端点管理数据库 IP 访问列表。此端点与 orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist 端点不同，后者管理 MongoDB Cloud 组织的访问列表。

IP 访问列表
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

entryValue
必需
字符串^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
示例： IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8

您要从项目的 IP 访问列表中删除的访问列表条目。该值可以使用以下值之一：一个 AWS 安全组 ID、一个 IP 地址或一个 CIDR 地址区块。对于使用子网掩码的 CIDR 区块，将正斜杠 (/) 替换为其 URL 编码值 (%2F)。当您从 IP 访问列表中删除条目时，被删除地址的现有连接可能会在不同时间内保持打开状态。MongoDB Cloud 关闭连接所需的时间取决于多个因素，包括：

  • 您的应用程序是如何建立连接的，
  • MongoDB Cloud 或使用该地址的驱动程序的行为方式，以及
  • 连接使用哪种协议（如 TCP 或 UDP）。
查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{ }

返回一个项目 IP 访问列表条目

从指定项目的 IP 访问列表中返回一个访问列表条目。项目 IP 访问列表中的每个条目都包含一个 IP 地址或一个 CIDR 注释的 IP 地址区块。MongoDB Cloud 仅允许客户端从列入项目 IP 访问列表中的 IP 地址连接到集群。要使用此资源，请求 API 密钥必须具有项目只读或项目图表管理员角色。此资源将替换白名单资源。MongoDB Cloud 于 2021 年 7 月删除了白名单。更新您的应用程序以使用此新资源。此端点 (/groups/{GROUP-ID}/accessList) 管理项目 IP 访问列表。不管理 MongoDB Cloud 组织的访问列表。编程 API 密钥端点 (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) 管理这些访问列表。

IP 访问列表
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

entryValue
必需
字符串^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
示例： IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8

您要从项目的 IP 访问列表中返回的访问列表条目。该值可以使用以下值之一：一个 AWS 安全组 ID、一个 IP 地址或一个 CIDR 地址区块。对于使用子网掩码的 CIDR 区块，将正斜杠 (/) 替换为其 URL 编码值 (%2F)。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{
  • "awsSecurityGroup": "string",
  • "cidrBlock": "string",
  • "comment": "string",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "ipAddress": "string",
  • "links": []
}

返回单个项目 IP 访问列表条目的状态

返回一个项目 IP 访问列表条目的状态。此资源检查提供的项目 IP 访问列表条目是否适用于为指定项目中的集群提供服务的所有云提供商。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

entryValue
必需
字符串^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
示例： IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8

网络地址或云提供商安全构造，用于标识要验证的项目访问列表条目。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{
  • "STATUS": "PENDING"
}

项目

返回、添加和编辑 MongoDB Cloud 中集群和用户的集合。

返回所有项目

返回有关所有项目的详细信息。项目将集群划分为支持应用程序环境、工作负载或两者的逻辑集合。每个项目可以具有自己的用户、团队、安全、标签和警报设置。要使用此资源，请求的 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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

创建一个项目

创建一个项目。项目将集群划分为支持应用程序环境、工作负载或两者的逻辑集合。每个项目可以具有自己的用户、团队、安全、标签和警报设置。要使用该资源，请求的 API 密钥必须具有读写角色。

授权：
DigestAuth服务账户
查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

projectOwnerId
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要向其授予指定项目的“项目所有者”角色的 MongoDB Cloud 用户。如果设置此参数，它会覆盖最早的组织所有者的默认值。

请求正文模式：application/json

创建一个项目。

名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

人类可读标签，用于标识 MongoDB Cloud 组织中包含的项目。

orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识项目所属的 MongoDB Cloud 组织。

regionUsageRestrictions
字符串
默认： "COMMERCIAL_FEDRAMP_REGIONS_ONLY"
枚举： "COMMERCIAL_FEDRAMP_REGIONS_ONLY" "GOV_REGIONS_ONLY"

仅适用于 Atlas for Government。

在 Commercial Atlas 中，此字段将在请求中被拒绝，并且在响应中会缺失。

此字段对项目中的可用区域设置限制。

值 可用地区
COMMERCIAL_FEDRAMP_REGIONS_ONLY 仅允许在 FedRAMP Moderate 区域中部署。
GOV_REGIONS_ONLY 仅允许在 GovCloud 区域中部署。
https://www.mongodb.com/zh-cn/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions
数组 对象 (Resource Tag)

包含长度在 1 到 255 个字符之间的键值对的列表，用于对项目进行标记和分类。

Resource Tags
withDefaultAlertsSettings
布尔
默认： true

指示是否使用默认警报设置创建项目的标志。

响应

请求样本

内容类型
application/json
{
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ],
  • "withDefaultAlertsSettings": true
}

响应样本

内容类型
application/json
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

使用其名称返回一个项目

返回有关指定项目的详细信息。项目将集群划分为支持应用程序环境、工作负载或两者的逻辑集合。每个项目可以具有自己的用户、团队、安全、标签和警报设置。要使用该资源，请求的 API 密钥必须具有项目只读角色。

授权：
DigestAuth服务账户
路径参数
groupName
必需
字符串 [ 1 .. 64 ] 个字符

人类可读标签，用于标识此项目。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

删除一个项目

删除指定项目。项目将集群划分为支持应用程序环境、工作负载或两者的逻辑集合。每个项目可以具有自己的用户、团队、安全、标签和警报设置。只有在项目中的集群没有在线存档时，您才能删除该项目。要使用该资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{ }

返回一个项目

返回有关指定项目的详细信息。项目将集群划分为支持应用程序环境、工作负载或两者的逻辑集合。每个项目可以具有自己的用户、团队、安全、标签和警报设置。要使用该资源，请求的 API 密钥必须具有项目只读角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

更新一个项目

更新标识指定项目的人类可读标签或与项目相关的标签。要使用此资源，请求的 API 密钥必须具有项目所有者角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

要更新的项目。

名称
字符串

人类可读标签，用于标识 MongoDB Cloud 组织中包含的项目。

数组 对象 (Resource Tag)

包含长度在 1 到 255 个字符之间的键值对的列表，用于对项目进行标记和分类。

Resource Tags

响应

请求样本

内容类型
application/json
{
  • "name": "string",
  • "tags": [
    ]
}

响应样本

内容类型
application/json
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

返回所有项目邀请

将所有待处理邀请返回指定项目。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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 格式的标记。

用户名
字符串 <email>

受邀参与此项目的用户帐户的电子邮件地址。

响应

响应样本

内容类型
application/json
[
  • {
    }
]

更新一个项目邀请

更新针对指定项目发送的一项待处理邀请的详细信息。要指定更新哪个邀请，请提供受邀用户的用户名。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

更新针对指定项目发送的一项待处理邀请的详细信息。

角色
数组 字符串 unique
列项枚举： "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

分配给 MongoDB Cloud 用户的一个或多个项目级别角色。

用户名
字符串 <email>

受邀加入指定项目的 MongoDB Cloud 用户的电子邮件地址。

响应

请求样本

内容类型
application/json
{
  • "roles": [
    ],
  • "username": "user@example.com"
}

响应样本

内容类型
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

邀请一位 MongoDB Cloud 用户加入一个项目

邀请一个 MongoDB Cloud 用户加入指定项目。MongoDB Cloud 用户必须接受邀请才能访问指定项目中的信息。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

查询参数
pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

请求正文模式：application/json

邀请一个 MongoDB Cloud 用户加入指定项目。

角色
数组 字符串 unique
列项枚举： "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

分配给 MongoDB Cloud 用户的一个或多个项目级别角色。

用户名
字符串 <email>

受邀加入指定项目的 MongoDB Cloud 用户的电子邮件地址。

响应

请求样本

内容类型
application/json
{
  • "roles": [
    ],
  • "username": "user@example.com"
}

响应样本

内容类型
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

取消一个项目邀请

取消发送给指定 MongoDB Cloud 用户的一项待处理邀请以加入项目。您无法取消用户已接受的邀请。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

invitationId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

标识该邀请的唯一 24 位十六进制数字字符串。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

响应

响应样本

内容类型
application/json
{ }

返回一个项目邀请

返回针对指定项目发送的一项待处理邀请的详细信息。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

invitationId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

标识该邀请的唯一 24 位十六进制数字字符串。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

按邀请 ID 更新一个项目邀请

更新针对指定项目发送的一项待处理邀请的详细信息。要指定更新哪个邀请，请提供该邀请的唯一标识字符串。使用“返回所有项目邀请”端点检索所有待处理项目邀请的 ID。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

invitationId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

标识该邀请的唯一 24 位十六进制数字字符串。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

请求正文模式：application/json

更新针对指定项目发送的一项待处理邀请的详细信息。

角色
数组 字符串 unique
列项枚举： "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

要分配给该 MongoDB Cloud 用户的一个或多个组织或项目级别角色。

响应

请求样本

内容类型
application/json
{
  • "roles": [
    ]
}

响应样本

内容类型
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

返回一个项目的全部限制

返回指定项目的所有限制。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
[
  • {
    }
]

删除一个项目限制

删除指定的项目限制。根据限制，Atlas 会将限制重置为其默认值或完全删除限制。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
limitName
必需
字符串
枚举： "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.deployment.serverlessMTMs" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion" "dataFederation.bytesProcessed.query" "dataFederation.bytesProcessed.daily" "dataFederation.bytesProcessed.weekly" "dataFederation.bytesProcessed.monthly" "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" "atlas.project.deployment.privateServiceConnectionsSubnetMask" "atlas.project.deployment.salesSoldM0s"

人类可读标签，用于标识此项目限制。

限制名称 说明 默认 API 覆盖限制
atlas.project.deployment.clusters 如果组织没有销售，则限制该项目的集群数量（如果组织有销售，则限制为 100） 25 90
atlas.project.deployment.nodesPerPrivateLinkRegion 此项目中每个专用链接地区的节点数限制 50 90
atlas.project.security.databaseAccess.customRoles 此项目中自定义角色的数量限制 100 1400
atlas.project.security.databaseAccess.users 此项目中的数据库用户数量限制 100 900
atlas.project.security.networkAccess.crossRegionEntries 此项目跨区域网络访问入口数量限制 40 220
atlas.project.security.networkAccess.entries 此项目中网络访问入口的数量限制 200 20
dataFederation.bytesProcessed.query 单个 Data Federation 查询期间处理的字节数限制 不适用 不适用
dataFederation.bytesProcessed.daily 当日所有 Atlas Data Federation 租户中处理的字节数限制 不适用 不适用
dataFederation.bytesProcessed.weekly 当前一周所有 Atlas Data Federation 租户中处理的字节数限制 不适用 不适用
dataFederation.bytesProcessed.monthly 当月所有 Atlas Data Federation 租户中处理的字节数限制 不适用 不适用
atlas.project.deployment.privateServiceConnectionsPerRegionGroup 每个区域群组的私有服务连接数 50 100
atlas.project.deployment.privateServiceConnectionsSubnetMask GCP PSC 网络的子网掩码。下限为 20。 27 27
atlas.project.deployment.salesSoldM0s 如果组织是销售型组织，则限制此项目中 M0 个集群的数量 100 100
groupId
必需
字符串 = 24 个字符 ^([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/json
{ }

为一个项目返回一个限制

返回指定项目的指定限制。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
limitName
必需
字符串
枚举： "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.deployment.serverlessMTMs" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion" "dataFederation.bytesProcessed.query" "dataFederation.bytesProcessed.daily" "dataFederation.bytesProcessed.weekly" "dataFederation.bytesProcessed.monthly" "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" "atlas.project.deployment.privateServiceConnectionsSubnetMask" "atlas.project.deployment.salesSoldM0s"

人类可读标签，用于标识此项目限制。

限制名称 说明 默认 API 覆盖限制
atlas.project.deployment.clusters 如果组织没有销售，则限制该项目的集群数量（如果组织有销售，则限制为 100） 25 90
atlas.project.deployment.nodesPerPrivateLinkRegion 此项目中每个专用链接地区的节点数限制 50 90
atlas.project.security.databaseAccess.customRoles 此项目中自定义角色的数量限制 100 1400
atlas.project.security.databaseAccess.users 此项目中的数据库用户数量限制 100 900
atlas.project.security.networkAccess.crossRegionEntries 此项目跨区域网络访问入口数量限制 40 220
atlas.project.security.networkAccess.entries 此项目中网络访问入口的数量限制 200 20
dataFederation.bytesProcessed.query 单个 Data Federation 查询期间处理的字节数限制 不适用 不适用
dataFederation.bytesProcessed.daily 当日所有 Atlas Data Federation 租户中处理的字节数限制 不适用 不适用
dataFederation.bytesProcessed.weekly 当前一周所有 Atlas Data Federation 租户中处理的字节数限制 不适用 不适用
dataFederation.bytesProcessed.monthly 当月所有 Atlas Data Federation 租户中处理的字节数限制 不适用 不适用
atlas.project.deployment.privateServiceConnectionsPerRegionGroup 每个区域群组的私有服务连接数 50 100
atlas.project.deployment.privateServiceConnectionsSubnetMask GCP PSC 网络的子网掩码。下限为 20。 27 27
atlas.project.deployment.salesSoldM0s 如果组织是销售型组织，则限制此项目中 M0 个集群的数量 100 100
groupId
必需
字符串 = 24 个字符 ^([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/json
例子
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "maximumLimit": 0,
  • "name": "atlas.project.deployment.clusters",
  • "value": 0
}

设置一个项目限制

设置指定项目限制。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

注意：增加以下配置限制可能会导致 MongoDB Cloud UI 的响应时间变慢，或者增加用户管理开销，从而导致重建身份验证或授权架构。如果可能，我们建议您创建更多项目来获取更多此类资源，从而实现更加可持续的增长模式。

授权：
DigestAuth服务账户
路径参数
limitName
必需
字符串
枚举： "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.deployment.serverlessMTMs" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion" "dataFederation.bytesProcessed.query" "dataFederation.bytesProcessed.daily" "dataFederation.bytesProcessed.weekly" "dataFederation.bytesProcessed.monthly" "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" "atlas.project.deployment.privateServiceConnectionsSubnetMask" "atlas.project.deployment.salesSoldM0s"

人类可读标签，用于标识此项目限制。

限制名称 说明 默认 API 覆盖限制
atlas.project.deployment.clusters 如果组织没有销售，则限制该项目的集群数量（如果组织有销售，则限制为 100） 25 90
atlas.project.deployment.nodesPerPrivateLinkRegion 此项目中每个专用链接地区的节点数限制 50 90
atlas.project.security.databaseAccess.customRoles 此项目中自定义角色的数量限制 100 1400
atlas.project.security.databaseAccess.users 此项目中的数据库用户数量限制 100 900
atlas.project.security.networkAccess.crossRegionEntries 此项目跨区域网络访问入口数量限制 40 220
atlas.project.security.networkAccess.entries 此项目中网络访问入口的数量限制 200 20
dataFederation.bytesProcessed.query 单个 Data Federation 查询期间处理的字节数限制 不适用 不适用
dataFederation.bytesProcessed.daily 当日所有 Atlas Data Federation 租户中处理的字节数限制 不适用 不适用
dataFederation.bytesProcessed.weekly 当前一周所有 Atlas Data Federation 租户中处理的字节数限制 不适用 不适用
dataFederation.bytesProcessed.monthly 当月所有 Atlas Data Federation 租户中处理的字节数限制 不适用 不适用
atlas.project.deployment.privateServiceConnectionsPerRegionGroup 每个区域群组的私有服务连接数 50 100
atlas.project.deployment.privateServiceConnectionsSubnetMask GCP PSC 网络的子网掩码。下限为 20。 27 27
atlas.project.deployment.salesSoldM0s 如果组织是销售型组织，则限制此项目中 M0 个集群的数量 100 100
groupId
必需
字符串 = 24 个字符 ^([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/json

限制更新。

值
必需
整型 <int64>

要设置限制的金额。

响应

请求样本

内容类型
application/json
例子
{
  • "value": 0,
  • "name": "atlas.project.deployment.clusters"
}

响应样本

内容类型
application/json
例子
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "maximumLimit": 0,
  • "name": "atlas.project.deployment.clusters",
  • "value": 0
}

返回一个项目设置

返回有关指定项目设置的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isExtendedStorageSizesEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

更新一个项目设置

更新指定项目的设置。您可以更新任何可用选项。MongoDB Cloud 仅更新请求中提供的选项。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

要更新的设置。

isCollectDatabaseSpecificsStatisticsEnabled
布尔

指示是否为指定项目收集特定于数据库的指标的标志。

isDataExplorerEnabled
布尔

该标志指示是否为指定项目启用数据浏览器。

isExtendedStorageSizesEnabled
布尔

指示是否为指定项目启用扩展存储大小的标志。

isPerformanceAdvisorEnabled
布尔

指示是否为指定项目启用性能优化顾问和分析器的标志。

isRealtimePerformancePanelEnabled
布尔

指示是否为指定项目启用“实时性能面板”的标志。

isSchemaAdvisorEnabled
布尔

指示是否为指定项目启用模式顾问程序的标志。

响应

请求样本

内容类型
application/json
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isExtendedStorageSizesEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

响应样本

内容类型
application/json
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isExtendedStorageSizesEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

返回一个项目中的所有用户

返回有关指定项目中所有用户的详细信息。用户属于一个组织。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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 格式的标记。

flattenTeams
布尔
默认： false

指示返回列表是否应包括属于在此项目中具有角色的团队的用户的标志。您可能尚未在此项目中为各个用户分配角色。如果为 "flattenTeams" : false，则此资源仅返回在项目中具有角色的用户。如果为 "flattenTeams" : true，则此资源会同时返回在项目中具有角色的用户以及属于在项目中具有角色的团队的用户。

includeOrgUsers
布尔
默认： false

指示返回的列表是否应包含对项目具有隐式访问权限的用户、组织所有者或组织只读角色的标志。您可能尚未在此项目中为单个用户分配角色。如果为 "includeOrgUsers": false，则此资源仅返回在项目中具有角色的用户。如果为 "includeOrgUsers": true，则此资源将返回在项目中具有角色的用户以及通过其组织角色对项目具有隐式访问权限的用户。

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

从一个项目中删除一名用户

从指定项目中删除指定用户。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

用户 ID
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制字符串，用于标识要从指定项目中删除的 MongoDB Cloud 用户。要使用应用程序用户名返回应用程序用户的 ID，请使用“获取一个项目中的所有应用程序用户”端点。

查询参数
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"
}

滚动指数

以滚动方式为数据库部署创建一个索引。您无法在 M0 免费集群或 M2/M5 共享集群上创建滚动索引。

创建一个滚动索引

以滚动方式在名称标识的集群上创建索引。以这种方式创建索引，支持从从节点开始，一次在一个副本集节点上作为单节点创建索引。以这种方式创建索引，至少需要一次副本集选举。要使用此资源，请求的 API 密钥必须具有项目数据访问管理员角色。

基于副本集构建的滚动索引
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

可读的标签，用于标识 MongoDB Cloud 创建索引的集群。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

要在指定群集上创建的滚动索引。

对象 （排序规则）

一个或多个设置，用于指定比较该索引内字符串的语言特定的规则。

排序规则选项
集合
必需
字符串

MongoDB Cloud 为其创建索引的集合的人类可读标签。

db
必需
字符串

人类可读的数据库标签，用于保存 MongoDB Cloud 在其上创建索引的集合。

数组 对象[ 项目 = 1 属性 ]

包含一个或多个对象的列表，这些对象描述要创建索引的参数。

对象 (IndexOptions)

决定 MongoDB Cloud 如何创建此 MongoDB 索引的一项或多项设置。

索引选项

响应

请求样本

内容类型
application/json
例子

2dspere Index

{
  • "collation": {
    },
  • "collection": "accounts",
  • "db": "sample_airbnb",
  • "keys": [
    ],
  • "options": {
    }
}

响应样本

内容类型
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"
}

根

返回描述 MongoDB Cloud 构建信息以及请求此资源的访问令牌的详细信息。这将启动 MongoDB Cloud API。

返回此 MongoDB 应用程序的状态

此资源返回有关 MongoDB 应用程序的信息以及 API 密钥元数据。

授权：
DigestAuth服务账户
查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{
  • "apiKey": {
    },
  • "appName": "MongoDB Atlas",
  • "build": "83be55e140f493c88e7f578aae96548dd881587b",
  • "links": [],
  • "throttling": true
}

无服务器实例

返回、添加、编辑和删除无服务器实例。

返回一个项目的所有无服务器实例

返回指定项目中所有无服务器实例的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

在一个项目中创建一个无服务器实例

创建指定项目中的一个无服务器实例。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

在一个项目中创建一个无服务器实例。

名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

用于标识无服务器实例的人类可读标签。

必需
对象 （无服务器实例的云服务提供商设置）

云提供商设置群组，用于配置预配的 MongoDB 无服务器实例。

对象 (无服务器备份选项）

设置群组，用于配置无服务器备份。

数组 对象 (Resource Tag)

包含长度在 1 到 255 个字符之间的键值对的列表，用于对无服务器实例进行标记和分类。

terminationProtectionEnabled
布尔
默认： false

指示是否在无服务器实例上启用终止保护的标记。如果设置为 true，MongoDB Cloud 不会删除无服务器实例。如果设置为 false，MongoDB Cloud 将删除无服务器实例。

响应

请求样本

内容类型
application/json
{
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

响应样本

内容类型
application/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 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{ }

从一个项目返回一个无服务器实例

返回指定项目中一个无服务器实例的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

更新一个项目中的一个无服务器实例

在指定项目中更新一个无服务器实例。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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

在一个项目中更新一个无服务器实例。

对象 (无服务器备份选项）

设置群组，用于配置无服务器备份。

数组 对象 (Resource Tag)

包含长度在 1 到 255 个字符之间的键值对的列表，用于对无服务器实例进行标记和分类。

terminationProtectionEnabled
布尔
默认： false

指示是否在无服务器实例上启用终止保护的标记。如果设置为 true，MongoDB Cloud 不会删除无服务器实例。如果设置为 false，MongoDB Cloud 将删除无服务器实例。

响应

请求样本

内容类型
application/json
{
  • "serverlessBackupOptions": {
    },
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

响应样本

内容类型
application/json
{
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

无服务器私有端点

返回、添加、编辑和删除无服务器实例的私有端点。要了解详情，请参阅以下教程中的 Atlas Administration API 标签页。

为无服务器实例设置私有端点教程

返回一个无服务器实例的所有私有端点。

为一个无服务器实例返回所有私有端点。您必须至少具有项目的“项目只读”角色才能成功调用此资源。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

实例名称
必需
字符串 <= 64 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，用于标识与租户端点关联的无服务器实例。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

响应

响应样本

内容类型
application/json
[
  • {
    }
]

为一个无服务器实例创建一个私有端点

为一个无服务器实例更新一个私有端点。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

新端点在创建后不会立即可用。阅读链接教程中的步骤以获取详细指导。

为无服务器实例设置私有端点教程
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

实例名称
必需
字符串 <= 64 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，用于标识将为其创建租户端点的无服务器实例。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

请求正文模式：application/json

有关要为无服务器实例创建的私有端点的信息。

comment
字符串 <= 80 个字符

与私有端点关联的人类可读注释。

响应

请求样本

内容类型
application/json
{
  • "comment": "string"
}

响应样本

内容类型
application/json
例子
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "cloudProviderEndpointId": "string",
  • "comment": "string",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "providerName": "AWS",
  • "status": "RESERVATION_REQUESTED"
}

为一个无服务器实例删除一个私有端点

为一个无服务器实例返回一个私有端点。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

实例名称
必需
字符串 <= 64 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，用于标识将从中删除租户端点的无服务器实例。

endpointId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要删除的租户端点。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

响应

响应样本

内容类型
application/json
{ }

为一个无服务器实例返回一个私有端点

返回一个无服务器实例的所有私有端点。使用其唯一 ID 标识此端点。您必须至少具有项目的“项目只读”角色才能成功调用此资源。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

实例名称
必需
字符串 <= 64 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，用于标识与租户端点关联的无服务器实例。

endpointId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

标识租户端点的唯一 24 位十六进制数字字符串。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

响应

响应样本

内容类型
application/json
例子
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "cloudProviderEndpointId": "string",
  • "comment": "string",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "providerName": "AWS",
  • "status": "RESERVATION_REQUESTED"
}

为指定无服务器实例更新指定私有端点。

为一个无服务器实例创建一个私有端点。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

实例名称
必需
字符串 <= 64 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

人类可读标签，用于标识与将更新的租户端点关联的无服务器实例。

endpointId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要更新的租户端点。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

请求正文模式：application/json

用于更新的对象。

comment
字符串 <= 80 个字符

与私有端点关联的人类可读注释。

提供商名称
必需
字符串

人类可读标签，用于标识租户端点的云提供商。

cloudProviderEndpointId
字符串^vpce-[0-9a-f]{17}$

标识私有端点的网络接口的唯一字符串。

响应

请求样本

内容类型
application/json
例子
{
  • "comment": "string",
  • "providerName": "AWS",
  • "cloudProviderEndpointId": "string"
}

响应样本

内容类型
application/json
例子
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "cloudProviderEndpointId": "string",
  • "comment": "string",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "providerName": "AWS",
  • "status": "RESERVATION_REQUESTED"
}

共享层恢复作业

返回并添加共享层级据库部署的恢复作业。

从一个 M2 或 M5 集群创建一个恢复作业

恢复指定集群。MongoDB Cloud 限制哪些集群可以作为恢复的目标集群。目标集群无法使用静态加密、运行与快照不同的主要版本 MongoDB 版本或在恢复期间接收客户端请求。MongoDB Cloud 会在恢复操作之前删除目标集群上的所有现有数据。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

用于标识集群的人类可读标签。

groupId
必需
字符串 = 24 个字符 ^([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/json

恢复作业详细信息。

snapshotId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要恢复的快照。

targetDeploymentItemName
必需
字符串 [ 1 .. 64 ] 个字符 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

人类可读标签，用于标识要将快照恢复到的目标项目上的集群。您可以将快照恢复到集群层 M2 或更高层。

targetProjectId
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识包含要将快照恢复到的集群的项目。

响应

请求样本

内容类型
application/json
{
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

响应样本

内容类型
application/json
{
  • "clusterName": "string",
  • "deliveryType": "RESTORE",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreFinishedDate": "2019-08-24T14:15:22Z",
  • "restoreScheduledDate": "2019-08-24T14:15:22Z",
  • "snapshotFinishedDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "snapshotUrl": "string",
  • "status": "PENDING",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

返回一个 M2 或 M5 集群的所有恢复作业

返回指定 M2 或 M5 集群的所有恢复作业。恢复作业使用快照还原集群。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

用于标识集群的人类可读标签。

groupId
必需
字符串 = 24 个字符 ^([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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

返回一个 M2 或 M5 集群的一个恢复作业

返回指定的恢复作业。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

用于标识集群的人类可读标签。

groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

restoreId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，标识要返回的恢复作业。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{
  • "clusterName": "string",
  • "deliveryType": "RESTORE",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreFinishedDate": "2019-08-24T14:15:22Z",
  • "restoreScheduledDate": "2019-08-24T14:15:22Z",
  • "snapshotFinishedDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "snapshotUrl": "string",
  • "status": "PENDING",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

共享层快照

返回并请求下载共享层数据库部署快照。

下载单个 M2 或 M5 集群快照

为指定共享集群请求一个快照。此资源返回可用于下载快照的 snapshotURL。提出请求后，此 snapshotURL 会在四小时内保持活动状态。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

用于标识集群的人类可读标签。

groupId
必需
字符串 = 24 个字符 ^([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/json

要下载的快照。

snapshotId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要恢复的快照。

targetDeploymentItemName
必需
字符串 [ 1 .. 64 ] 个字符 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

人类可读标签，用于标识要将快照恢复到的目标项目上的集群。您可以将快照恢复到集群层 M2 或更高层。

targetProjectId
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识包含要将快照恢复到的集群的项目。

响应

请求样本

内容类型
application/json
{
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

响应样本

内容类型
application/json
{
  • "clusterName": "string",
  • "deliveryType": "RESTORE",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreFinishedDate": "2019-08-24T14:15:22Z",
  • "restoreScheduledDate": "2019-08-24T14:15:22Z",
  • "snapshotFinishedDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "snapshotUrl": "string",
  • "status": "PENDING",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

返回一个 M2 或 M5 集群的所有快照

返回指定共享集群的所有快照的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[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
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

返回一个 M2 或 M5 集群的一个快照

返回指定共享集群的一个快照的详细信息。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

集群名称
必需
字符串 [ 1 .. 64 ] 个字符 ^[a-zA-Z0-9][a-zA-Z0-9-]*$

用于标识集群的人类可读标签。

snapshotId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

用于标识所需快照的唯一的 24 位十六进制数字字符串。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{
  • "expiration": "2019-08-24T14:15:22Z",
  • "finishTime": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "scheduledTime": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "status": "PENDING"
}

团队

返回、添加、编辑或删除团队。

将所有团队返回到一个项目中

返回在使用其唯一的 24 位十六进制数字标识符指定的项目中，经过身份验证的用户有权访问的所有团队。团队中的所有成员都共享相同的项目访问权限。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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 格式的标记。

includeCount
布尔
默认： true
示例： includeCount=true

标志，用于指示响应是否返回响应中的列项总数 (totalCount)。

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

显示响应返回的当前总对象集的页面编号。

响应

响应样本

内容类型
application/json
{}

将一个或多个团队添加到一个项目

将一个团队添加到指定项目。团队中的所有成员都共享相同的项目访问权限。MongoDB Cloud 将用户数量限制为每个项目最多 100 个团队，每个组织最多 250 个团队。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

管理组织团队
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json

要添加到指定项目的团队。

阵列
roleNames
数组 字符串 unique
列项枚举： "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

要分配给 MongoDB Cloud 用户的一个或多个组织或项目级别角色。

teamId
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制字符串，用于标识团队。

响应

请求样本

内容类型
application/json
[
  • {
    }
]

响应样本

内容类型
application/json
{}

从一个项目中删除一个团队

从使用其唯一的 24 位十六进制数字标识符指定的项目中删除使用其唯一的 24 位十六进制数字标识符指定的一个团队。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

管理组织团队
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

teamId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要从指定项目中删除的团队。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

响应

响应样本

内容类型
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
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

teamId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要为其更新角色的团队。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

分配给指定团队的项目角色。

roleNames
数组 字符串 unique
列项枚举： "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

要分配给 MongoDB Cloud 用户的一个或多个组织或项目级别角色。

teamId
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制字符串，用于标识团队。

响应

请求样本

内容类型
application/json
{
  • "roleNames": [
    ],
  • "teamId": "32b6e34b3d91647abb20e7b8"
}

响应样本

内容类型
application/json
{}

返回一个组织中的所有团队

返回属于指定组织的所有团队。团队使您能够向 MongoDB Cloud 用户授予项目访问角色。MongoDB Cloud 仅返回您有权访问的团队。请求的 API 密钥必须具备组织成员角色，才能使用此资源。

管理组织团队
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

includeCount
布尔
默认： true
示例： includeCount=true

标志，用于指示响应是否返回响应中的列项总数 (totalCount)。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

显示响应返回的当前总对象集的页面编号。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{}

在一个组织中创建一个团队

创建指定组织中的一个团队。团队使您能够向 MongoDB Cloud 用户授予项目访问角色。MongoDB Cloud 将团队数量限制为每个组织最多 250 个团队。要使用此资源，请求的 API 密钥必须具有“组织所有者”角色。

管理组织团队
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

要在指定组织中创建的团队。

名称
必需
字符串

人类可读标签，用于标识团队。

usernames
必需
数组 字符串 <email> unique

包含此团队中的 MongoDB Cloud 用户的列表。

响应

请求样本

内容类型
application/json
{
  • "name": "string",
  • "usernames": [
    ]
}

响应样本

内容类型
application/json
{}

使用名称返回一个团队

返回您使用人类可读名称标识的一个团队。此团队属于一个组织。团队使您能够向 MongoDB Cloud 用户授予项目访问角色。要使用此资源，请求的 API 密钥必须具有“组织成员”角色。

管理组织团队
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

teamName
必需
字符串

要返回其信息的团队的名称。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{}

从一个组织中删除一个团队

从使用其唯一的 24 位十六进制数字标识符指定的组织中删除使用其唯一 24 位十六进制数字标识符指定的一个团队。要使用此资源，请求的 API 密钥必须具有组织所有者角色。

管理组织团队
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

teamId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要删除的团队。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{ }

使用其 ID 返回一个团队

返回使用其唯一的 24 位十六进制数字 ID 标识的一个团队。此团队属于一个组织。团队使您能够向 MongoDB Cloud 用户授予项目访问角色。要使用此资源，请求的 API 密钥必须具有“组织成员”角色。

管理组织团队
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

teamId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要返回其信息的团队。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{}

重命名一个团队

在指定组织中重命名一个团队。团队使您能够向 MongoDB Cloud 用户授予项目访问角色。要使用此资源，请求的 API 密钥必须具有“组织所有者”角色。

管理组织团队
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

teamId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要重命名的团队。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

有关要更新指定团队的详细信息。

名称
必需
字符串

人类可读标签，用于标识团队。

响应

请求样本

内容类型
application/json
{
  • "name": "string"
}

响应样本

内容类型
application/json
{}

返回分配给一个团队的所有 MongoDB Cloud 用户

返回分配给使用其唯一的 24 位十六进制数字标识符指定的团队的所有 MongoDB Cloud 用户。此团队属于一个组织。团队使您能够向 MongoDB Cloud 用户授予项目访问角色。要使用此资源，请求的 API 密钥必须具有“组织成员”角色。

管理组织团队
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

teamId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要返回其应用程序用户的团队。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

itemsPerPage
整型 [ 1 .. 500 ]
默认： 100
示例： itemsPerPage=100

响应每页返回的列项数。

pageNum
整型 >= 1
默认： 1
示例： pageNum=1

显示响应返回的当前总对象集的页面编号。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

将 MongoDB Cloud 用户从一个组织分配给一个团队

将指定组织中的一个或多个 MongoDB Cloud 用户添加到指定团队。团队使您能够向 MongoDB Cloud 用户授予项目访问角色。您可以将一个组织中最多 250 个 MongoDB Cloud 用户分配给一个团队。要使用此资源，请求的 API 密钥必须具有“组织所有者”角色。

管理组织团队
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

teamId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制字符串，用于标识要添加 MongoDB Cloud 用户的团队。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

要添加到指定团队的一个或多个 MongoDB Cloud 用户。

阵列
id
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识 MongoDB Cloud 用户。

响应

请求样本

内容类型
application/json
[
  • {
    }
]

响应样本

内容类型
application/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

从一个团队中删除一个 MongoDB 云用户

从指定团队中删除一个 MongoDB Cloud 用户。此团队属于一个组织。团队使您能够向 MongoDB Cloud 用户授予项目访问角色。要使用此资源，请求的 API 密钥必须具有“组织所有者”角色。

管理组织团队
授权：
DigestAuth服务账户
路径参数
orgId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 4888442a3354817a7320eb61

唯一的 24 位十六进制数字字符串，用于标识包含您的项目的组织。使用 /orgs 端点检索已通过身份验证的用户可以访问的所有组织。

teamId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要从中删除一个数据库应用程序用户的团队。

用户 ID
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$

唯一的 24 位十六进制数字字符串，用于标识要从指定团队中删除的 MongoDB Cloud 用户。

查询参数
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"
}

第三方集成

返回、添加、编辑和删除第三方服务集成配置。MongoDB Cloud 会向您配置的每个第三方服务发送警报。

重要提示：每个项目的每种集成类型只能有一个配置。

返回所有活跃的第三方服务集成

返回允许与所有已配置的第三方服务集成的设置。这些设置适用于一个 MongoDB Cloud 项目中托管的所有数据库。要使用此资源，请求的 API 密钥必须具有“组织所有者”或“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([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/json
{}

移除一项第三方服务集成

删除允许配置一个第三方服务集成的设置。这些设置适用于一个 MongoDB Cloud 项目中托管的所有数据库。如果从项目中删除集成，则仅删除该项目的集成配置。此操作不会影响任何其他项目或组织的已配置 {INTEGRATION-TYPE} 集成。要使用此资源，请求的 API 密钥必须具有“组织所有者”或“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
integrationType
必需
字符串 (集成类型）
枚举： "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

人类可读标签，用于标识要与 MongoDB Cloud 集成的服务。

groupId
必需
字符串 = 24 个字符 ^([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/json
{ }

返回一个第三方服务集成

返回用于配置与第三方服务集成的设置。这些设置适用于一个 MongoDB Cloud 项目中托管的所有数据库。要使用此资源，请求的 API 密钥必须具有“组织所有者”或“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

integrationType
必需
字符串 (集成类型）
枚举： "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

人类可读标签，用于标识要与 MongoDB Cloud 集成的服务。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

响应

响应样本

内容类型
application/json
例子
{
  • "apiKey": "****************************a23c",
  • "id": "string",
  • "region": "US",
  • "sendCollectionLatencyMetrics": false,
  • "sendDatabaseMetrics": false,
  • "type": "DATADOG"
}

配置一项第三方服务集成

添加用于配置第三方服务集成的设置。这些设置适用于指定 MongoDB Cloud 项目中托管的所有数据库。每个项目的每个 {INTEGRATION-TYPE} 只能有一个配置。要使用此资源，请求的 API 密钥必须具有“组织所有者”或“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
integrationType
必需
字符串 (集成类型）
枚举： "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

人类可读标签，用于标识要与 MongoDB Cloud 集成的服务。

groupId
必需
字符串 = 24 个字符 ^([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/json

要为项目配置的第三方集成。

apiKey
必需
字符串

允许 MongoDB Cloud 访问 Datadog 帐户的密钥。

注意：创建需要 API 或集成密钥的通知后，当您执行以下操作时，该密钥将显示为部分经过校订的：

  • 通过 Atlas UI 查看或编辑警报。

  • 通过 Atlas Administration API 查询通知警报。

id
string 或 null

集成 ID。

区域
字符串
枚举： "US" "EU" "US3" "US5" "AP1" "US1_FED"

双字母代码，表示 MongoDB 使用哪个区域 URL 访问 Datadog API。

要了解有关 Datadog 地区的更多信息，请参阅 Datadog 站点。

sendCollectionLatencyMetrics
布尔
默认： false

切换发送集合延迟指标，包括数据库名称和集合名称以及读取、写入、命令和事务的延迟指标。

sendDatabaseMetrics
布尔
默认： false

切换发送数据库指标，包括数据库名称以及有关集合数量、存储大小和索引大小的指标。

类型
字符串

人类可读标签，用于标识要与 MongoDB Cloud 集成的服务。该值必须与第三方服务集成类型匹配。

响应

请求样本

内容类型
application/json
例子
{
  • "apiKey": "****************************a23c",
  • "id": "string",
  • "region": "US",
  • "sendCollectionLatencyMetrics": false,
  • "sendDatabaseMetrics": false,
  • "type": "DATADOG"
}

响应样本

内容类型
application/json
{}

更新一项第三方服务集成

更新用于配置与第三方服务集成的设置。这些设置适用于一个 MongoDB Cloud 项目中托管的所有数据库。要使用此资源，请求的 API 密钥必须具有“组织所有者”或“项目所有者”角色。

授权：
DigestAuth服务账户
路径参数
integrationType
必需
字符串 (集成类型）
枚举： "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

人类可读标签，用于标识要与 MongoDB Cloud 集成的服务。

groupId
必需
字符串 = 24 个字符 ^([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/json

要为项目配置的第三方集成。

apiKey
必需
字符串

允许 MongoDB Cloud 访问 Datadog 帐户的密钥。

注意：创建需要 API 或集成密钥的通知后，当您执行以下操作时，该密钥将显示为部分经过校订的：

  • 通过 Atlas UI 查看或编辑警报。

  • 通过 Atlas Administration API 查询通知警报。

id
string 或 null

集成 ID。

区域
字符串
枚举： "US" "EU" "US3" "US5" "AP1" "US1_FED"

双字母代码，表示 MongoDB 使用哪个区域 URL 访问 Datadog API。

要了解有关 Datadog 地区的更多信息，请参阅 Datadog 站点。

sendCollectionLatencyMetrics
布尔
默认： false

切换发送集合延迟指标，包括数据库名称和集合名称以及读取、写入、命令和事务的延迟指标。

sendDatabaseMetrics
布尔
默认： false

切换发送数据库指标，包括数据库名称以及有关集合数量、存储大小和索引大小的指标。

类型
字符串

人类可读标签，用于标识要与 MongoDB Cloud 集成的服务。该值必须与第三方服务集成类型匹配。

响应

请求样本

内容类型
application/json
例子
{
  • "apiKey": "****************************a23c",
  • "id": "string",
  • "region": "US",
  • "sendCollectionLatencyMetrics": false,
  • "sendDatabaseMetrics": false,
  • "type": "DATADOG"
}

响应样本

内容类型
application/json
{}

X.509 身份验证

返回、编辑和删除用户管理的 X.509 配置。还为数据库用户返回并生成 MongoDB Cloud 管理的 X.509 证书。以下资源可帮助管理使用 X.509 证书进行身份验证的数据库用户。您可以管理这些 X.509 证书或让 MongoDB Cloud 为您管理。如果 MongoDB Cloud 管理证书，它还会管理证书颁发机构，并可以为数据库用户生成证书。无需额外的 X.509 配置。如果管理证书，则必须提供证书颁发机构并为数据库用户生成证书。

自管理 X.509 证书

返回分配给一个 MongoDB 用户的所有 X.509 证书

返回指定 MongoDB 用户的所有未过期的 X.509 证书。此 MongoDB 用户属于一个项目。Atlas 管理这些证书和 MongoDB 用户。要使用此资源，请求的 API 密钥必须具有“项目只读”角色。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

用户名
必需
字符串

人类可读标签，表示要返回其证书的 MongoDB 数据库用户帐户。

查询参数
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/json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

为一位 MongoDB 用户创建一个 X.509 证书

为指定的 MongoDB 用户生成一个 X.509 证书。Atlas 管理属于一个项目的证书和 MongoDB 用户。要使用此资源，请求的 API 密钥必须具有“项目所有者”角色。

要让 MongoDB Cloud 为数据库用户生成托管证书，请在所需的 MongoDB 数据库用户上设置 "x509Type" : "MANAGED"。

如果在自管理 X.509 模式下管理自己的证书颁发机构 (CA)，则必须使用自己的 CA 为数据库用户生成证书。

自管理 X.509
授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

用户名
必需
字符串

人类可读标签，表示要为其创建证书的 MongoDB 数据库用户帐户。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

pretty
布尔
默认： false
示例： pretty=false

指示响应正文是否应采用 prettyprint 格式的标记。

请求正文模式：application/json

为指定 MongoDB 用户生成一个 X.509 证书。

monthsUntilExpiration
整型 <int32> <= 24
默认： 3

证书在过期之前保持有效的月数。

响应

请求样本

内容类型
application/json
{
  • "monthsUntilExpiration": 3
}

响应样本

内容类型
application/json
"string"

禁用客户托管的 X.509

清除项目上的客户管理 X.509 设置，包括上传的证书颁发机构，这会禁用自管理 X.509。

更新此配置会触发滚动重启数据库。您必须具有“项目所有者”角色才能使用此端点。

授权：
DigestAuth服务账户
路径参数
groupId
必需
字符串 = 24 个字符 ^([a-f0-9]{24})$
示例： 32b6e34b3d91647abb20e7b8

标识项目的唯一 24 位十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户有权访问的所有项目。

注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

查询参数
envelope
布尔
默认： false
示例： envelope=false

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

响应

响应样本

内容类型
application/json
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}