创建一个全局访问列表条目

在此页面上

Resource

所需角色
请求参数
请求路径参数
请求查询参数
请求正文参数
响应
请求示例
响应示例
响应标头
响应体

为 Ops Manager 创建一个全局访问列表条目。

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

Resource

POST /admin/accessList

所需角色

要求调用此端点的 API密钥具有 Global Owner角色。

请求参数

请求路径参数

此端点不使用 HTTP 请求路径参数。

请求查询参数

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

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用 Prettyprint 的标志格式。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称	说明
`status`	HTTP 响应代码
`content`	预期响应正文

false

请求正文参数

指定一个文档来表示要添加的一个访问列表条目。

当您提交的请求包含访问列表中尚未存在的POST cidrBlock值时，Ops Manager 会将这些条目添加到访问列表的现有条目列表中。Ops Manager 不会将访问列表设置为仅包含请求中指定的条目。

名称	类型	必要性	说明
`description`	字符串	必需	全局访问列表条目的描述。长度必须介于 1 到 250 个字符之间。
`cidrBlock`	字符串	必需	要添加的以IPv4或IPv6 CIDR表示法表示的访问列表条目。

响应

名称	类型	说明
`cidrBlock`	字符串	访问列表中的 IP 地址范围（采用IPv4或IPv6 CIDR表示法）。
`created`	字符串	时间戳，以自 UNIX 纪元以来经过的秒数表示当您将此 CIDR 区块添加到全局访问列表中时。
`description`	字符串	解释此全局访问列表条目的用途。
`id`	字符串	此全局访问列表条目的唯一标识符。
`type`	字符串	全局访问列表条目的范围。
`updated`	字符串	时间戳，以自 UNIX 纪元以来经过的秒数表示您上次更改此全局访问列表条目的 CIDR 区块的时间。

请求示例

1 curl --user '{USER-ID}:{API-KEY}' --digest \
2 --header 'Accept: application/json' \
3 --header 'Content-Type: application/json' \
4 --include \
5 --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/accessList?pretty=true" \
6 --data '
7   {
8     "cidrBlock"  : "127.0.0.1/32",
9     "description" : "Docs Example"
10   }'

响应示例

响应标头

HTTP/1.1 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

HTTP/1.1 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   "cidrBlock" : "127.0.0.1/32",
3   "created" : "2019-09-04T17:45:33Z",
4   "description" : "Docs Example",
5   "expires" : null,
6   "id" : "5d6ff83dff4ab7133648b584",
7   "lastUsed" : null,
8   "type" : "GLOBAL_ROLE",
9   "updated" : "2019-09-04T17:45:33Z"
10 }

后退

获取一个条目

来年

更新条目

1	curl --user '{USER-ID}:{API-KEY}' --digest \
2	--header 'Accept: application/json' \
3	--header 'Content-Type: application/json' \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/accessList?pretty=true" \
6	--data '
7	{
8	"cidrBlock" : "127.0.0.1/32",
9	"description" : "Docs Example"
10	}'

1	{
2	"cidrBlock" : "127.0.0.1/32",
3	"created" : "2019-09-04T17:45:33Z",
4	"description" : "Docs Example",
5	"expires" : null,
6	"id" : "5d6ff83dff4ab7133648b584",
7	"lastUsed" : null,
8	"type" : "GLOBAL_ROLE",
9	"updated" : "2019-09-04T17:45:33Z"
10	}