更新一个 S3 块存储配置
更新一个 s3 块存储的配置。
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
PUT /snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}
请求路径参数
名称 | 类型 | 说明 |
|---|---|---|
S3-BLOCKSTORE-CONFIG-ID | 字符串 | 标记此 S3 块存储配置的唯一名称。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
| false |
请求正文参数
名称 | 类型 | 必要性 | 说明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
AcceptedTos | 布尔 | 必需 | 标志，表示您是否接受将 S3 兼容存储兼容存储与MongoDB 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 | 标志，指示此 S3 兼容存储块存储的用户名和密码是否使用凭证工具加密。 | |||||||||
labels | 字符串数组 | Optional | 用于管理 可以将哪些 备份作业MongoDB Ops Manager 分配给哪些 S3 块存储的标签数组。 设置这些标签会限制此 S3 兼容存储块存储可以处理的备份作业。 如果省略，此 S3 兼容存储块存储只能处理不使用标签来筛选作业的项目的备份作业。 | |||||||||
负载系数 | 数字 | Optional | 非零的正整数，表示此快照存储与其他快照存储相比执行的备份工作量。 仅当使用多个快照存储时才需要此选项。 要学习；了解有关 Load Factor的详情，请参阅编辑一个现有块存储。 | |||||||||
pathStyleAccessEnabled | 布尔 | 必需 | 指示此端点样式的标志。
要查看 S3 兼容的存储桶URL 约定，请参阅Amazon Web Services S3 文档。 | |||||||||
s3AuthMethod | 字符串 | Optional | 用于授权访问s3BucketName中指定的 S3 兼容存储桶的方法。 Ops Manager 接受以下值：
| |||||||||
s3BucketEndpoint | 字符串 | 必需 | URL用于访问此Amazon Web Services S3 兼容存储或 S3 兼容存储兼容存储桶的 。 | |||||||||
S3 存储桶名称 | 字符串 | 必需 | 托管与 S3 兼容的存储块存储的与 S3 兼容的存储桶的名称。 | |||||||||
S3 最大连接数 | 数字 | 必需 | 正整数，表示与此 S3 兼容存储块存储的最大连接数。 | |||||||||
s3RegionOverride | 字符串 | 可选的 | S3 兼容存储桶所在的地区。 仅当您的3兼容存储兼容存储的3 BucketEndpoint不支持区域作用域时，才使用此字段。 请勿将此字段与Amazon Web Services S3 兼容的存储桶一起使用。 | |||||||||
sseEnabled | 布尔 | 必需 | 指示此 S3 兼容存储块存储是否启用 服务器端加密的标志。 | |||||||||
uri | 字符串 | 必需 | 以逗号分隔的主机列表，采用 <hostname:port>格式，可以访问此 S3 兼容存储块存储。 | |||||||||
ssl | 布尔 | Optional | 标志，指示此 S3 兼容存储块存储是否只接受使用TLS加密的连接。 | |||||||||
writeConcern | 字符串 | Optional | 用于此写关注（write concern）的块存储。 Ops Manager 接受以下值：
要学习；了解MongoDB中的写入确认级别，请参阅写关注。 |
响应
名称 | 类型 | 说明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
AcceptedTos | 布尔 | 标志，表示您是否接受将 S3 兼容存储兼容存储与MongoDB Ops Manager结合使用的服务条款。 您必须将其设置为 true才能创建 S 3兼容存储兼容的存储。 | |||||||||
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 | 字符串数组 | 用于管理 可以将哪些 备份作业MongoDB Ops Manager 分配给哪些 S3 块存储的标签数组。 | |||||||||
链接 | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。 响应中的所有 | |||||||||
负载系数 | 整型 | 非零的正整数，表示此快照存储与其他快照存储相比执行的备份工作量。 仅当使用多个快照存储时才需要此选项。 要学习；了解有关Load Factor的更多信息，请参阅编辑一个现有块存储。 | |||||||||
pathStyleAccessEnabled | 布尔 | 指示此端点样式的标志。
要查看 S3 兼容的存储桶URL 约定，请参阅Amazon Web Services S3 文档。 | |||||||||
s3AuthMethod | 字符串 | 用于授权访问 此选项可接受的值为：
| |||||||||
s3BucketEndpoint | 字符串 | URLMongoDB Ops Manager用于访问此Amazon Web Services S3 兼容存储或 S3 兼容存储兼容存储桶的 。 | |||||||||
S3 存储桶名称 | 字符串 | 托管与 S3 兼容的存储块存储的与 S3 兼容的存储桶的名称。 | |||||||||
S3 最大连接数 | 整型 | 正整数，表示与此 S3 兼容存储块存储的最大连接数。 | |||||||||
s3RegionOverride | 字符串 | ||||||||||
sseEnabled | 布尔 | 指示此 S3 兼容存储块存储是否启用 服务器端加密的标志。 | |||||||||
ssl | 布尔 | 标志，指示此 S3 兼容存储块存储是否只接受使用TLS加密的连接。 | |||||||||
uri | 字符串 | 连接到此 S3 兼容存储块存储的元数据数据库的连接string 。 此数据库将区块的位置存储在Amazon Web Services S3 兼容存储桶中。 | |||||||||
writeConcern | 字符串 | 用于此写关注（write concern）的块存储。 Ops Manager 返回以下值之一：
要学习；了解MongoDB中的写入确认级别，请参阅写关注。 |
请求示例
1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ 2 --header 'Accept: application/json' \ 3 --header 'Content-Type: application/json' \ 4 --include \ 5 --request PUT 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true' \ 6 --data '{ 7 "assignmentEnabled": true, 8 "awsAccessKey": "<access>", 9 "awsSecretKey": "<secret>", 10 "encryptedCredentials": false, 11 "labels": [ 12 "l1", 13 "l2" 14 ], 15 "loadFactor": 50, 16 "s3BucketEndpoint": "http://example.com/backupbucket", 17 "s3BucketName": "bucketname", 18 "uri": "mongodb://localhost:27017", 19 "ssl": true, 20 "writeConcern": "W2" 21 }'
1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ 2 --header 'Accept: application/json' \ 3 --header 'Content-Type: application/json' \ 4 --include \ 5 --request PUT 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true' \ 6 --data '{ 7 "assignmentEnabled": true, 8 "encryptedCredentials": false, 9 "labels": [ 10 "l1", 11 "l2" 12 ], 13 "loadFactor": 50, 14 "s3AuthMethod": "IAM_ROLE", 15 "s3BucketEndpoint": "http://example.com/backupbucket", 16 "s3BucketName": "bucketname", 17 "uri": "mongodb://localhost:27017", 18 "ssl": true, 19 "writeConcern": "W2" 20 }'
响应示例
响应标头
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 "acceptedTos": true, 3 "assignmentEnabled": true, 4 "awsAccessKey": "<access>", 5 "awsSecretKey": "<secret>", 6 "encryptedCredentials": false, 7 "id": "{S3-BLOCKSTORE-CONFIG-ID}", 8 "labels": [ 9 "l1", 10 "l2" 11 ], 12 "links": [ 13 { 14 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs", 15 "rel": "self" 16 } 17 ], 18 "loadFactor": 50, 19 "pathStyleAccessEnabled": false, 20 "s3AuthMethod": "KEYS", 21 "s3BucketEndpoint": "http://example.com/backupbucket", 22 "s3BucketName": "bucketname", 23 "s3MaxConnections": 50, 24 "sseEnabled": true, 25 "ssl": false, 26 "uri": "mongodb://127.0.0.1:27017", 27 "writeConcern": "W2" 28 }
1 { 2 "acceptedTos": true, 3 "assignmentEnabled": true, 4 "encryptedCredentials": false, 5 "id": "{S3-BLOCKSTORE-CONFIG-ID}", 6 "labels": [ 7 "l1", 8 "l2" 9 ], 10 "links": [ 11 { 12 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs", 13 "rel": "self" 14 } 15 ], 16 "loadFactor": 50, 17 "pathStyleAccessEnabled": false, 18 "s3AuthMethod": "IAM_ROLE", 19 "s3BucketEndpoint": "http://example.com/backupbucket", 20 "s3BucketName": "bucketname", 21 "s3MaxConnections": 50, 22 "sseEnabled": true, 23 "ssl": false, 24 "uri": "mongodb://127.0.0.1:27017", 25 "writeConcern": "W2" 26 }