创建一个 S3 块存储配置

在此页面上

Resource

请求路径参数
请求查询参数
请求正文参数
响应
请求示例
响应示例
响应标头
响应体

MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。尽快升级到更高的MongoDB Ops Manager版本。

配置一个新的 s3 块存储。

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

Resource

POST /snapshot/s3Configs

请求路径参数

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

请求查询参数

以下查询参数为可选参数：

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用 Prettyprint 的标志格式。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称	说明
状态	HTTP 响应代码
envelope	预期响应正文

false

请求正文参数

名称

类型

必要性

说明

AcceptedTos

布尔

必需

标志，表示您是否接受将 S3 兼容存储兼容存储与MongoDB Ops Manager结合使用的服务条款。您必须将其设置为true才能创建 S 3兼容存储兼容的存储。

如果将此值设立为 false， MongoDB Ops Manager将返回错误。该错误表明MongoDB Ops Manager无法创建 S3 兼容的存储兼容存储。

assignEnabled

布尔

Optional

指示是否可以将备份作业分配给此数据存储的标志。

AWS Access Key

字符串

可选的

可以访问 s3BucketName 中指定的 S3 兼容存储桶的 Amazon Web Services 访问密钥 ID。

如果"s3AuthMethod" : "IAM_ROLE" ，则无需包含awsAccessKey 。

AWS Secret Key

字符串

可选的

可以访问<s3BucketName>中指定的 S3 兼容存储桶的AWS访问秘密密钥。

如果"s3AuthMethod" : "IAM_ROLE" ，则无需包含awsSecretKey 。

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 兼容存储块存储的用户名和密码是否使用凭证工具加密。

字符串

必需

唯一标识此S 3快照存储的名称。

labels

字符串数组

Optional

用于管理可以将哪些备份作业MongoDB Ops Manager 分配给哪些 S3 块存储的标签数组。

设置这些标签会限制此 S3 兼容存储块存储可以处理的备份作业。如果省略，此 S3 兼容存储块存储只能处理不使用标签来筛选作业的项目的备份作业。

负载系数

数字

Optional

非零的正整数，表示此快照存储与其他快照存储相比执行的备份工作量。仅当使用多个快照存储时才需要此选项。

要学习；了解有关 Load Factor的详情，请参阅编辑一个现有块存储。

pathStyleAccessEnabled

布尔

必需

指示此端点样式的标志。

值	S3 块存储端点样式	例子
`true`	路径样式URL端点	`s3.amazonaws.com/<bucket>`
`false`	虚拟主机样式URL端点	`<bucket>.s3.amazonaws.com`

要查看 S3 兼容的存储桶URL 约定，请参阅Amazon Web Services S3 文档。

s3AuthMethod

字符串

Optional

用于授权访问s3BucketName中指定的 S3 兼容存储桶的方法。

此选项可接受的值为： KEYS 、 IAM_ROLE 。

`KEYS` 或无	Ops Manager 使用awsAccessKey和awsSecretKey授权访问s3BucketName中指定的 S3 兼容存储桶。
`IAM_ROLE`	MongoDB Ops Manager使用Amazon Web Services IAM角色授权访问s3BucketName中指定的 S3 兼容存储桶。 awsAccessKey和awsSecretKey字段将被忽略。要了解更多信息，请参阅Amazon Web Services 文档

s3BucketEndpoint

字符串

必需

URL用于访问此Amazon Web Services S3 兼容存储或 S3 兼容存储兼容存储桶的。

S3 存储桶名称

字符串

必需

托管与 S3 兼容的存储块存储的与 S3 兼容的存储桶的名称。

S3 最大连接数

数字

必需

正整数，表示与此 S3 兼容存储块存储的最大连接数。

s3RegionOverride

字符串

可选的

S3 兼容存储桶所在的地区。

仅当您的3兼容存储兼容存储的3 BucketEndpoint不支持区域作用域时，才使用此字段。请勿将此字段与Amazon Web Services S3 兼容的存储桶一起使用。

sseEnabled

布尔

必需

指示此 S3 兼容存储块存储是否启用服务器端加密的标志。

