/ /

/ /

创建一个 Oplog 配置

配置一个新的 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。对于返回一个结果的端点，响应体包括： `status`： HTTP响应代码 `content`：预期响应正文	`false`

请求正文参数

名称	类型	说明
assignEnabled	布尔	可选。指示是否可以为此oplog 存储分配备份作业的标志。
加密凭证	布尔	可选。指示此 oplog 存储的用户名和密码是否使用凭证工具加密的标志。
id	字符串	标记此oplog 存储的唯一名称。
labels	字符串数组	可选.标签数组，用于管理 MongoDB Ops Manager 可以将哪些备份作业分配给哪些 oplog 存储。设置这些标签会限制此 oplog 存储可以处理的备份作业。如果省略，则此 oplog 存储只能处理不使用标签来筛选作业的项目的备份作业。
maxCapacityGB	数字	可选。oplog存储在 OUTSIDE_SPACE_USED_THRESHOLD警报中使用的预期最大可用容量。`maxCapacityGB` 不对后端数据库的大小实施任何限制。
OIDC	对象	可选。此存储的 OIDC身份验证设置。 `oidc`对象接受以下字段： `enabled`：布尔值。为此存储启用 OIDC身份验证。 `method`: string.`callback`、`azure`、`gcp`或`k8s`之一。 `tokenUri`：字符串。 IdP 令牌端点。当 `method` 为 `callback` 时为必填项。 `clientId`：字符串。向 IdP 注册的客户端ID 。当 `method` 为 `callback` 时为必填项；当 `method` 为 `azure` 时可选。 `clientSecret`：字符串。向 IdP 注册的客户端密钥。当 `method` 为 `callback` 时为必填项。如果您编辑现有存储并省略此字段或提交先前 `GET`请求返回的编辑值， Ops Manager将保留现有密钥。 `scope`：字符串。从 IdP 请求的 OAuth2 范围。仅当 `method` 为 `callback` 时使用。 `tokenResource`：字符串。工作负载身份令牌的受众或资源标识符。当 `method` 为 `azure` 或 `gcp` 时为必填项。此值必须与目标MongoDB部署的 `oidcIdentityProviders` 设置中为此 IdP 配置的 `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	字符串	标记此oplog 存储的唯一名称。
labels	字符串数组	标签数组，用于管理 MongoDB Ops Manager 可以将哪些备份作业分配给哪些 oplog 存储。
链接	对象数组	指向子资源或相关资源的一个或多个链接。响应中的所有 `links` 数组至少包含一个名为 `self` 的链接。URL之间的关系在 Web 链接规范中进行了解释。
maxCapacityGB	数字	可选。oplog存储在 OUTSIDE_SPACE_USED_THRESHOLD警报中使用的预期最大可用容量。`maxCapacityGB` 不对后端数据库的大小实施任何限制。
OIDC	对象	此存储的 OIDC身份验证设置。 `oidc`对象包含以下字段： `enabled`：布尔值。指示是否为此存储启用了 OIDC身份验证。 `method`: string.`callback`、`azure`、`gcp`或`k8s`之一。 `tokenUri`：字符串。 IdP 令牌端点。仅当 `method` 为 `callback` 时出现。 `clientId`：字符串。向 IdP 注册的客户端ID 。 `clientSecret`: string.MongoDB Ops Manager 在响应中对此值进行编辑，并不返回原始客户端秘密。 `scope`：字符串。从 IdP 请求的 OAuth2 范围。仅当 `method` 为 `callback` 时才出现。 `tokenResource`: string.工作负载身份标记的受众或资源标识符。仅在 `method` 为 `azure` 或 `gcp` 时出现。
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 }

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	}'