获取所有文件系统存储配置

在此页面上

Resource

请求路径参数
请求查询参数
请求正文参数
响应
响应文档
results 嵌入式文档
请求示例
响应示例
响应标头
响应体

检索所有文件系统存储的配置。

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

Resource

GET /snapshot/fileSystemConfigs

请求路径参数

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

请求查询参数

名称	类型	必要性	说明	默认
pageNum	数字	Optional	从一开始的整数，用于返回结果的一部分。	`1`
itemsPerPage	数字	Optional	每页要返回的项目数，最多 500 个。	`100`
pretty	布尔	Optional	指示响应正文是否应采用 prettyprint 格式的标志格式。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 `envelope : true`。对于返回结果列表的端点， `content`对象是一个信封。 Ops Manager 将`status`字段添加到响应正文。	`false`

assignableOnly	布尔	Optional	指示是否可以为此文件系统存储分配新备份作业的标志。	`true`

请求正文参数

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

响应

响应文档

响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。

名称	类型	说明
`results`	阵列	数组为`results`嵌入式文档部分中详细介绍的每一项包含一个对象。
`links`	阵列	数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
`totalCount`	数字	结果集中项目总数的整数计数。如果对整个结果集进行分页，则它可能大于results数组中的对象数。

`results` 嵌入式文档

每个结果都是一个文件系统存储。

名称	类型	说明
assignEnabled	布尔	指示是否可以为此文件系统存储分配备份作业的标志。
id	字符串	此文件系统存储的唯一标识符。
labels	字符串数组	用于管理可以将哪些备份作业MongoDB Ops Manager 分配给哪些文件系统存储的标签。
链接	对象数组	指向子资源和/或相关资源的一个或多个链接。响应中的所有`links`数组至少包含一个名为`self`的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
负载系数	数字	非零的正整数，表示此快照存储与另一个快照存储相比应执行多少备份工作。仅当您使用多个快照存储时才设置此选项。要学习；了解有关Load Factor的更多信息，请参阅编辑一个现有块存储。
mmapv1CompressionSetting	字符串	压缩设置（如果您对快照使用 MMAPv1 storage engine）。 Ops Manager 可能会返回`NONE`或`GZIP` 。如果MongoDB运行的是FCV 4.2 或更高版本，则MongoDB Ops Manager将忽略此设置。重要提示： MongoDB在MongoDB 4.2中删除了对 MMAPv 1存储引擎的支持。如果编辑部署的配置以将存储引擎更改为WiredTiger存储引擎， MongoDB Ops Manager将重新启动MongoDB进程。
storePath	字符串	在文件系统存储主机上存储基于文件系统的备份的系统根相对目录路径。
wtCompressionSetting	字符串	压缩设置（如果您将 WiredTiger storage engine 用于快照）。 Ops Manager 可能会返回`NONE`或`GZIP` 。如果MongoDB运行的是FCV 4.2 或更高版本，则MongoDB Ops Manager将忽略此设置。

请求示例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs?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   "links" : [ {
3     "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs?pretty=true&pageNum=1&itemsPerPage=100",
4     "rel" : "self"
5   } ],
6   "results" : [ {
7     "assignmentEnabled" : true,
8     "id" : "{FILE-SYSTEM-STORE-CONFIG-ID}",
9     "labels" : [ "l1", "l2" ],
10     "links" : [ {
11       "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs/{FILESYSTEM-ID}",
12       "rel" : "self"
13     }],
14     "loadFactor" : 50,
15     "mmapv1CompressionSetting" : "NONE",
16     "storePath" : "/data/backup",
17     "wtCompressionSetting" : "GZIP"
18   } ],
19   "totalCount" : 1
20 }

后退

按 ID 获取一个文件系统存储配置

来年

创建单个文件系统存储配置

1	{
2	"links" : [ {
3	"href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs?pretty=true&pageNum=1&itemsPerPage=100",
4	"rel" : "self"
5	} ],
6	"results" : [ {
7	"assignmentEnabled" : true,
8	"id" : "{FILE-SYSTEM-STORE-CONFIG-ID}",
9	"labels" : [ "l1", "l2" ],
10	"links" : [ {
11	"href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs/{FILESYSTEM-ID}",
12	"rel" : "self"
13	}],
14	"loadFactor" : 50,
15	"mmapv1CompressionSetting" : "NONE",
16	"storePath" : "/data/backup",
17	"wtCompressionSetting" : "GZIP"
18	} ],
19	"totalCount" : 1
20	}