为一个组织 API 密钥获取一个访问列表条目

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

使用 API 密钥的唯一标识符和所需的 IP 地址检索有关单个 API 密钥访问列表条目的信息。

Resource

GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/{ACCESS-LIST-ENTRY}

请求路径参数

名称	类型	说明
`ORG-ID`	字符串	目标 API 密钥所属组织的唯一标识符。请求/orgs端点检索经过身份验证的用户有权访问的所有组织。
`API-KEY-ID`	字符串	要为其检索访问列表条目的 API 密钥的唯一标识符。请求 /orgs/{ORG-ID}/apiKeys 终结点，以检索针对经过身份验证的用户可以访问的指定组织的所有 API 密钥。
`ACCESS-LIST-ENTRY`	字符串	IP 或 CIDR 地址。如果条目包含子网掩码，例如 `192.0.2.0/24`，则对正斜杠 `/` 使用 URL 编码值 `%2F`。

请求查询参数

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

名称	类型	说明	默认
pageNum	整型	页码（从 1 开始）。	`1`
itemsPerPage	整型	每页要返回的项目数，最多 500 个。	`100`
pretty	布尔	指示显示正文是否应采用 prettyprint 格式。	`false`
envelope	布尔	指示是否要将响应封装在信封中。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 `"envelope" : true`。对于返回一个结果的终结点，响应体包括： `status`: HTTP 响应代码 `content`：预期响应正文对于返回结果列表的端点， `results`对象是一个信封。 Ops Manager 将`status`字段添加到响应正文。	无

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

名称	类型	说明
`cidrBlock`	字符串	访问列表中以 CIDR 表示的 IP 地址范围。
`count`	数字	源自此 IP 地址的请求总数。
`created`	日期	将此 IP 地址添加到访问列表的日期。
`ipAddress`	字符串	访问列表中的 IP 地址。
`lastUsed`	日期	源自此 IP 地址的最近一次请求的日期。仅当至少有一个请求源自此 IP 地址时，此字段才会出现，并且仅在从访问列表检索资源时才会更新。
`lastUsedAddress`	字符串	上次调用 API 的 IP 地址。仅当至少有一个请求源自此 IP 地址时，才会显示此字段。
`links`	阵列	文档数组，表示一个或多个子资源和/或相关资源（例如列表分页）的链接。有关详细信息，请参阅链接。

请求示例

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2  --header "Accept: application/json" \3  --header "Content-Type: application/json" \4  --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24?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}

响应体

1{2    "cidrBlock": "192.0.2.0/24",3    "count": 0,4    "created": "2019-11-01T14:32:57Z",5    "links": [6        {7            "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24",8            "rel": "self"9        },10        {11            "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",12            "rel": "http://mms.mongodb.com/apiKeys"13        }14    ]15}