ssl

布尔

Optional

标志，指示此 S3 兼容存储块存储是否只接受使用TLS加密的连接。

uri

字符串

必需

连接到此 S3 兼容存储块存储的元数据数据库的连接string 。此数据库将区块的位置存储在Amazon Web Services S3 兼容存储桶中。

writeConcern

字符串

Optional

用于此写关注（write concern）的块存储。

Ops Manager 接受以下值：

ACKNOWLEDGED
W2
JOURNALED
MAJORITY

要学习；了解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 兼容存储块存储的用户名和密码是否使用凭证工具加密。

字符串

唯一标识此 S3 兼容存储块存储的名称。

labels

字符串数组

用于管理可以将哪些备份作业MongoDB Ops Manager 分配给哪些 S3 块存储的标签数组。

链接

对象数组

指向子资源和/或相关资源的一个或多个链接。响应中的所有links数组至少包含一个名为self的链接。 URL 之间的关系在 Web 链接规范中进行了解释。

负载系数

整型

非零的正整数，表示此快照存储与其他快照存储相比执行的备份工作量。仅当使用多个快照存储时才需要此选项。

要学习；了解有关Load Factor的更多信息，请参阅编辑一个现有块存储。

pathStyleAccessEnabled

布尔

指示此端点样式的标志。

值	S3 块存储端点样式	例子
`true`	路径样式URL端点	`s3.amazonaws.com/<bucket>`
`false`	虚拟主机样式URL端点	`<bucket>.s3.amazonaws.com`

要查看 S3 兼容的存储桶URL 约定，请参阅Amazon Web Services S3 文档。

s3AuthMethod

字符串

用于授权访问s3BucketName中指定的 S3 兼容存储桶的方法。

此选项可接受的值为： KEYS 、 IAM_ROLE 。

`KEYS` 或无	Ops Manager 使用`awsAccessKey`和`awsSecretKey`授权访问`s3BucketName`中指定的 S3 兼容存储桶。
`IAM_ROLE`	MongoDB Ops Manager使用Amazon Web Services IAM角色授权访问 `s3BucketName` 中指定的 S3 兼容存储桶。 `awsAccessKey`和`awsSecretKey`字段将被忽略。要了解更多信息，请参阅Amazon Web Services 文档

s3BucketEndpoint

字符串

URLMongoDB Ops Manager用于访问此Amazon Web Services S3 兼容存储或 S3 兼容存储兼容存储桶的。

S3 存储桶名称

字符串

托管与 S3 兼容的存储块存储的与 S3 兼容的存储桶的名称。

S3 最大连接数

整型

正整数，表示与此 S3 兼容存储块存储的最大连接数。

s3RegionOverride

字符串

S 3兼容存储桶所在的区域。仅当您的3兼容存储兼容存储的3 BucketEndpoint不支持区域作用域时，此字段才适用。

MongoDB Ops Manager仅当您在创建或更新此 S 兼容存储块存储存储时包含该字段时，3 才会返回该字段。

sseEnabled

布尔

指示此 S3 兼容存储块存储是否启用服务器端加密的标志。

ssl

布尔

标志，指示此 S3 兼容存储块存储是否只接受使用TLS加密的连接。

uri

字符串

连接到此 S3 兼容存储块存储的元数据数据库的连接string 。此数据库将区块的位置存储在Amazon Web Services S3 兼容存储桶中。

writeConcern

字符串

用于此写关注（write concern）的块存储。

Ops Manager 返回以下值之一：

ACKNOWLEDGED
W2
JOURNALED
MAJORITY

要学习；了解MongoDB中的写入确认级别，请参阅写关注。

