创建一个 Oplog 配置

在此页面上

Resource

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

MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。尽快升级到更高的MongoDB Ops Manager版本。

配置一个新的 oplog 存储。

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

Resource

POST /oplog/mongoConfigs

请求路径参数

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

请求查询参数

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

名称

类型

必要性

说明

默认

pretty

布尔

Optional

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

false

envelope

布尔

Optional

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

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

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

名称	说明
状态	HTTP 响应代码
envelope	预期响应正文

false

请求正文参数

名称	类型	说明
assignEnabled	布尔	可选。指示是否可以为此oplog存储分配备份作业的标志。
加密凭证	布尔	可选。指示此oplog存储的用户名和密码是否使用凭证工具加密的标志。
id	字符串	标记此oplog 存储的唯一名称。
labels	字符串数组	可选。 oplog用于管理可以将哪些备份作业MongoDB Ops Manager 分配给哪些存储的标签数组。设置这些标签会限制此 oplog 存储可以处理的备份作业。如果省略，则此 oplog 存储只能处理不使用标签来筛选作业的项目的备份作业。
maxCapacityGB	数字	可选。此oplog 存储可以存储的最大数据量（以 GB 为单位）。
uri	字符串	以逗号分隔的`<hostname:port>`格式的主机列表，可用于访问此oplog 存储。
ssl	布尔	可选。指示此 oplog 存储是否只接受使用TLS加密的连接的标志。
writeConcern	字符串	可选。用于此oplog 存储的写关注。此选项可接受的值为： `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` 要学习；了解MongoDB中的写入确认级别，请参阅写关注。

响应

名称	类型	说明
assignEnabled	布尔	指示是否可以为此oplog 存储分配备份作业的标志。
加密凭证	布尔	指示此 oplog 存储的用户名和密码是否使用凭证工具加密的标志。
id	字符串	标记此oplog 存储的唯一名称。
labels	字符串数组	oplog用于管理可以将哪些备份作业MongoDB Ops Manager 分配给哪些存储的标签数组。
链接	对象数组	指向子资源和/或相关资源的一个或多个链接。响应中的所有`links`数组至少包含一个名为`self`的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
maxCapacityGB	数字	此oplog 存储可以存储的最大数据量（以 GB 为单位）。
uri	字符串	以逗号分隔的`<hostname:port>`格式的主机列表，可用于访问此oplog 存储。
ssl	布尔	指示此 oplog 存储是否只接受使用TLS加密的连接的标志。
usedSize	数字	现有备份消耗的备份容量（以MB为单位）。
writeConcern	字符串	用于此oplog 存储的写关注。此选项可接受的值为： `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` 要学习；了解MongoDB中的写入确认级别，请参阅写关注。

请求示例

1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2      --header 'Accept: application/json' \
3      --header 'Content-Type: application/json' \
4      --include \
5      --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs?pretty=true' \
6      --data '{
7        "assignmentEnabled" : true,
8        "encryptedCredentials" : false,
9        "id" : "{OPLOG-CONFIG-ID}",
10        "labels" : [ "l1", "l2" ],
11        "maxCapacityGB" : 8,
12        "uri" : "mongodb://localhost:27017",
13        "ssl" : true,
14        "writeConcern" : "W2"
15      }'

响应示例

响应标头

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   "assignmentEnabled" : true,
3   "encryptedCredentials" : false,
4   "id" : "{OPLOG-CONFIG-ID}",
5   "labels" : [ "l1", "l2" ],
6   "links" : [ {
7     "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs",
8     "rel" : "self"
9   }],
10   "maxCapacityGB" : 8,
11   "uri" : "mongodb://localhost:27017",
12   "ssl" : true,
13   "usedSize" : 222,
14   "writeConcern" : "W2"
15 }

后退

获取所有 oplog 配置

来年

更新一个 Oplog 配置

1	curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2	--header 'Accept: application/json' \
3	--header 'Content-Type: application/json' \
4	--include \
5	--request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs?pretty=true' \
6	--data '{
7	"assignmentEnabled" : true,
8	"encryptedCredentials" : false,
9	"id" : "{OPLOG-CONFIG-ID}",
10	"labels" : [ "l1", "l2" ],
11	"maxCapacityGB" : 8,
12	"uri" : "mongodb://localhost:27017",
13	"ssl" : true,
14	"writeConcern" : "W2"
15	}'