对于 AI 代理:可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。
Docs 菜单

创建一个 S3 块存储配置

配置一个新的 s3 块存储。

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

POST /snapshot/s3Configs

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

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

名称
类型
必要性
说明
默认

pretty

布尔

Optional

Flag indicating whether the response body is in a prettyprint format.

false

envelope

布尔

Optional

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

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

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

  • status: HTTP response code

  • content:预期响应正文

false

名称
类型
必要性
说明

AcceptedTos

布尔

必需

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

如果将此设置为false ,Ops Manager 将返回错误。该错误表明 Ops Manager 无法创建 S3 兼容存储。

assignEnabled

布尔

Optional

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

AWS Access Key

字符串

可选的

可以访问权限s3BucketName 中指定的 S3 兼容存储桶的 AWS 访问密钥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的标志。除非将 Ops Manager 配置为使用 HTTP proxy,否则无需设置此值。

加密凭证

布尔

Optional

标志,指示此 S3 兼容存储块存储的用户名和密码是否使用凭证工具加密。

id

字符串

必需

labels

字符串数组

Optional

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

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

负载系数

数字

Optional

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

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

objectLockEnabled

布尔

Optional

标志,指示是否启用对象锁以防止 S3 存储桶中的对象被删除。

OIDC

对象

Optional

可选。 OIDC authentication settings for this store. The oidc object accepts the following fields:

  • enabled: boolean. Enables OIDC authentication for this store.

  • method: string.callbackazuregcpk8s之一。

  • tokenUri: string. The IdP token endpoint. Required when method is callback.

  • clientId: string. The client ID registered with the IdP. Required when method is callback; optional when method is azure.

  • clientSecret: string. The client secret registered with the IdP. Required when method is callback. If you edit an existing store and omit this field or submit the redacted value returned by a previous GET request, Ops Manager preserves the existing secret.

  • scope:字符串。从 IdP 请求的 OAuth2 范围。仅当 methodcallback 时使用。

  • tokenResource: string. The audience or resource identifier for the workload identity token. Required when method is azure or gcp. This value must match the audience configured for this IdP in the target MongoDB deployment's oidcIdentityProviders setting.

callbackazuregcpk8s 方法并不都需要相同的字段。azuregcpk8s 方法不需要 clientSecret

oidc.enabledtrue 时,在存储的 uri 字段中仅提供主机和连接选项。MongoDB Ops Manager 会忽略嵌入 URI 中的任何用户名或密码。

To switch a store from OIDC to another authentication mechanism, submit oidc: {enabled: false} in the request instead of omitting the oidc object.

pathStyleAccessEnabled

布尔

必需

指示此端点样式的标志。

S3 块存储端点样式
例子

true

路径样式URL端点

s3.amazonaws.com/<bucket>

false

虚拟主机样式URL端点

<bucket>.s3.amazonaws.com

要查看与 S3 兼容的存储桶URL约定,请参阅 AWS S3 文档。

s3AuthMethod

字符串

Optional

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

此选项可接受的值为: KEYSIAM_ROLE

KEYS 或无

Ops Manager 使用awsAccessKeyawsSecretKey授权访问s3BucketName中指定的 S3 兼容存储桶。

IAM_ROLE

Ops Manager使用 AWS IAM角色授权访问权限s3BucketName 中指定的 S3 兼容存储桶。 awsAccessKey awsSecretKey 字段将被忽略。要学习;了解更多信息,请参阅 AWS 文档

s3BucketEndpoint

字符串

必需

用于访问权限此 S3 兼容存储桶的URL 。

S3 存储桶名称

字符串

必需

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

S3 最大连接数

数字

必需

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

s3RegionOverride

字符串

可选的

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

仅当 S3 兼容存储的 s3BucketEndpoint 不支持地区作用域时,才使用此字段。请勿将此字段与 AWS S3 存储桶一起使用。

sseEnabled

布尔

必需

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

ssl

布尔

Optional

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

uri

字符串

