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

更新一个备份配置

在此页面上

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

注意

注意:群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。

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

PATCH /groups/{projectId}/backupConfigs/{clusterId}
路径参数
类型
必要性
说明

projectId

字符串

必需

唯一的 24 位十六进制数字字符串,用于标识包含具有要更改的备份配置的集群的项目。

clusterId

字符串

必需

唯一的 24 位十六进制数字字符串,用于标识要更改其备份配置的集群。

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

名称
类型
必要性
说明
默认

pretty

布尔

Optional

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

false

envelope

布尔

Optional

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

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

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

名称
说明

status

HTTP 响应代码

content

预期响应正文

false

名称
类型
必要性
说明

authMechanismName

字符串

可选的

连接到同步源数据库所需的身份验证机制。 如果同步存储使用身份验证,则 Ops Manager 需要此参数。Ops Manager 接受:

  • MONGODB_CR (涵盖 SCRAM-SHA-1、SCRAM-SHA-256 和 MONGODB-CR。)

  • GSSAPI

  • PLAIN

  • MONGODB_X509

  • NONE

EncryptionEnabled

布尔

Optional

指示是否为备份配置启用加密的标志。 为备份配置启用加密时,必须包含syncSource参数。 对于项目中的现有备份,启用加密需要初始同步以重新创建备份的头部数据库。

FCV 4.2 ,然后使用备份游标而不是头部数据库。 有关更多信息,请参阅备份守护程序服务。

有关 FCV 4.2 或更高版本的备份加密的更多信息,请参阅加密备份快照。

exclusive Namespaces

字符串数组

可选的

注意

MongoDB Ops Manager接受为运行MongoDB FCV 4.0 或更早版本的备份作业使用此参数。 MongoDB Ops ManagerMongoDB备份运行 FCV4.2 或更高版本的 数据库时, 会忽略此参数。

要从备份中省略的数据库和集合名称的列表。每个字符串代表一个命名空间。命名空间使用以下格式之一:

  • {数据库}

  • {数据库}.{集合}

该参数必须满足以下条件:

  • Ops Manager接受此参数或includedNamespaces 参数,但不能同时接受两者。

  • Ops Manager 需要排除的命名空间的新完整列表,包括已在数组中找到的任何命名空间。

    • 如果新列表从现有数组中删除了任何命名空间,请设置syncSource参数。

      • 删除已排除的命名空间需要完全重新同步。

      • 如果没有syncSource参数,请求将失败。

    • 如果新列表仅添加到现有数组中,则不要设置syncSource

includedNamespaces

字符串数组

可选的

注意

MongoDB Ops Manager接受为运行MongoDB FCV 4.0 或更早版本的备份作业使用此参数。 MongoDB Ops ManagerMongoDB备份运行 FCV4.2 或更高版本的 数据库时, 会忽略此参数。

要包含在备份中的数据库和集合名称的列表。每个字符串代表一个命名空间。命名空间使用以下格式之一:

  • {数据库}

  • {数据库}.{集合}

该参数必须满足以下条件:

  • Ops Manager接受此参数或排除的命名空间,但不能同时接受两者。

  • Ops Manager 需要包含的命名空间的新完整列表,包括已在数组中找到的任何命名空间。

    • 如果新列表添加了现有数组中的任何命名空间,请设置syncSource参数。

      • 添加包含的命名空间需要完全重新同步。

      • 如果没有syncSource参数,请求将失败。

    • 如果新列表仅删除现有数组中的命名空间,则不要设置syncSource

密码

字符串

可选的

用于连接到同步源数据库的密码。 MongoDB Ops Manager当同步存储mongod 实例要求客户端进行身份验证时, 需要此参数。

首选成员

字符串

Optional

用户指定为创建快照的首选副本集节点的集群节点。您可以使用控制台设置首选成员。 使用获取一个备份配置端点查看可充当首选成员的可用副本集成员。

预配

布尔

可选的

指示 Ops Manager 是否已预配存储备份所需资源的标志。

sslEnabled

布尔

Optional

指示是否为同步源数据库启用TLS的标志。

statusName

字符串

Optional

备份配置的当前(或所需)状态。 Ops Manager 接受:

  • 非活动

  • 配置

  • STARTED

  • 已停止

  • 终止

storageEngineName

字符串

Optional

用于备份的storage engine。Ops Manager 接受:

  • MEMORY_MAPPED

  • WIRED_TIGER

syncSource

字符串

可选的

mongod实例,从中检索备份数据。 MongoDB Ops Manager接受特定主机名或以下主机名之一: PRIMARYSECONDARY

