API
在此页面上
MongoDB Atlas for Government API的运行方式与 Atlas API相同,不同之处在于它使用以下基本 URL:
https://cloud.mongodbgov.com/api/atlas/v2
AtlasGov SHA-256
使用 HTTP 摘要 式身份验证通过 对 API 请求进行身份验证。
使用示例
此curl
示例检索项目的数据库用户:
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ # update date to desired API version --include \ --request GET "https://cloud.mongodbgov.com/api/atlas/v2/groups/{PROJECT-ID}/databaseUsers?pretty=true"
您可以在
PROJECT-ID
中找到Project Settings 。您可以在组织的Access Manager中的API Keys标签页下生成API密钥对。
请参阅 Atlas 文档
要了解有关使用API的更多信息,请参阅Atlas API。
要配置 API,请参阅配置 Atlas API 访问权限。
有关可能错误的列表,请参阅Atlas API 错误代码。
创建项目
您必须在创建时指定用于标准或政府 (gov
) 地区的项目。您不能在同一项目中跨政府和标准地区部署集群。
默认情况下,AtlasGov API 会指定用于标准地区的新项目。
要使用 API 为政府地区创建项目,请在POST
请求数据中包含以下内容:
"regionUsageRestrictions" : "GOV_REGIONS_ONLY"
Atlas for Government 注意事项
以下云提供商、MongoDB 产品和功能不适用于所有API资源:
AZURE
Atlas Data Lake
Atlas Online Archive
Atlas Triggers
MongoDB Charts
Atlas Device SDKs
免费、共享、Flex 和
M10
集群
许多商业 Atlas API资源都是有限的或不可用的:
数据库用户
使用SCRAM进行身份验证的数据库用户必须使用SCRAM-SHA-256
。
集群
AtlasGov 集群必须为 M20
或更高层级。 Atlas不支持免费、灵活和共享集群。
警报
与付款方式相关的警报不可用。
警报可以来自多个不同的电子邮件地址。 有关详细信息,请参阅警报和通信。
第三方集成设置
您必须具有Project Owner
角色才能配置第三方监控集成。
Datadog
与 Datadog 集成时,AtlasGov 使用 Datadog for 政府 站点 (US1-FED)。
要了解有关 US1 -FED 的更多信息,请参阅 Datadog 文档。
云备份
不允许在标准项目和仅限 Gov 地区的项目之间进行恢复。 如果从仅限 Gov 区域( Amazon Web Services GovCloud 或GCP有保证的工作负载)项目中的集群创建备份,则数据只能恢复到仅限 Gov 区域的项目中的集群。 同样的限制也适用于标准项目,即标准区域中的备份只能恢复到标准项目中的集群。
Amazon Web Services GovCloud 和GCP Assured Workloads 区域之间支持跨云恢复。
Flex 和共享集群Atlas 备份快照和恢复作业
Flex 和共享集群在 AtlasGov 中不可用。
Online Archive
在线存档在 AtlasGov 中不可用。
网络对等
您只能将 Amazon Web Services GovCloud 地区与 Amazon Web Services GovCloud 地区中的 MongoDB 集群对等互连。您只能对等互连 Amazon Web Services 标准地区与位于 Amazon Web Services 标准地区中的 MongoDB 集群。
您只能对等GCP Assured Workloads 区域与GCP Assured Workloads 区域中的MongoDB集群。
私有端点
您只能将 Amazon Web Services GovCloud 地区与 Amazon Web Services GovCloud 地区中的 MongoDB 集群关联。您只能将 AWS 标准区域与 AWS 标准区域中的 MongoDB 集群关联。
您只能将GCP Assured Workloads 区域与GCP Assured Workloads 区域中的MongoDB集群关联。
监控和日志
除了标准 Atlas 日志记录之外,AtlasGov 还记录与所有失败的登录尝试、临时锁定和失败的API摘要式身份验证相关的用户名和 IP 地址。
使用客户密钥管理进行静态加密
您必须在KMS Amazon Web ServicesGovCloud 和GCP Assured Workloads 区域中使用 密钥,以加密仅Amazon Web Services GovCloud 和GCP Assured Workloads 区域项目中的数据。您必须在KMS Amazon Web ServicesStandard 区域中使用 密钥来加密仅限Amazon Web Services Standard 区域的项目中的数据。
Atlas 用户
您无法为政府用户创建 MongoDB Atlas。 MongoDB Atlas for Government 仅可通过受邀会员使用。
Atlas Stream Processing
Atlas Stream Processing 在 AtlasGov 中不可用。
Triggers
Atlas Triggers 在 AtlasGov 中不可用。