获取一个组织 API 密钥的所有访问列表条目
MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。 尽快升级到更高的MongoDB Ops Manager版本。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
检索指定 API密钥的所有访问权限列表条目的信息。
Resource
GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList
请求路径参数
名称 | 类型 | 说明 |
---|---|---|
ORG-ID | 字符串 | |
API-KEY-ID | 字符串 |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 说明 | 默认 | ||||
---|---|---|---|---|---|---|---|
pageNum | 整型 | 页码(从 1 开始)。 | 1 | ||||
itemsPerPage | 整型 | 每页要返回的项目数,最多 500 个。 | 100 | ||||
pretty | 布尔 | 指示响应正文是否应采用 prettyprint 格式。 | false | ||||
envelope | 布尔 | 指示是否要将响应封装在信封中。 某些API客户端无法访问HTTP响应标头或状态代码。 要修复此问题,请在查询中设置 对于返回一个结果的终结点,响应体包括:
对于返回结果列表的端点, | 无 |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应文档
响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。
名称 | 类型 | 说明 |
---|---|---|
results | 阵列 | 数组为 results 嵌入式文档部分中详细介绍的每一项包含一个对象。 |
links | 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
totalCount | 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页,则它可能大于results数组中的对象数。 |
results
嵌入式文档
每个结果都是一个访问列表条目。
名称 | 类型 | 说明 |
---|---|---|
cidrBlock | 字符串 | 访问列表中以 CIDR 表示的 IP 地址范围。 |
count | 数字 | 源自此 IP 地址的请求总数。 |
created | 日期 | 将此 IP 地址添加到访问列表的日期。 |
ipAddress | 字符串 | 访问列表中的 IP 地址。 |
lastUsed | 日期 | 源自此 IP 地址的最近一次请求的日期。 仅当至少有一个请求源自此 IP 地址时,此字段才会出现,并且仅在从访问列表检索资源时才会更新。 |
lastUsedAddress | 字符串 | 上次调用 API 的 IP 地址。 仅当至少有一个请求源自此 IP 地址时,才会显示此字段。 |
links | 阵列 |
请求示例
curl --user "{USERNAME}:{APIKEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/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}
响应体
1 { 2 "links" : [ { 3 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/599c510c80eef518f3b63fe1/apiKeys/5c49e72980eef544a218f8f8/accessList/?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 } ], 6 "results" : [ { 7 "cidrBlock" : "147.58.184.16/32", 8 "count" : 0, 9 "created" : "2019-01-24T16:34:57Z", 10 "ipAddress" : "147.58.184.16", 11 "lastUsed" : "2019-01-24T20:18:25Z", 12 "lastUsedAddress": "147.58.184.16", 13 "links" : [ { 14 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/147.58.184.16", 15 "rel" : "self" 16 } ] 17 }, { 18 "cidrBlock" : "84.255.48.125/32", 19 "count" : 0, 20 "created" : "2019-01-24T16:26:37Z", 21 "ipAddress" : null, 22 "lastUsed" : "2019-01-24T20:18:25Z", 23 "lastUsedAddress": "84.255.48.125", 24 "links" : [ { 25 "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/206.252.195.126", 26 "rel" : "self" 27 } ] 28 } ], 29 "totalCount" : 2 30 }