Docs 菜单
Docs 主页
/
MongoDB Atlas
/
Atlas CLI
/
管理 Atlas

从Atlas CLI使用Atlas API

Atlas CLI提供了 api 子命令，您可以使用该API命令直接从Atlas CLI访问权限每个Atlas端点。 此功能可让您以稳健可靠的方式使用Atlas API的各项功能。 它提供对整个Atlas管理API 的访问权限，以便您可以脚本或自动执行任何任务，并享受使用命令行界面带来的好处：

  • 与Atlas的完整功能对等。

  • 更快地访问权限新的Atlas API资源和端点。

  • 统一、可预测的自动化命令结构。

  • 能够固定所需的API版本，确保您的脚本即使更新CLI也保持可靠。

  • 能够监视命令，直到操作完成。

本教程演示如何通过Atlas CLI命令使用Atlas API 。

注意

API命令是从Atlas API自动生成的，并提供对整个Atlas API （包括预览资源）的访问权限。您必须对Atlas Management API有一定的了解，并且了解默认输入和输出是API媒体类型的直接映射，才能从该Atlas CLI功能中受益。

语法

要将Atlas CLI与Atlas API结合使用，请按以下格式运行命令：

atlas api <tag> <operationId> [options]|--file <fileName>.json --version <api-resource-version>

参数

Argument
必要性
说明

<tag>

必需

API资源的Atlas API文档URL中使用的标签名称。该标签在Atlas管理API文档URL中用连字符分隔。但是，您必须在Atlas CLI命令语法中将其转换为 camelcase。

示例，考虑Atlas Administration API资源的以下URL ：

https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#tag/Example-Tag-Name/

要访问上述URL中的资源，请将命令语法中的 <tag> 替换为 exampleTagName：

atlas api exampleTagName <operationId>

有关更多示例，请参阅 示例。

<operationId>

必需

API端点的Atlas API文档URL中的操作标识符。格式为驼峰命名。

示例，对于Atlas API端点操作，请考虑以下URL ：

https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#tag/Example-Tag-Name/operation/exampleEndpointOperationId

要执行上述URL中端点支持的操作，请将 <tag> 替换为 exampleTagName 并使用操作ID exampleEndpointOperationId，如命令所示。

atlas api exampleTagName exampleEndpointOperationId [options]

有关更多示例，请参阅示例。

选项

您可以将API路径、查询和请求正文参数作为选项传递给命令。您可以直接使用命令或使用JSON文件指定选项。该命令还支持以下选项：

选项
必要性
说明

--file

可选的

JSON文件，其中包含操作的API路径、查询和请求正文参数。仅当您未直接使用命令指定的操作有必需的路径、查询或请求正文参数时，才需要执行此操作。

--version

Optional

要使用的API资源版本。我们建议使用它将脚本固定到特定的API版本。如果省略，该命令默认使用最新版本（或配置文件的配置版本）。但是，我们建议明确设置版本，以确保脚本保持稳定。当发布可能包含不兼容更改的新API版本时，这可以保护您的脚本免受破坏。

--watch

Optional

该标志指定是否监视操作直至其完成。

示例

以下Atlas CLI命令使用Atlas Administration API演示了如何检索压缩 (.gz)日志文件，其中包含指定项目的指定托管的范围日志消息：

atlas api monitoringAndLogs getHostLogs --groupId 5e2211c17a3e5a48f5497de3 --hostName mycluster-shard-00-02.7hgjn.mongodb.net --logName mongodb --output gzip --version 2025-03-12

以下Atlas CLI命令与Atlas Administration API演示了如何使用 --file 选项创建集群。

atlas api clusters createCluster --groupId 5e2211c17a3e5a48f5497de3 --file cluster-config.json --version 2025-03-12

要学习；了解有关为集群创建配置文件的更多信息，请参阅集群配置文件。

以下带有Atlas管理API 的Atlas CLI命令演示了如何模拟区域云提供商中断。 这种模拟可让您在与生产分开的受控环境中测试应用程序的故障转移行为和灾难恢复过程。该命令使用名为 outage_simulation.json 的文件，其中包含以下设置：

{
   "outageFilters": [
      {
         "cloudProvider": "AWS",
         "regionName": "US_EAST_1",
         "type": "REGION"
      }
   ]
}
atlas api clusterOutageSimulation startOutageSimulation --groupId 5e2211c17a3e5a48f5497de3 --clusterName myCluster --file outage_simulation.json --version 2025-03-12
{"clusterName":"myCluster","groupId":"5e2211c17a3e5a48f5497de3","id":"6808ed9bed0b0b51caee336b","outageFilters":[{"cloudProvider":"AWS","regionName":"US_EAST_1","type":"REGION"}],"startRequestDate":"2025-04-23T13:39:39Z","state":"START_REQUESTED"}

后退

使用 Docker 运行命令

来年

参考

在此页面上