使用“atlas api”命令，通过Atlas CLI访问Atlas Administration API的所有功能。<tag><operationId>
此功能允许您通过Atlas CLI直接与任何Atlas Administration API端点交互，从而简化了脚本开发。
有关Atlas Administration API的详情，请参阅： https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2 / - 开始使用Atlas Administration API：https ://www.mongodb.com/zh-cn/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access
atlas api 子命令是从MongoDB Atlas Admin API自动生成的，并提供对 Admin API的全面覆盖。 Admin API功能有自己的发布生命周期，您可以通过提供的API端点文档链接进行检查。
语法
atlas api <tag> <operationId> [options]
重要
<tag> 和 <operationId> 都必须采用驼峰命名法。
参数
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
<tag> | 字符串 | true | Atlas Administration API操作的类别，采用 camelCase 格式。要查找并格式化标签，请查看端点的API文档URL 。它显示在 示例，在 |
<operationId> | 字符串 | true | Atlas Administration API端点的标识符，采用驼峰命名法。要查找 operationId，请检查端点的API文档URL 。它出现在 示例，在 |
子命令选项
将Atlas Administration API端点的路径和查询参数作为标志传入。示例，如果端点为 /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}，则Atlas CLI命令为：
atlas api <tag> <operationId> --orgId <ORG_ID> --invoiceId <INVOICE_ID>
注意
您通常不需要指定 --orgId 和 --projectId，因为它们源自您的配置文件。仅当您的配置文件中未设立这些内容时才指定它们。
如果适用于端点，请使用 --file 选项或标准输入 (stdin) 传入请求正文。示例：
atlas api clusters create --file cluster-config.json
此外，以下选项可用于所有Atlas Administration API端点。
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
| 字符串 | false | 指定命令的Atlas Administration API版本。默认为最新API版本或您在配置文件中为 |
| 字符串 | false | 输出格式。默认值为
要确定端点支持的格式，请执行以下操作：
|
| 字符串 | false | 保存输出的文件路径。默认下，结果显示在终端中。 |
| 字符串 | false | 请求正文内容的文件路径（如果操作需要）。或者，通过标准输入 ( |
| 布尔 | false | 当前命令的帮助。 |
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-h，--help | false | API帮助 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
相关命令
atlas api accessTracking - 返回对Atlas数据库部署进行的身份验证尝试的访问权限日志。
atlas api alertConfigurations - 返回并编辑触发警报的条件以及MongoDB Cloud 通知用户的方式。
atlas api alerts — 返回并确认MongoDB Cloud 根据您定义的警报条件触发的警报。
atlas api atlasSearch — 返回、添加、编辑和删除指定集群的Atlas Search索引。
atlas api auditing — 返回并编辑MongoDB Cloud 项目的数据库审核设置。
atlas api awsClustersDns — 返回并编辑 AWS 上MongoDB Cloud数据库部署的自定义 DNS 配置。
atlas api cloudBackups - 管理云备份快照、快照存储桶、恢复作业和计划。
atlas api cloudMigrationService — 管理云迁移服务。
atlas api cloudProviderAccess - 返回、添加、授权和删除Atlas中的 AWS IAM 角色。
atlas api clusterOutageSimulation - 返回、开始或结束集群中断模拟。
atlas api clusters — 返回、添加、编辑和删除数据库部署。
atlas api collectionLevelMetrics - 返回、添加和编辑指定集群或进程的固定命名空间。
atlas api customDatabaseRoles — 返回、添加、编辑和删除自定义数据库用户权限角色。
atlas api dataFederation — 返回、添加、编辑和删除联合数据库实例。
atlas api databaseUsers — 返回、添加、编辑和删除数据库用户。
atlas api encryptionAtRestUsingCustomerKeyManagement - 返回并编辑使用客户数密钥管理配置的静态加密。
atlas api events — 返回事件。
atlas api federatedAuthentication - 返回、添加、编辑和删除与联合相关的功能，例如角色映射和连接的组织配置。
atlas api FlexClusters — 返回、添加、编辑和删除 Flex 集群。
atlas api FlexRestoreJobs — 返回并添加 Flex数据库部署的恢复作业。
atlas api FlexSnapshots — 返回并请求下载Flex数据库部署快照。
atlas api globalClusters — 返回、添加和删除全球集群托管的命名空间和自定义区域映射。
atlas apivoices — 返回发票。
atlas api ldapConfiguration — 返回、编辑、验证和删除LDAP配置。
atlas apilegacyBackup — 管理传统备份快照、恢复作业、计划和检查点。
atlas api MaintenanceWindows - 返回、编辑和删除维护窗口。
atlas api mongoDbCloudUsers — 返回、添加和编辑MongoDB Cloud 用户。
atlas api MonitoringAndLogs - 返回数据库部署监控和日志记录数据。
atlas api networkPeering - 返回、添加、编辑和删除网络对等互连容器和对等连接。
atlas api onlineArchive — 返回、添加、编辑或删除在线存档。
atlas api organizations — 在MongoDB Cloud 中返回、添加和编辑组织单位。
atlas api performanceAdvisor — 返回数据库部署的建议索引和慢速查询数据。
atlas api privateEndpointServices — 返回、添加、编辑和删除私有端点服务。
atlas api ProgrammaticApiKeys — 返回、添加、编辑和删除访问权限令牌以使用MongoDB Cloud API。
atlas api projectIpAccessList - 返回、添加、编辑和删除对Atlas中数据库部署的网络访问权限限制。
atlas api projects — 返回、添加和编辑MongoDB Cloud 中的集群和用户集合。
atlas api pushBasedLogExport — 您可以持续将日志从mongod、 mongos和Atlas 审核日志推送到 AWS S3 存储桶。
atlas api resourcesPolicies — 在组织内配置和管理Atlas资源策略。
atlas apirollingIndex — 以滚动方式为数据库部署创建一个索引。
atlas api root — 返回描述MongoDB Cloud构建以及请求此资源的访问权限令牌的详细信息。
atlas api serviceAccounts - 用于管理服务帐户和密钥的端点。
atlas api SharedTierRestoreJobs — 返回并添加共享层数据库部署的恢复作业。
atlas api SharedTierSnapshots — 返回并请求下载共享层数据库部署快照。
atlas api streams — 返回、添加、编辑和删除流实例。
atlas apiteams — 返回、添加、编辑或删除团队。
atlas api ThirdPartyIntegrations — 返回、添加、编辑和删除第三方服务集成配置。
atlas api x509 身份验证 - 返回、编辑和删除用户管理的 X.509 配置。