Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/
API
/
Ops Manager Administration API 资源
/
备份和恢复
/
备份配置

从一个项目获取一项备份配置

在此页面上

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

注意

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

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

资源

GET /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}

请求参数

请求路径参数

参数
类型
必要性
说明
PROJECT-ID
字符串
必需
唯一的 24 位十六进制数字字符串，用于标识包含具有要查找的备份配置的集群的项目。
CLUSTER-ID
字符串
必需
唯一的 24 位十六进制数字字符串，用于标识要查找其备份配置的集群。

请求查询参数

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

名称
类型
必要性
说明
默认
pretty
布尔
Optional
指示响应正文是否应采用 Prettyprint 的标志 格式。
false
envelope
布尔
Optional

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

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

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

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

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

名称
类型
说明
availableMembers
字符串数组
可用于备份的集群成员列表。 仅在成员请求时出现。
clusterId
字符串
唯一的 24 位十六进制数字字符串，用于标识要配置备份的集群。
EncryptionEnabled
布尔

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

注意

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

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

exclusive Namespaces
字符串数组

要从备份中省略的数据库名称和collection名称的列表。每个字符串都是{database}或{database}.{collection}形式的命名空间。 如果此字段存在，则includedNamespaces字段不能存在。

您必须发送排除的命名空间的新完整列表，包括已列出的命名空间。

如果新列表从以前的列表中删除了任何命名空间，则还必须设置syncSource字段，因为删除已排除的命名空间需要完全重新同步。 如果没有syncSource字段，请求将失败。

如果新列表仅向前一个列表添加内容，则无需设置syncSource 。

groupId
字符串
唯一的 24 位十六进制数字字符串，用于标识拥有此备份配置的项目。
includedNamespaces
字符串数组

要包含在备份中的数据库名称和collection名称列表。每个字符串都是{database}或{database}.{collection}形式的命名空间。 不会备份未在此数组中列出的任何命名空间。 如果此字段存在，则excludedNamespaces字段不能存在。

您必须发送包含的命名空间的新完整列表，包括已列出的所有命名空间。

如果新列表向先前列表添加任何命名空间，则还必须设置syncSource字段，因为添加包含的命名空间需要完全重新同步。如果没有syncSource字段，请求将失败。

如果新列表仅删除前一个列表中的命名空间，则无需设置syncSource 。

链接
对象数组

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

首选成员
字符串
手动将集群成员指定为备份的首选成员。 仅当使用用户界面或API 设置首选成员时，才会针对成员请求出现。
sslEnabled
布尔
标识是否为同步源数据库启用TLS的标志。
statusName
字符串

备份配置的当前（或所需）状态。 可能的值为：

  • INACTIVE

  • PROVISIONING

  • STARTED

  • STOPPED

  • TERMINATING

storageEngineName
字符串

用于备份的storage engine。可能的值为：

  • MEMORY_MAPPED

  • WIRED_TIGER

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}"

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

重要

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

以下请求将返回可用成员。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/availableMembers?pretty=true"

响应示例

响应标头

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  "clusterId" : "{CLUSTER-ID}",
3  "encryptionEnabled" : false,
4  "excludedNamespaces" : [ ],
5  "groupId" : "{PROJECT-ID}",
6  "includedNamespaces" : [ ],
7  "links" : [ ],
8  "sslEnabled" : false,
9  "statusName" : "STARTED",
10  "storageEngineName" : "WIRED_TIGER"
11}

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

重要

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

以下响应包括可用成员和指定的首选成员。如果首选成员未定义，则会从响应中排除。

1{
2  "availableMembers" : [ "{HOSTNAME1}:{PORT1}", "{HOSTNAME2}:{PORT2}", "{HOSTNAME3}:{PORT3}"],
3  "clusterId" : "{CLUSTER-ID}",
4  "encryptionEnabled" : false,
5  "excludedNamespaces" : [ ],
6   "groupId" : "{PROJECT-ID}",
7   "includedNamespaces" : [ ],
8   "links" : [ ],
9   "sslEnabled" : false,
10   "statusName" : "STARTED",
11   "storageEngineName" : "WIRED_TIGER",
12   "preferredMember" : "{HOSTNAME1}:{PORT1}"
13 }

后退

从一个项目中获取所有备份配置