创建一个 S3 Oplog 配置
配置一个新的3 oplog 存储。
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
POST /oplog/s3Configs
请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
| false |
请求正文参数
名称 | 类型 | 必要性 | 说明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
AcceptedTos | 布尔 | 必需 | 指示您是否接受将 S3 兼容存储与 Ops Manager 一起使用的术语的标志。您必须将其设置为 如果将此设置为 | |||||||||
assignEnabled | 布尔 | Optional | 指示是否可以将备份作业分配给此数据存储的标志。 | |||||||||
AWS Access Key | 字符串 | 可选的 | 可以访问 s3BucketName 中指定的 S3 兼容存储桶的 Amazon Web Services 访问密钥 ID。 如果 | |||||||||
AWS Secret Key | 字符串 | 可选的 | 可以访问 如果 | |||||||||
customCertificates | 阵列 | Optional | 适用于关联的 S3 兼容存储桶的有效证书颁发机构证书的列表。 | |||||||||
customCertificates[n].filename | 字符串 | Optional | 标识证书颁发机构PEM文件的名称。 | |||||||||
customCertificates[n].certString | 字符串 | Optional | 构成证书颁发机构链的证书颁发机构PEM文件的内容。 | |||||||||
disableProxyS3 | 布尔 | Optional | 指示连接到 S3 兼容存储时是否应使用 HTTP proxy的标志。 除非将MongoDB Ops Manager配置为使用HTTP proxy ，否则无需设立此值。 | |||||||||
加密凭证 | 布尔 | Optional | 指示此 S 3兼容存储oplog存储的用户名和密码是否使用凭证工具加密的标志。 | |||||||||
id | 字符串 | 必需 | 唯一标识此 S 3兼容存储 oplog 存储的名称。 | |||||||||
labels | 字符串数组 | Optional | 用于管理MongoDB Ops Manager 可以分配给哪些 S3oplog 存储的 备份作业 的标签数组。 设置这些标签会限制此 S 3兼容存储oplog存储可以进程的备份作业。 如果省略，此 S 3兼容存储oplog存储只能进程不使用标签来过滤作业的项目的备份作业。 | |||||||||
pathStyleAccessEnabled | 布尔 | 必需 | 指示此端点样式的标志。
要查看 S3 兼容的存储桶URL 约定，请参阅Amazon Web Services S3 文档。 | |||||||||
s3AuthMethod | 字符串 | Optional | 用于授权访问s3BucketName中指定的 S3 兼容存储桶的方法。 Ops Manager 接受以下值：
| |||||||||
s3BucketEndpoint | 字符串 | 必需 | 用于访问此 S3 兼容存储桶的URL 。 | |||||||||
S3 存储桶名称 | 字符串 | 必需 | 托管 S 3兼容存储 oplog 存储的 S 3兼容存储桶的名称。 | |||||||||
S3 最大连接数 | 数字 | 必需 | 正整数，表示与此 S 3兼容的存储 oplog 存储的最大连接数。 | |||||||||
s3RegionOverride | 字符串 | 可选的 | S3 兼容存储桶所在的地区。 仅当 S3 兼容存储的s3BucketEndpoint不支持地区作用域时，才使用此字段。请勿将此字段与Amazon Web Services S3 存储桶一起使用。 | |||||||||
sseEnabled | 布尔 | 必需 | 指示此 S3 兼容存储 oplog 存储是否启用 服务器端加密的标志。 | |||||||||
ssl | 布尔 | Optional | 指示此 S 3兼容存储 oplog 存储是否仅接受使用TLS加密的连接的标志。 | |||||||||
uri | 字符串 | 必需 | 连接到此 S 兼容存储 存储的元数据数据库的 连接string3 oplog。此数据库将区块的位置存储在 S 3兼容存储桶中。 | |||||||||
writeConcern | 字符串 | Optional |
响应
名称 | 类型 | 说明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
AcceptedTos | 布尔 | 指示您是否接受将 S3 兼容存储与 Ops Manager 一起使用的术语的标志。您必须将其设置为 true才能创建 S3 兼容存储。 | |||||||||
assignEnabled | 布尔 | 指示是否可以将备份作业分配给此数据存储的标志。 | |||||||||
AWS Access Key | 字符串 | 可以访问 s3BucketName 中指定的 S3 兼容存储桶的 Amazon Web Services 访问密钥 ID。 | |||||||||
AWS Secret Key | 字符串 | 可以访问 s3BucketName 中指定的 S3 兼容存储桶的 Amazon Web Services 访问秘密密钥。 | |||||||||
customCertificates | 阵列 | 适用于关联的 S3 兼容存储桶的有效证书颁发机构证书的列表。 | |||||||||
customCertificates[n].filename | 字符串 | 标识证书颁发机构PEM文件的名称。 | |||||||||
customCertificates[n].certString | 字符串 | 构成证书颁发机构链的证书颁发机构PEM文件的内容。 | |||||||||
disableProxyS3 | 布尔 | 指示连接到 S3 兼容存储时是否应使用HTTP proxy的标志。 | |||||||||
加密凭证 | 布尔 | 指示此 S 3兼容存储oplog存储的用户名和密码是否使用凭证工具加密的标志。 | |||||||||
id | 字符串 | 唯一标识此 S 3兼容存储 oplog 存储的名称。 | |||||||||
labels | 字符串数组 | 标签数组，用于管理 可以将哪些 备份作业MongoDB Ops Manager 分配给哪些 S3 兼容存储 存储。oplog | |||||||||
链接 | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。 响应中的所有 | |||||||||
pathStyleAccessEnabled | 布尔 | 指示此端点样式的标志。
要查看 S3 兼容的存储桶URL 约定，请参阅Amazon Web Services S3 文档。 | |||||||||
s3BucketEndpoint | 字符串 | Ops Manager 用于访问此 S3 兼容存储桶的URL 。 | |||||||||
S3 存储桶名称 | 字符串 | 托管 S 3兼容存储 oplog 存储的 S 3兼容存储桶的名称。 | |||||||||
s3RegionOverride | 字符串 | ||||||||||
sseEnabled | 布尔 | 指示此 S3 兼容存储 oplog 存储是否启用 服务器端加密的标志。 | |||||||||
ssl | 布尔 | 指示此 S 3兼容存储 oplog 存储是否仅接受使用TLS加密的连接的标志。 | |||||||||
uri | 字符串 | 连接到此 S 兼容存储 存储的元数据数据库的 连接string3 oplog。此数据库将区块的位置存储在 S 3兼容存储桶中。 | |||||||||
writeConcern | 字符串 |
请求示例
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/oplog/s3Configs?pretty=true' \ 6 --data '{ 7 "assignmentEnabled": true, 8 "awsAccessKey": "access", 9 "awsSecretKey": "secret", 10 "encryptedCredentials": false, 11 "id": "{S3-OPLOG-CONFIG-ID}", 12 "labels": [ 13 "l1", 14 "l2" 15 ], 16 "s3BucketEndpoint": "http://backup.example.com/oplog", 17 "s3BucketName": "oplog", 18 "uri": "mongodb://localhost:27017", 19 "ssl": true, 20 "writeConcern": "W2" 21 }'
响应示例
响应标头
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 "awsAccessKey": "access", 4 "awsSecretKey": "secret", 5 "encryptedCredentials": false, 6 "id": "{S3-OPLOG-CONFIG-ID}", 7 "labels": [ 8 "l1", 9 "l2" 10 ], 11 "links": [ 12 { 13 "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs", 14 "rel": "self" 15 } 16 ], 17 "s3BucketEndpoint": "http://backup.example.com/oplog", 18 "s3BucketName": "oplog", 19 "uri": "mongodb://localhost:27017", 20 "ssl": true, 21 "writeConcern": "W2" 22 }