请求示例

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://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true' \
6      --data '{
7        "id": "{S3-BLOCKSTORE-CONFIG-ID}",
8        "assignmentEnabled": true,
9        "pathStyleAccessEnabled": false,
10        "awsAccessKey": "<access>",
11        "awsSecretKey": "<secret>",
12        "acceptedTos": true,
13        "customCertificates" : [{
14          "filename" : "CA.pem",
15          "certString" : "-----BEGIN CERTIFICATE-----\nMIIDljCCAn4CCQDJjCHAkAafFTANBgkqhkiG9w0BAQsFADCBjDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAk5ZMQwwCgYDVQQHDANOWUMxEDAOBgNVBAoMB01vbmdvREIx\nDDAKBgNVBAsMA1NXRTEZMBcGA1UEAwwQZXJpbm1jbnVsdHkudGVjaDEnMCUGCSqG\nSIb3DQEJARYYZXJpbi5tY251bHR5QG1vbmdvZGIuY29tMB4XDTIxMDYxMTE1MzY0\nMVoXDTIxMDcxMTE1MzY0MVowgYwxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOWTEM\nMAoGA1UEBwwDTllDMRAwDgYDVQQKDAdNb25nb0RCMQwwCgYDVQQLDANTV0UxGTAX\nBgNVBAMMEGVyaW5tY251bHR5LnRlY2gxJzAlBgkqhkiG9w0BCQEWGGVyaW4ubWNu\ndWx0eUBtb25nb2RiLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAOoAv1btxcEgDOdCgyz+/NtyFwa0h/3yGtj+WK7nMzcEntnxG5apHVRZ6eQ4ayZU\nhZNPbNWtcsbTEiRWyywMAd7/DbIa9GhsP1/P6Cv+TnO2krx8qVKQN93j8cme/b6g\n+yeEWMAM2rvfXq/fRTtJbH1Y6c4mYh4312mPrlEfgvAUQZh3DpJQNIVZ5MM2imp0\nfBgcggrNHUniLCT8ogUA4QII8CKIC4ONX4TNtXbsNtcCzKNqvOdcvWXLTYEJav34\nlaJs1YWJx2PSufgHo+JZUeANwwpztkYhr3nUGTD8fr7JF9CO7UlFBTFqs+PeaTJV\nEbnrF26NimsAmRgRPNLE170CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAe5hAkrhz\nClXg4HPq6U3ONEUVUqQ231gogeUIIQsfn4K89QIFnsm0DC1lE21qHNcD3iHECmDJ\n9R2tXdA0shbc+hM8OHbEW6U31dLrM369PUQmw0GOkFWlYHnX4ySt+zMAjlIrQe7C\nLErYSuLDpjuKvkdpvbcwgkarB9/FPCOhORpAZqduhwUOr28tZzT3/8L7w//+7Yhy\n5ihKgTcP/CmJ+MgLlZqBtQ7lkmKDWXIUlLSRDHEciVGSXgZBreUciNFeMHVvoluc\ndxdsxqMcXgyXwmv7Ck7tCjYRwzwlf3TrcKt8QFijWTbl1Z/3d0/zpjuvR21J0z/3\ns4tNMtQdG6/bHA==\n-----END CERTIFICATE-----"
16        }],
17        "encryptedCredentials": false,
18        "loadFactor": 1,
19        "s3AuthMethod": "KEYS",
20        "s3BucketEndpoint": "s3.amazonaws.com",
21        "s3BucketName": "bucketname",
22        "s3MaxConnections": 50,
23        "sseEnabled": true,
24        "uri": "mongodb://127.0.0.1:27017",
25        "ssl": false,
26        "writeConcern": "ACKNOWLEDGED"
27      }'

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://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true' \
6      --data '{
7         "id": "{S3-BLOCKSTORE-CONFIG-ID}",
8         "assignmentEnabled": true,
9         "pathStyleAccessEnabled": false,
10         "acceptedTos": true,
11         "encryptedCredentials": false,
12         "loadFactor": 1,
13         "s3AuthMethod": "IAM_ROLE",
14         "s3BucketEndpoint": "s3.amazonaws.com",
15         "s3BucketName": "bucketname",
16         "s3MaxConnections": 50,
17         "sseEnabled": true,
18         "uri": "mongodb://127.0.0.1:27017",
19         "ssl": false,
20         "writeConcern": "ACKNOWLEDGED"
21      }'

响应示例

