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

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

在此页面上

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

注意

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

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

Resource

GET /groups/{PROJECT-ID}/backupConfigs

请求参数

请求路径参数

名称
类型
必要性
说明
PROJECT-ID
字符串
必需
唯一的 24 位十六进制数字字符串，用于标识备份配置适用的项目。

请求查询参数

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

名称
类型
必要性
说明
默认
pageNum
数字
Optional
从一开始的整数，用于返回结果的一部分。
1
itemsPerPage
数字
Optional
每页要返回的项目数，最多 500 个。
100
pretty
布尔
Optional
指示响应正文是否应采用 prettyprint 格式 的标志 格式。
false
envelope
布尔
Optional

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

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 envelope : true。

对于返回结果列表的端点， content对象是一个信封。 Ops Manager 将status字段添加到响应正文。

false

请求正文参数

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

响应

名称
类型
说明
groupId
字符串
唯一的 24 位十六进制数字字符串，用于标识拥有此备份配置的项目。
clusterId
字符串
唯一的 24 位十六进制数字字符串，用于标识要查找其备份配置的集群。
statusName
字符串

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

  • INACTIVE

  • PROVISIONING

  • STARTED

  • STOPPED

  • TERMINATING

storageEngineName
字符串

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

  • MEMORY_MAPPED

  • WIRED_TIGER

EncryptionEnabled
布尔

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

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

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

sslEnabled
布尔
指示是否为同步源数据库启用TLS的标志。
exclusive Namespaces
字符串数组

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

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

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

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

includedNamespaces
字符串数组

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

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

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

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

请求示例

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"

响应示例

响应标头

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  "totalCount" : 3,
3  "results" : [ {
4    "groupId" : "{PROJECT-ID}",
5    "clusterId" : "{CLUSTER-ID1}",
6    "statusName" : "STARTED",
7    "storageEngineName" : "WIRED_TIGER",
8    "sslEnabled" : false,
9    "excludedNamespaces" : [ ],
10    "includedNamespaces" : [ ],
11    "links" : [ ]
12  }, {
13    "groupId" : "{PROJECT-ID}",
14    "clusterId" : "{CLUSTER-ID2}",
15    "statusName" : "STARTED",
16    "storageEngineName" : "MEMORY_MAPPED",
17    "sslEnabled" : false,
18    "excludedNamespaces" : [ ],
19    "includedNamespaces" : [ ],
20    "links" : [ ]
21  }, {
22    "groupId" : "{PROJECT-ID}",
23    "clusterId" : "{CLUSTER-ID3}",
24    "statusName" : "STOPPED",
25    "storageEngineName" : "WIRED_TIGER",
26    "sslEnabled" : false,
27    "excludedNamespaces" : [ ],
28    "includedNamespaces" : [ ],
29    "links" : [ ]
30  } ],
31  "links" : [ ]
32}

后退

备份配置

来年

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