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

更新一个 Oplog 配置

更新一个 oplog 存储的配置。

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

PUT /oplog/mongoConfigs/{OPLOG-CONFIG-ID}
名称
类型
说明

OPLOG-CONFIG-ID

字符串

此oplog配置的唯一标识符。

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

名称
类型
必要性
说明
默认

pretty

布尔

Optional

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

false

envelope

布尔

Optional

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

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

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

  • status: HTTP 响应代码

  • content:预期响应正文

false

名称
类型
说明

assignEnabled

布尔

可选。 指示是否可以为此oplog存储分配备份作业的标志。

加密凭证

布尔

可选。 指示此 oplog 存储的用户名和密码是否使用凭证工具加密的标志。

labels

字符串数组

可选。 oplog用于管理 可以将哪些 备份作业MongoDB Ops Manager 分配给哪些 存储的标签数组。

设置这些标签会限制此 oplog 存储可以处理的备份作业。 如果省略,则此 oplog 存储只能处理不使用标签来筛选作业的项目的备份作业。

maxCapacityGB

数字

可选。oplog存储在 OUTSIDE_SPACE_USED_THRESHOLD警报中使用的预期最大可用容量。maxCapacityGB 不对后端数据库的大小实施任何限制。

OIDC

对象

可选。 此存储的 OIDC身份验证设置。oidc 对象接受以下字段:

  • enabled: 布尔值。启用对这个存储的 OIDC 身份验证。

  • method: string.callback、azure、gcp或k8s之一。

  • tokenUri: string.身份提供程序令牌的终结点。当 method 为 callback 时必需。

  • clientId: string.与 身份提供程序 注册的客户端 ID。当 method 为 callback 时,必须;当 method 为 azure 时,可选。

  • clientSecret: string.在 身份提供程序 注册的客户端密钥。当 method 为 callback 时必需。如果您编辑现有存储并省略此字段,或提交上一个 GET 请求返回的已编辑值,MongoDB Ops Manager 将保留现有密钥。

  • scope: string.从 身份提供程序 请求的 OAuth2 范围。仅在 method 为 callback 时使用。

  • tokenResource: string.工作负载身份令牌的受众或资源标识符。当 method 为 azure 或 gcp 时必需。此值必须与目标 MongoDB 部署的 oidcIdentityProviders 设置中为此 身份提供程序 配置的 audience 匹配。

callback、azure、gcp 和 k8s 方法并不都需要相同的字段。azure、gcp 和 k8s 方法不需要 clientSecret。

当 oidc.enabled 为 true 时,在存储的 uri 字段中仅提供主机和连接选项。MongoDB Ops Manager 会忽略嵌入 URI 中的任何用户名或密码。

要将存储从 OIDC 切换为另一个身份验证机制,请在请求中提交 oidc: {enabled: false},而不是省略 oidc 对象。

uri

字符串

以逗号分隔的<hostname:port>格式的主机列表,可用于访问此oplog 存储。

ssl

布尔

可选。指示此oplog存储是否只接受使用TLS加密的连接的标志。

writeConcern

字符串

可选。 用于此oplog 存储的写关注。

此选项可接受的值为:

  • ACKNOWLEDGED

  • W2

  • JOURNALED

  • MAJORITY

要学习;了解MongoDB中的写入确认级别,请参阅写关注。

名称
类型
说明

assignEnabled

布尔

指示是否可以为此oplog 存储分配备份作业的标志。

加密凭证

布尔

指示此 oplog 存储的用户名和密码是否使用凭证工具加密的标志。

id

字符串

labels

字符串数组

oplog用于管理 可以将哪些 备份作业MongoDB Ops Manager 分配给哪些 存储的标签数组。

链接

对象数组

指向子资源或相关资源的一个或多个链接。响应中的所有 links 数组至少包含一个名为 self 的链接。URL之间的关系在 Web 链接规范中进行了解释。

maxCapacityGB

数字

可选。oplog存储在 OUTSIDE_SPACE_USED_THRESHOLD警报中使用的预期最大可用容量。maxCapacityGB 不对后端数据库的大小实施任何限制。

OIDC

对象

此存储的 OIDC身份验证设置。oidc 对象包含以下字段。

  • enabled: 布尔值。指示对此存储是否已启用 OIDC 身份验证。

  • method: string.callback、azure、gcp或k8s之一。

  • tokenUri: string.身份提供程序令牌的终结点。仅在 method 为 callback 时存在。

  • clientId: string.与 身份提供程序 注册的客户端 ID。

  • clientSecret: string.MongoDB Ops Manager 在响应中对此值进行编辑,并不返回原始客户端秘密。

  • scope: string.从 身份提供程序 请求的 OAuth2 范围。仅在 method 为 callback 时呈现。

  • tokenResource: string.工作负载身份标记的受众或资源标识符。仅在 method 为 azure 或 gcp 时出现。

uri

字符串

以逗号分隔的<hostname:port>格式的主机列表,可用于访问此oplog 存储。

ssl

布尔

指示此oplog存储是否只接受使用TLS加密的连接的标志。

usedSize

数字

现有备份消耗的备份容量(以MB为单位)。

writeConcern

字符串

用于此oplog 存储的写关注。

此选项可接受的值为:

  • ACKNOWLEDGED

  • W2

  • JOURNALED

  • MAJORITY

要学习;了解MongoDB中的写入确认级别,请参阅写关注。

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs/{OPLOG-CONFIG-ID}?pretty=true' \ --data '{ "assignmentEnabled" : true, "encryptedCredentials" : false, "labels" : [ "l1", "l2" ], "maxCapacityGB" : 8, "uri" : "mongodb://localhost:27017", "ssl" : true, "writeConcern" : "W2"}'
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}
{ "assignmentEnabled" : true, "encryptedCredentials" : false, "id" : "{CONFIG-ID}", "labels" : [ "l1", "l2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs/{OPLOG-CONFIG-ID}", "rel" : "self" }], "maxCapacityGB" : 8, "uri" : "mongodb://localhost:27017", "ssl" : true, "usedSize" : 222, "writeConcern" : "W2"}