获取当前用户的访问列表
2024 年 8 月 30 日以后,Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。
基本 URL: https://cloud.mongodb.com/api/public/v 1.0
Resource
GET /users/{USER-ID}/accessList
请求路径参数
Parameter | 类型 | 说明 |
---|---|---|
用户 ID | 字符串 | (必需。) 用户 当前用户的唯一标识符。 要检索当前用户的ID ,请参阅获取一个项目中的所有用户。 |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 |
---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数,用于返回结果的一部分。 | 1 |
itemsPerPage | 数字 | Optional | 每页要返回的项目数,最多 500 个。 | 100 |
pretty | 布尔 | Optional | 指示响应正文是否应采用 美观打印 的标志 格式。 | 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 | 字符串 | 以 CIDR 表示的 IP 地址范围。 |
created | 日期 | 将此 IP 地址添加到访问列表的日期。 |
ipAddress | 字符串 | 访问列表中的 IP 地址。 |
lastUsed | 日期 | The date of the most recent request that originated from this IP address. 请注意,仅当访问受访问列表保护的资源时,才会更新此字段。 |
lastUsedAddress | 字符串 | 上次调用 API 的地址。 |
count | 数字 | 源自此 IP 地址的请求总数。 请注意,仅当访问受访问列表保护的资源时,才会更新此字段。 |
links | 阵列 | 相关子资源链接。 响应中的所有链接数组至少包含一个名为 self 的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/accessList"
响应示例
响应标头
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" : "5.6.7.8/30", "count" : 482, "created" : "2014-04-23T16:17:44Z", "lastUsed" : "2016-04-19T14:15:52Z", "lastUsedAddress" : "5.6.7.7", "links" : [] }, { "cidrBlock" : "1.2.3.4/32", "count" : 9, "created" : "2016-02-19T14:46:14Z", "ipAddress" : "1.2.3.4", "lastUsed" : "2016-04-25T15:42:50Z", "lastUsedAddress" : "1.2.3.4", "links" : [] } ], "totalCount" : 2, "links" : [] }