atlas api rateLimiting getRateLimit

--endpointSetId

字符串

true

速率限制终结点设立的ID。

--envelope

envelope

false

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

--groupId

字符串

false

唯一的 24-十六进制数字字符串，用于标识要请求速率限制的Atlas项目。提供此参数时，返回的限制适用于指定的项目。请求用户必须具有指定项目的“项目只读”角色。

-h，--help

false

getRateLimit 帮助

--ipAddress

字符串

false

要请求速率限制的IP解决。提供此参数时，返回的限制适用于指定的IP解决。请求用户的 IP 地址必须与请求中提供的IP解决相同。

--orgId

字符串

false

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

-o, --output

字符串

false

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

--outputFile

字符串

false

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

--pretty

false

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

--userId

字符串

false

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

--version

字符串

false

调用 Atlas API 终结点时要使用的 API 版本 [选项："2025-03-12"]。如果用户未设置，则默认为最新版本，或者如果已设置了配置文件的 api_version 值，则默认为该值。此值默认为 "2025-03-12"。