如果"storageEngineName" : "WIRED_TIGER" ,则 Ops Manager 需要此参数。

用户名

字符串

可选的

用于连接到同步源数据库的用户名。 MongoDB Ops Manager当同步存储mongod 实例要求客户端进行身份验证时, 需要此参数。

在更新 Ops Manager托管的副本集或分片集群的备份配置时,将此参数发送到 Ops Manager。

名称
类型
说明

authMechanismName

字符串

连接到同步源数据库时使用的身份验证机制的名称。 如果同步存储使用身份验证,Ops Manager 会返回此参数。

clusterId

字符串

应用此备份配置的集群的唯一标识符。

EncryptionEnabled

布尔

指示是否为备份配置启用加密的标志。 为备份配置启用加密时,必须包含syncSource字段。 对于项目中的现有备份,启用加密需要初始同步以重新创建备份的头部数据库。

FCV 4.2 ,然后使用备份游标而不是头部数据库。 有关详细信息,请参阅备份守护程序服务。

有关 FCV 4.2 或更高版本的备份加密的更多信息,请参阅加密备份快照。

exclusive Namespaces

字符串数组

要从备份中省略的数据库名称和集合名称的列表。 每个string都是{database}{database}.{collection}形式的命名空间。

includedNamespaces

字符串数组

要包含在备份中的数据库名称和集合名称列表。 每个string都是{database}{database}.{collection}形式的命名空间。

首选成员

字符串

用户指定为创建快照的首选副本集节点的集群节点。您可以使用控制台设置首选成员。 使用获取一个备份配置端点查看可充当首选成员的可用副本集成员。

projectId

字符串

拥有此备份配置的项目的唯一标识符。

预配

布尔

指示 Ops Manager 是否已预配存储备份所需资源的标志。当要备份的数据量超过特定阈值时,Ops Manager 会返回此参数。

sslEnabled

布尔

指示是否为同步源数据库启用TLS的标志。

statusName

字符串

备份配置的当前状态。

storageEngineName

字符串

用于备份的storage engine。

1curl --user "{publicKey}:{privateKey}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --include --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}" \
5 --data '
6 {
7 "statusName": "STARTED",
8 "storageEngineName": "WIRED_TIGER",
9 "syncSource": "primary"
10 }'

当每个快照启动时,Ops Manager 会选择一个副本集成员来运行快照。此自动选择的成员应对副本集的性能影响最小。 您可以覆盖默认选择。

重要

尽可能使用 default selection 。 此选择可确保备份可用性。

以下请求设置首选成员。

1curl --user "{publicKey}:{privateKey}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --include --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}" \
5 --data '
6 {
7 "preferredMember":"{HOSTNAME}:{PORT}"
8 }'
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 "authMechanismName" : "NONE",
3 "clusterId" : "{clusterId}",
4 "encryptionEnabled" : false,
5 "excludedNamespaces" : [ ],
6 "groupId" : "{projectId}",
7 "links" : [ {
8 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",
9 "rel" : "self"
10 }, {
11 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",
12 "rel" : "http://mms.mongodb.com/cluster"
13 }, {
14 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}",
15 "rel" : "http://mms.mongodb.com/group"
16 }, {
17 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}/snapshotSchedule",
18 "rel" : "http://mms.mongodb.com/snapshotSchedule"
19 } ],
20 "sslEnabled" : false,
21 "statusName" : "STARTED",
22 "storageEngineName" : "WIRED_TIGER"
23}

当每个快照启动时,Ops Manager 会选择一个副本集成员来运行快照。此自动选择的成员应对副本集的性能影响最小。 您可以覆盖默认选择。

重要

尽可能使用default selection 。 此选择可确保备份可用性。

以下响应包括首选节点。

1{
2 "authMechanismName" : "NONE",
3 "clusterId" : "{clusterId}",
4 "encryptionEnabled" : false,
5 "excludedNamespaces" : [ ],
6 "groupId" : "{projectId}",
7 "links" : [ {
8 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",
9 "rel" : "self"
10 }, {
11 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",
12 "rel" : "http://mms.mongodb.com/cluster"
13 }, {
14 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}",
15 "rel" : "http://mms.mongodb.com/group"
16 }, {
17 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}/snapshotSchedule",
18 "rel" : "http://mms.mongodb.com/snapshotSchedule"
19 } ],
20 "sslEnabled" : false,
21 "statusName" : "STARTED",
22 "storageEngineName" : "WIRED_TIGER",
23 "preferredMember":"{HOSTNAME}:{PORT}"
24}

后退

获取一个