获取 IP 地址的访问列表
MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。 尽快升级到更高的MongoDB Ops Manager版本。
如果 IP-ADDRESS
的值等于实体的ipAddress
字段的值,则检索访问列表实体。 这不会检索IP-ADDRESS
值包含在cidrBlock
字段允许的值范围内的对象。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /users/{USER-ID}/accessList/{ACCESS-LIST-ENTRY}
请求路径参数
Parameter | 类型 | 说明 |
---|---|---|
用户 ID | 字符串 | (必需。) 当前用户的唯一标识符。 要检索当前用户的ID ,请参阅获取一个项目中的所有用户。 |
ACCESS-LIST-ENTRY | 字符串 | IP 或 CIDR地址。 如果条目包含子网掩码,例如 192.0.2.0/24 ,则使用 URL 编码值%2F 作为正斜杠/ 。 |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。 对于返回一个结果的端点,响应体包括:
| false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
名称 | 类型 | 说明 |
---|---|---|
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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/users/{USER-ID}/accessList/192.0.2.0%2F24"
响应示例
响应标头
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}
响应体
{ "links": [ { "href": "https://<ops-manager-host>/api/public/v1.0/users/{USER-ID}/accessList/?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "cidrBlock": "192.0.2.0/24", "count": 0, "created": "2019-11-01T15:18:12Z", "links": [ { "href": "https://<ops-manager-host>/api/public/v1.0/users/{USER-ID}/accessList/192.0.2.0%2F24", "rel": "self" } ] }, ], "totalCount": 1 }