对于 AI 代理:可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。
Docs 菜单

atlas api rateLimiting listRateLimits

获取所有 v2 Atlas 管理 API 终结点集的所有速率限制。

atlas api 子命令是从 MongoDB Atlas Admin API 自动生成的,并提供对 Admin API 的全面覆盖。Admin API功能有自己的发布生命周期,您可以通过提供的API终结点文档链接进行检查。

此命令是自动生成的,对应 1:1 和Atlas API终结点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2/operation/operation-listratelimits

有关更多信息和示例,请参阅上面链接的参考API文档。

命令语法
atlas api rateLimiting listRateLimits [options]
名称
类型
必需
说明

--endpointPath

/rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F

false

按提供的终结点路径筛选返回的终结点集。可以提供多个路径,示例/rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F.将 /{} 替换为其URL编码值(分别为 %2F%7B%7D)。

--envelope

envelope

false

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

--groupId

字符串

false

唯一的 24-十六进制数字字符串,用于标识要请求速率限制的Atlas项目。提供此参数时,仅返回群组范围的终结点集,并且返回的限制适用于指定项目。请求用户必须具有指定项目的“项目只读”角色。

-h,--help

false

listRateLimits 帮助

--ipAddress

字符串

false

要请求速率限制的IP解决。提供此参数时,仅返回IP范围的终结点集,并且返回的限制适用于指定的IP解决。请求用户的 IP 地址必须与请求中提供的IP解决相同。

--itemsPerPage

int

false

响应每页返回的列项数。

--name

/rateLimits?name=Name1&name=Name2

false

按提供的终结点设置名称筛选返回的终结点集。可以提供多个名称,示例/rateLimits?name=Name1&name=Name2。对于使用空格的名称,将空格替换为其URL编码值 (%20)。

--orgId

字符串

false

唯一的 24-十六进制数字字符串,用于标识要请求速率限制的Atlas组织。提供此参数时,仅返回组织范围的终结点集,并且返回的限制适用于指定的组织。请求用户必须具有指定组织的“组织只读”角色。

-o, --output

字符串

false

首选API格式,可以是 ["JSON", go-template] 此值默认为 "JSON"。

--outputFile

字符串

false

要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志

--pageNum

int

false

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

--pretty

false

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

--userId

字符串

false

一个字符串,用于标识要请求速率限制的Atlas 用户。示例,该ID可以是服务帐户客户端ID或API公钥。提供此参数时,仅返回用户范围的终结点集,并且返回的限制适用于指定用户。请求用户必须与指定用户相同。

--version

字符串

false

进行 api 调用时要使用的 api 版本 [选项: "2025-03-12", "preview"],默认为最新版本或配置文件 api_version 配置值,如果设立了此值,则默认为 "preview" ”。

名称
类型
必需
说明

-P, --profile

字符串

false

要从您的配置文件中使用的配置文件的名称。要学习;了解Atlas CLI配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

atlas api rateLimiting listRateLimits --version preview --endpointPath /api/atlas/v2/clusters --groupId 32b6e34b3d91647abb20e7b8 --ipAddress 127.0.0.1 --name Rate Limits Inspection --orgId 32b6e34b3d91647abb20e7b8 --userId mdb_sa_id_1234567890abcdef12345678