Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/ / / /

更新自动化配置

在此页面上

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

使用 PUT更新项目的自动化配置。 不要使用PATCH

要查看有关如何更新自动化配置的教程,请参阅更新自动化配置。

要更新hostname以外的 MongoDB 助手,必须通过不同的端点执行此操作。

当您提交更新时,Cloud Manager 会对数据进行内部修改,然后保存您的新配置版本。

例子

Cloud Manager 可能会向每个指定的社区 MongoDB 版本添加一个字段,以指示代理从何处下载这些版本。

MongoDB 代理不断轮询 Cloud Manager 以了解配置更改,并在发生配置更新时获取更新。然后,代理会调整其实时进程的状态以进行匹配。

警告

在Cloud Manager Administration API中没有提供防止并发修改的保护措施。如果两个管理员都从基于当前版本的配置开始,进行各自的修改,然后提交各自的修改,则以后来修改者为准。

警告

在启用身份验证之前更新代理用户名

自动化配置提供了使用 API在集群上启用身份验证的唯一方法。 要启用身份验证,请先使用"用户名": "自动化"调用以下端点:

此资源需要Project Automation Admin角色。

基本 URL: https://cloud.mongodb.com/api/public/v 1.0

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

PROJECT-ID

字符串

必需

拥有自动化配置的群组的唯一标识符。

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

名称
类型
必要性
说明
默认

pretty

布尔

Optional

false

envelope

布尔

Optional

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

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

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

名称
说明

status

HTTP 响应代码

content

预期响应正文

false

要查看这些参数,请参阅自动化配置参数。

要查看这些参数,请参阅自动化配置参数。

以下内容将自动化配置替换为/Users/admin/updated-conf.json中保存的更新配置。 有关更新的配置文档的示例,请参阅自动化配置示例。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--include \
--request PUT "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig?pretty=true" \
--data-binary "@/Users/admin/updated-conf.json"
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}

要查看此配置的示例,请参阅自动化配置示例。

后退

获取自动化配置