创建一个 S3 块存储配置
配置一个新的 s3 块存储。
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
资源
POST /snapshot/s3Configs
请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
以下查询参数为可选参数：
请求正文参数
名称 | 类型 | 必要性 | 说明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
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的标志。除非将 Ops Manager 配置为使用 HTTP proxy，否则无需设置此值。 | |||||||||
加密凭证 | 布尔 | Optional | 标志，指示此 S3 兼容存储块存储的用户名和密码是否使用凭证工具加密。 | |||||||||
id | 字符串 | 必需 | 唯一标识此S 3快照存储的名称。 | |||||||||
labels | 字符串数组 | Optional | ||||||||||
负载系数 | 数字 | Optional | 非零的正整数，表示此快照存储与其他快照存储相比执行的备份工作量。仅当使用多个快照存储时才需要此选项。 提示另请参阅：要了解有关 Load Factor的更多信息，请参阅编辑现有 S3 块存储 | |||||||||
pathStyleAccessEnabled | 布尔 | 必需 | 指示此端点样式的标志。
要查看 S3 兼容的存储桶 URL 约定，请参阅 AWS S3 文档。 | |||||||||
s3AuthMethod | 字符串 | Optional | 用于授权访问s3BucketName中指定的 S3 兼容存储桶的方法。 此选项可接受的值为：
| |||||||||
s3BucketEndpoint | 字符串 | 必需 | 用于访问此 S3 兼容存储桶的URL 。 | |||||||||
S3 存储桶名称 | 字符串 | 必需 | 托管与 S3 兼容的存储块存储的与 S3 兼容的存储桶的名称。 | |||||||||
S3 最大连接数 | 数字 | 必需 | 正整数，表示与此 S3 兼容存储块存储的最大连接数。 | |||||||||
s3RegionOverride | 字符串 | 可选的 | S3 兼容存储桶所在的地区。 仅当 S3 兼容存储的s3BucketEndpoint不支持地区作用域时，才使用此字段。请勿将此字段与Amazon Web Services S3 存储桶一起使用。 | |||||||||
sseEnabled | 布尔 | 必需 | 指示此 S3 兼容存储块存储是否启用 服务器端加密的标志。 | |||||||||
ssl | 布尔 | Optional | 标志，指示此 S3 兼容存储块存储是否只接受使用TLS加密的连接。 | |||||||||
uri | 字符串 | 必需 | 连接到此 S 3兼容存储块存储的元数据数据库的连接字符串。此数据库将区块的位置存储在AWS S 3兼容存储桶中。 | |||||||||
writeConcern | 字符串 | Optional | 用于此写关注（write concern）的块存储。 Ops Manager 接受以下值：
提示另请参阅：要了解 MongoDB 中的写入确认级别，请参阅写关注 |
响应
名称 | 类型 | 说明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
AcceptedTos | 布尔 | 标志，表示您是否接受通过 Ops Manager 使用 S3 兼容存储的术语。您必须将其设置为 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的标志。 | |||||||||
加密凭证 | 布尔 | 标志，指示此 S3 兼容存储块存储的用户名和密码是否使用凭证工具加密。 | |||||||||
id | 字符串 | 唯一标识此 S3 兼容存储块存储的名称。 | |||||||||
labels | 字符串数组 | ||||||||||
链接 | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。响应中的所有 | |||||||||
负载系数 | 整型 | 非零的正整数，表示此快照存储与其他快照存储相比执行的备份工作量。仅当使用多个快照存储时才需要此选项。 提示另请参阅：要了解有关Load Factor的更多信息，请参阅编辑现有 |s3|块存储 | |||||||||
pathStyleAccessEnabled | 布尔 | 指示此端点样式的标志。
要查看 S3 兼容的存储桶 URL 约定，请参阅 AWS S3 文档。 | |||||||||
s3AuthMethod | 字符串 | 用于授权访问 此选项可接受的值为：
| |||||||||
s3BucketEndpoint | 字符串 | Ops Manager 用于访问此 S3 兼容存储桶的URL 。 | |||||||||
S3 存储桶名称 | 字符串 | 托管与 S3 兼容的存储块存储的与 S3 兼容的存储桶的名称。 | |||||||||
S3 最大连接数 | 整型 | 正整数，表示与此 S3 兼容存储块存储的最大连接数。 | |||||||||
s3RegionOverride | 字符串 | ||||||||||
sseEnabled | 布尔 | 指示此 S3 兼容存储块存储是否启用 服务器端加密的标志。 | |||||||||
ssl | 布尔 | 标志，指示此 S3 兼容存储块存储是否只接受使用TLS加密的连接。 | |||||||||
uri | 字符串 | 连接到此 S 3兼容存储块存储的元数据数据库的连接字符串。此数据库将区块的位置存储在AWS S 3兼容存储桶中。 | |||||||||
writeConcern | 字符串 | 用于此写关注（write concern）的块存储。 Ops Manager 返回以下值之一：
提示另请参阅：要了解 MongoDB 中的写入确认级别，请参阅写关注 |
请求示例
响应示例
响应标头
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}