必需

连接到此 S3 兼容存储块存储存储的元数据数据库的连接字符串。该数据库将区块的位置存储在与 AWS S3 兼容的存储桶中。

writeConcern

字符串

Optional

用于此写关注(write concern)的块存储。

Ops Manager 接受以下值:

  • ACKNOWLEDGED

  • W2

  • JOURNALED

  • MAJORITY

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

名称
类型
说明

AcceptedTos

布尔

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

assignEnabled

布尔

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

AWS Access Key

字符串

AWS Access Key ID that can access the S3-compatible storage bucket specified in s3BucketName.

AWS Secret Key

字符串

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

customCertificates

阵列

适用于关联的 S3 兼容存储桶的有效证书颁发机构证书的列表。

customCertificates[n].filename

字符串

标识证书颁发机构PEM文件的名称。

customCertificates[n].certString

字符串

构成证书颁发机构链的证书颁发机构PEM文件的内容。

disableProxyS3

布尔

指示连接到 S3 兼容存储时是否使用 HTTP proxy 的标志。

加密凭证

布尔

标志,指示此 S3 兼容存储块存储的用户名和密码是否使用凭证工具加密。

id

字符串

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

labels

字符串数组

Array of tags to manage which backup jobs Ops Manager can assign to which S3 blockstores.

链接

对象数组

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

负载系数

整型

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

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

objectLockEnabled

布尔

标志,指示是否启用对象锁以防止 S3 存储桶中的对象被删除。

OIDC

对象

OIDC authentication settings for this store. The oidc object contains the following fields:

  • enabled: boolean. Indicates whether OIDC authentication is enabled for this store.

  • method: string.callbackazuregcpk8s之一。

  • tokenUri: string. The IdP token endpoint. Present only when method is callback.

  • clientId: string. The client ID registered with the IdP.

  • clientSecret: string.MongoDB Ops Manager 在响应中对此值进行编辑,并不返回原始客户端秘密。

  • scope:字符串。从 IdP 请求的 OAuth2 范围。仅当 methodcallback 时才出现。

  • tokenResource: string.工作负载身份标记的受众或资源标识符。仅在 methodazuregcp 时出现。

pathStyleAccessEnabled

布尔

指示此端点样式的标志。

S3 块存储端点样式
例子

true

路径样式URL端点

s3.amazonaws.com/<bucket>

false

虚拟主机样式URL端点

<bucket>.s3.amazonaws.com

To review the S3-compatible storage bucket URL conventions, see the AWS S3 documentation.

s3AuthMethod

字符串

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

此选项可接受的值为: KEYSIAM_ROLE

KEYS 或无

Ops Manager 使用awsAccessKeyawsSecretKey授权访问s3BucketName中指定的 S3 兼容存储桶。

IAM_ROLE

Ops Manager使用 AWS IAM角色授权访问权限s3BucketName 中指定的 S3 兼容存储桶。 awsAccessKeyawsSecretKey 字段将被忽略。要学习;了解更多信息,请参阅 AWS 文档

s3BucketEndpoint

字符串

Ops Manager用于访问权限此与 S3 兼容的存储桶的URL 。

S3 存储桶名称

字符串

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

S3 最大连接数

整型

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

s3RegionOverride

字符串

S3 兼容存储桶所在的地区。仅当 S3 兼容存储存储的s3BucketEndpoint不支持地区作用域时,此字段才适用。

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

sseEnabled

布尔

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

ssl

布尔

Flag that indicates whether this S3-compatible storage blockstore only accepts connections encrypted using TLS.

uri

字符串

Connection String that connects to the metadata database for this S3-compatible storage blockstore. This database stores the locations of the blocks in the AWS S3-compatible storage bucket.

writeConcern

字符串

用于此写关注(write concern)的块存储。

Ops Manager 返回以下值之一:

  • ACKNOWLEDGED

  • W2

  • JOURNALED

  • MAJORITY

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

1curl --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 }'
1curl --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}