获取全局 API 密钥的所有访问列表条目
MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。 尽快升级到更高的MongoDB Ops Manager版本。
返回 Ops Manager 的所有全局访问列表条目。
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/accessList
所需角色
要求调用此端点的 API密钥具有 Global Read Only角色。
请求参数
请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数，用于返回结果的一部分。 | 1 |
itemsPerPage | 数字 | Optional | 每页要返回的项目数，最多 500 个。 | 100 |
pretty | 布尔 | Optional | 指示响应正文是否应采用 prettyprint 格式 的标志 格式。 | false |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些API客户端无法访问HTTP响应标头或状态代码。 要修复此问题，请在查询中设置 对于返回结果列表的端点， | false |
backupJobsEnabledOnly | 布尔 | Optional | 指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为 false以包含将backupJobsEnabled标志设置为false的守护进程配置。 | true |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应文档
响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。
名称 | 类型 | 说明 |
|---|---|---|
results | 阵列 | 数组为 results嵌入式文档部分中详细介绍的每一项包含一个对象。 |
links | 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
totalCount | 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页，则它可能大于results数组中的对象数。 |
results 嵌入式文档
每个结果都是一个全局访问列表条目。
名称 | 类型 | 说明 |
|---|---|---|
cidrBlock | 字符串 | 访问列表中的 IP 地址范围（采用IPv4或IPv6 CIDR表示法）。 |
created | 字符串 | 时间戳，以自 UNIX 纪元 以来经过的秒数表示 当您将此 CIDR 区块添加到全局访问列表中时。 |
description | 字符串 | 解释此全局访问列表条目的用途。 |
id | 字符串 | 此全局访问列表条目的唯一标识符。 |
type | 字符串 | 全局访问列表条目的范围。 |
updated | 字符串 | 时间戳，以自 UNIX 纪元 以来经过的秒数表示 您上次更改此全局访问列表条目的 CIDR 区块的时间。 |
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/accessList?pretty=true"
响应示例
响应标头
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
响应体
{ "results" : [ { "cidrBlock" : "251.207.34.78/32", "created" : "2019-09-05T04:02:46Z", "description" : "Test Global Access List Entry 1", "id" : "5d4d7b9cf20ce440466a30bd", "type" : "GLOBAL_ROLE", "updated" : "2019-09-05T04:02:46Z" }, { "cidrBlock" : "2001:db8::/48", "created" : "2019-09-05T04:02:46Z", "description" : "Test Global Access List Entry 2", "id" : "5d6fe33787d9d6689b3427ec", "type" : "GLOBAL_ROLE", "updated" : "2019-09-05T04:02:46Z" } ] "totalCount" : 2 }