响应标头

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   "acceptedTos": true,
3   "assignmentEnabled": true,
4   "awsAccessKey": "<access>",
5   "awsSecretKey": "<secret>",
6   "customCertificates" : [{
7     "filename" : "CA.pem",
8     "certString" : "-----BEGIN CERTIFICATE-----\nMIIDljCCAn4CCQDJjCHAkAafFTANBgkqhkiG9w0BAQsFADCBjDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAk5ZMQwwCgYDVQQHDANOWUMxEDAOBgNVBAoMB01vbmdvREIx\nDDAKBgNVBAsMA1NXRTEZMBcGA1UEAwwQZXJpbm1jbnVsdHkudGVjaDEnMCUGCSqG\nSIb3DQEJARYYZXJpbi5tY251bHR5QG1vbmdvZGIuY29tMB4XDTIxMDYxMTE1MzY0\nMVoXDTIxMDcxMTE1MzY0MVowgYwxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOWTEM\nMAoGA1UEBwwDTllDMRAwDgYDVQQKDAdNb25nb0RCMQwwCgYDVQQLDANTV0UxGTAX\nBgNVBAMMEGVyaW5tY251bHR5LnRlY2gxJzAlBgkqhkiG9w0BCQEWGGVyaW4ubWNu\ndWx0eUBtb25nb2RiLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAOoAv1btxcEgDOdCgyz+/NtyFwa0h/3yGtj+WK7nMzcEntnxG5apHVRZ6eQ4ayZU\nhZNPbNWtcsbTEiRWyywMAd7/DbIa9GhsP1/P6Cv+TnO2krx8qVKQN93j8cme/b6g\n+yeEWMAM2rvfXq/fRTtJbH1Y6c4mYh4312mPrlEfgvAUQZh3DpJQNIVZ5MM2imp0\nfBgcggrNHUniLCT8ogUA4QII8CKIC4ONX4TNtXbsNtcCzKNqvOdcvWXLTYEJav34\nlaJs1YWJx2PSufgHo+JZUeANwwpztkYhr3nUGTD8fr7JF9CO7UlFBTFqs+PeaTJV\nEbnrF26NimsAmRgRPNLE170CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAe5hAkrhz\nClXg4HPq6U3ONEUVUqQ231gogeUIIQsfn4K89QIFnsm0DC1lE21qHNcD3iHECmDJ\n9R2tXdA0shbc+hM8OHbEW6U31dLrM369PUQmw0GOkFWlYHnX4ySt+zMAjlIrQe7C\nLErYSuLDpjuKvkdpvbcwgkarB9/FPCOhORpAZqduhwUOr28tZzT3/8L7w//+7Yhy\n5ihKgTcP/CmJ+MgLlZqBtQ7lkmKDWXIUlLSRDHEciVGSXgZBreUciNFeMHVvoluc\ndxdsxqMcXgyXwmv7Ck7tCjYRwzwlf3TrcKt8QFijWTbl1Z/3d0/zpjuvR21J0z/3\ns4tNMtQdG6/bHA==\n-----END CERTIFICATE-----"
9   }],
10   "encryptedCredentials": false,
11   "id": "{S3-BLOCKSTORE-CONFIG-ID}",
12   "links": [
13     {
14       "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs",
15       "rel": "self"
16     }
17   ],
18   "loadFactor": 1,
19   "pathStyleAccessEnabled": false,
20   "s3AuthMethod": "KEYS",
21   "s3BucketEndpoint": "s3.amazonaws.com",
22   "s3BucketName": "bucketname",
23   "s3MaxConnections": 50,
24   "sseEnabled": true,
25   "ssl": false,
26   "uri": "mongodb://127.0.0.1:27017",
27   "writeConcern": "ACKNOWLEDGED"
28 }

1 {
2   "acceptedTos": true,
3   "assignmentEnabled": true,
4   "encryptedCredentials": false,
5   "id": "{S3-BLOCKSTORE-CONFIG-ID}",
6   "links": [
7     {
8       "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs",
9       "rel": "self"
10     }
11   ],
12   "loadFactor": 1,
13   "pathStyleAccessEnabled": false,
14   "s3AuthMethod": "IAM_ROLE",
15   "s3BucketEndpoint": "s3.amazonaws.com",
16   "s3BucketName": "bucketname",
17   "s3MaxConnections": 50,
18   "sseEnabled": true,
19   "ssl": false,
20   "uri": "mongodb://127.0.0.1:27017",
21   "writeConcern": "ACKNOWLEDGED"
22 }

