获取全局 API 密钥的所有访问列表条目

返回 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	指示响应正文是否应采用美观打印格式的标志。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 `envelope : true`。对于返回结果列表的端点， `content`对象是一个信封。 Ops Manager 将`status`字段添加到响应正文。	`false`

请求正文参数

此端点不使用 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"

响应示例

响应标头

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}

响应体

{  "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}