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

获取全局 API 密钥的所有角色

返回全局API密钥的可接受全局角色列表。

基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /admin/apiKeys/roles

要求调用此终结点的 API 密钥具有 Global Read Only 角色。

此端点不使用 HTTP 请求路径参数。

以下查询参数为可选参数:

名称
类型
说明
默认

pageNum

整型

页码(从 1 开始)。

1

itemsPerPage

整型

每页要返回的项目数,最多 500 个。

100

pretty

布尔

指示显示正文是否应采用 prettyprint 格式。

false

envelope

布尔

指示是否要将响应封装在信封中。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 "envelope" : true。

对于返回一个结果的终结点,响应体包括:

  • status: HTTP 响应代码

  • content:预期响应正文

对于返回结果列表的端点, results对象是一个信封。 Ops Manager 将status字段添加到响应正文。

无

返回全局API密钥的所有可接受的全局角色的数组。

注意

发出请求的用户可以采用{PUBLIC-KEY}:{PRIVATE-KEY}格式。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/roles?pretty=true"
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{ [ "GLOBAL_BACKUP_ADMIN", "GLOBAL_BILLING_ADMIN", "GLOBAL_MONITORING_ADMIN", "GLOBAL_READ_ONLY", "GLOBAL_AUTOMATION_ADMIN", "GLOBAL_USER_ADMIN" ]}