后退

获取所有 S3 块存储配置

来年

更新一个 S3 块存储配置

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://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true' \
6	--data '{
7	"id": "{S3-BLOCKSTORE-CONFIG-ID}",
8	"assignmentEnabled": true,
9	"pathStyleAccessEnabled": false,
10	"awsAccessKey": "<access>",
11	"awsSecretKey": "<secret>",
12	"acceptedTos": true,
13	"customCertificates" : [{
14	"filename" : "CA.pem",
15	"certString" : "-----BEGIN CERTIFICATE-----\nMIIDljCCAn4CCQDJjCHAkAafFTANBgkqhkiG9w0BAQsFADCBjDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAk5ZMQwwCgYDVQQHDANOWUMxEDAOBgNVBAoMB01vbmdvREIx\nDDAKBgNVBAsMA1NXRTEZMBcGA1UEAwwQZXJpbm1jbnVsdHkudGVjaDEnMCUGCSqG\nSIb3DQEJARYYZXJpbi5tY251bHR5QG1vbmdvZGIuY29tMB4XDTIxMDYxMTE1MzY0\nMVoXDTIxMDcxMTE1MzY0MVowgYwxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOWTEM\nMAoGA1UEBwwDTllDMRAwDgYDVQQKDAdNb25nb0RCMQwwCgYDVQQLDANTV0UxGTAX\nBgNVBAMMEGVyaW5tY251bHR5LnRlY2gxJzAlBgkqhkiG9w0BCQEWGGVyaW4ubWNu\ndWx0eUBtb25nb2RiLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAOoAv1btxcEgDOdCgyz+/NtyFwa0h/3yGtj+WK7nMzcEntnxG5apHVRZ6eQ4ayZU\nhZNPbNWtcsbTEiRWyywMAd7/DbIa9GhsP1/P6Cv+TnO2krx8qVKQN93j8cme/b6g\n+yeEWMAM2rvfXq/fRTtJbH1Y6c4mYh4312mPrlEfgvAUQZh3DpJQNIVZ5MM2imp0\nfBgcggrNHUniLCT8ogUA4QII8CKIC4ONX4TNtXbsNtcCzKNqvOdcvWXLTYEJav34\nlaJs1YWJx2PSufgHo+JZUeANwwpztkYhr3nUGTD8fr7JF9CO7UlFBTFqs+PeaTJV\nEbnrF26NimsAmRgRPNLE170CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAe5hAkrhz\nClXg4HPq6U3ONEUVUqQ231gogeUIIQsfn4K89QIFnsm0DC1lE21qHNcD3iHECmDJ\n9R2tXdA0shbc+hM8OHbEW6U31dLrM369PUQmw0GOkFWlYHnX4ySt+zMAjlIrQe7C\nLErYSuLDpjuKvkdpvbcwgkarB9/FPCOhORpAZqduhwUOr28tZzT3/8L7w//+7Yhy\n5ihKgTcP/CmJ+MgLlZqBtQ7lkmKDWXIUlLSRDHEciVGSXgZBreUciNFeMHVvoluc\ndxdsxqMcXgyXwmv7Ck7tCjYRwzwlf3TrcKt8QFijWTbl1Z/3d0/zpjuvR21J0z/3\ns4tNMtQdG6/bHA==\n-----END CERTIFICATE-----"
16	}],
17	"encryptedCredentials": false,
18	"loadFactor": 1,
19	"s3AuthMethod": "KEYS",
20	"s3BucketEndpoint": "s3.amazonaws.com",
21	"s3BucketName": "bucketname",
22	"s3MaxConnections": 50,
23	"sseEnabled": true,
24	"uri": "mongodb://127.0.0.1:27017",
25	"ssl": false,
26	"writeConcern": "ACKNOWLEDGED"
27	}'