创建单个文件系统存储配置
配置一个新的文件系统存储。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
POST /snapshot/fileSystemConfigs
请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。 对于返回一个结果的端点,响应体包括:
| false |
请求正文参数
正文参数 | 类型 | 必要性 | 说明 |
---|---|---|---|
assignEnabled | 布尔 | Optional | 指示是否可以为此文件系统存储分配备份作业的标志。 |
id | 字符串 | 必需 | 此文件系统存储的唯一标识符。 |
labels | 字符串数组 | Optional | |
负载系数 | 数字 | Optional | 非零的正整数,表示此快照存储与另一个快照存储相比应执行多少备份工作。 仅当您使用多个快照存储时才设置此选项。 要学习;了解有关 Load Factor的详情,请参阅编辑一个现有块存储。 |
mmapv1CompressionSetting | 字符串 | 可选的 | 压缩设置(如果您对快照使用 MMAPv1 storage engine)。 MongoDB Ops Manager接受 如果 MongoDB 运行的是FCV 4.2或更高版本,MongoDB Atlas 会忽略此设置。 重要提示: MongoDB在MongoDB 4.2中删除了对 MMAPv 1存储引擎的支持。 如果编辑部署的配置以将存储引擎更改为WiredTiger存储引擎, MongoDB Ops Manager将重新启动MongoDB进程。 |
storePath | 字符串 | 必需 | 基于文件系统的备份在文件系统存储主机上的存储位置。 |
wtCompressionSetting | 字符串 | 可选的 | 压缩设置(如果您将 WiredTiger storage engine 用于快照)。 MongoDB Ops Manager接受 如果 MongoDB 运行的是FCV 4.2或更高版本,MongoDB Atlas 会忽略此设置。 |
响应
名称 | 类型 | 说明 |
---|---|---|
assignEnabled | 布尔 | 指示是否可以为此文件系统存储分配备份作业的标志。 |
id | 字符串 | 此文件系统存储的唯一标识符。 |
labels | 字符串数组 | 用于管理 可以将哪些 备份作业MongoDB Ops Manager 分配给哪些 文件系统存储的标签。 |
链接 | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。 响应中的所有 |
负载系数 | 数字 | 非零的正整数,表示此快照存储与另一个快照存储相比应执行多少备份工作。 仅当您使用多个快照存储时才设置此选项。 要学习;了解有关Load Factor的更多信息,请参阅编辑一个现有块存储。 |
mmapv1CompressionSetting | 字符串 | 压缩设置(如果您对快照使用 MMAPv1 storage engine)。 Ops Manager 可能会返回 如果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 可能会返回 如果MongoDB运行的是FCV 4.2 或更高版本,则MongoDB Ops Manager将忽略此设置。 |
请求示例
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/snapshot/fileSystemConfigs?pretty=true' \ 6 --data '{ 7 "assignmentEnabled" : true, 8 "id" : "{FILE-SYSTEM-STORE-CONFIG-ID}", 9 "labels" : [ "l1", "l2" ], 10 "loadFactor" : 50, 11 "mmapv1CompressionSetting" : "NONE", 12 "storePath" : "/data/backup", 13 "wtCompressionSetting" : "GZIP" 14 }'
响应示例
响应标头
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
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 "id" : "{FILE-SYSTEM-STORE-CONFIG-ID}", 4 "labels" : [ "l1", "l2" ], 5 "links" : [ { 6 "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs", 7 "rel" : "self" 8 }], 9 "loadFactor" : 50, 10 "mmapv1CompressionSetting" : "NONE", 11 "storePath" : "/data/backup", 12 "wtCompressionSetting" : "GZIP" 13 }