对于 AI 代理:可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。
See how MongoDB 9.0 delivers up to 2x higher throughput.
MongoDB Branding Shape
Register now >
Docs 菜单

检索所有功能策略

基本 URL: https://cloud.mongodb.com/api/public/v1.0

此资源需要任何经过身份验证的用户或 API 密钥。

GET /groups/availablePolicies

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

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

名称
类型
说明
默认

pageNum

整型

页码(从 1 开始)。

1

itemsPerPage

整型

每页要返回的项目数,最多 500 个。

100

pretty

布尔

指示是否以美观打印格式返回响应正文。

false

envelope

布尔

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

某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题,请在查询中设立"envelope" : true。

对于返回一个结果的终结点,响应体包括:

  • status: HTTP响应代码

  • content:预期响应正文

对于返回结果列表的端点,results 对象是一个信封。Cloud Manager 将 status 字段添加到响应正文。

无

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

名称
类型
说明

_id

字符串

此策略适用的项目的唯一标识符。

created

字符串

创建此功能控制策略时采用 ISO 8601 日期和时间格式(UTC 时间)的时间戳。

updated

字符串

更新此功能控制策略时采用 ISO 8601 日期和时间格式(UTC 时间)的时间戳。

externalManagementSystem

对象

识别托管此 Cloud Manager 项目的外部系统的参数。

externalManagementSystem
.name

字符串

识别托管此 Cloud Manager 项目的外部系统的标签。

externalManagementSystem
.systemId

字符串

此Cloud Manager项目的托管外部系统的唯一标识符。

externalManagementSystem
.version

字符串

托管此 Cloud Manager 项目的外部系统的有效版本。

policies

阵列

外部系统应用于此 Cloud Manager 项目的策略列表。

policies
.policy[n]

对象

为此 Cloud Manager 项目设置的单个策略。该参数可在policies数组中设置一次或多次。

可能的值为:

  • EXTERNALLY_MANAGED_LOCK:用户无法使用Cloud Manager管理policies.policy[n]大量中列出的其他设置。这些用户可以使用已配置的外部系统(例如Kubernetes Operator)来管理这些设置。

  • DISABLE_USER_MANAGEMENT:用户无法管理用户或角色。

  • DISABLE_AUTHENTICATION_MECHANISMS:用户无法更改身份验证设置。

  • DISABLE_SET_MONGOD_CONFIG:用户无法更改 policies[n].disabledParams大量中列出的任何 mongod 设置。

  • DISABLE_SET_MONGOD_VERSION:用户无法更改任何 mongod 或 mongos 的版本。

  • DISABLE_BACKUP_AGENT:用户无法启用或禁用备份代理。

  • DISABLE_MONGOD_LOG_MANAGEMENT:用户无法更改日志管理设置。

  • DISABLE_IMPORT_TO_AUTOMATION:用户无法使用自动化来管理部署。

  • DISABLE_AGENT_API_KEY_MANAGEMENT:用户无法创建或更新代理API密钥。

  • DISABLE_MONGOD_HOST_MANAGEMENT:用户无法更改主机的服务器类型。

policies[n]
.disabledParams

阵列

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--include \
--request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/availablePolicies?pretty=true"
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 "_id": "{PROJECT-ID}",
3 "created": "2019-08-29T15:03:24Z",
4 "updated": "2019-08-29T15:03:24Z",
5 "externalManagementSystem":
6 {
7 "name": "Operator",
8 "systemId": "6d6c139ae5528707b6e8e3b2",
9 "version": "0.2.1"
10 },
11 "policies": [
12 {"policy": "ExternallyManagedLock"},
13 {"policy": "DisableUserManagement"},
14 {"policy": "DisableAuthenticationMechanisms"},
15 {"policy": "DisableSetMongodVersion"},
16 {
17 "policy": "DisableSetMongodConfig",
18 "disabledParams": ["net.tls.CAFile"]
19 }
20 ]
21}