对于 AI 代理:可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。

检索一个项目的功能策略

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

此资源需要Project Owner 。

GET /groups/{PROJECT-ID}/controlledFeature
名称
类型
必要性
说明

PROJECT-ID

字符串

必需

具有受控功能的项目的唯一标识符。

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

名称
类型
说明
默认

pageNum

整型

页码(从 1 开始)。

1

itemsPerPage

整型

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

100

pretty

布尔

指示是否以 prettyprint 格式返回响应正文。

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 操作符,来管理这些设置。

  • 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

阵列

DISABLE_SET_MONGOD_CONFIG 策略应用时需要禁用的 mongod 设置列表。在自动化中,并非所有 MongoDB 选项都可用,这可能会导致导入失败。要了解更多,请参阅 MongoDB 设置和自动化支持。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/controlledFeature?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}
{ "_id": "{PROJECT-ID}", "created": "2019-08-29T15:03:24Z", "updated": "2019-08-29T15:03:24Z", "externalManagementSystem": { "name": "Operator", "systemId": "6d6c139ae5528707b6e8e3b2", "version": "0.2.1" }, "policies": [ {"policy": "ExternallyManagedLock"}, {"policy": "DisableUserManagement"}, {"policy": "DisableAuthenticationMechanisms"}, {"policy": "DisableSetMongodVersion"}, { "policy": "DisableSetMongodConfig", "disabledParams": ["net.tls.CAFile"] } ]}