通过 ID 获取一个 S3 块存储配置

检索一个 S3块存储的配置。

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

Resource

GET /snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}

请求路径参数

名称	类型	说明
S3-BLOCKSTORE-CONFIG-ID	字符串	标记此 S3 块存储配置的唯一名称。

请求查询参数

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

名称	类型	必要性	说明	默认
pretty	布尔	Optional	指示响应正文是否采用美观打印格式的标志。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。对于返回一个结果的端点，响应体包括： `status`： HTTP响应代码 `content`：预期响应正文	`false`

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

名称	类型	说明
AcceptedTos	布尔	指示您是否接受将 S3 兼容存储与 MongoDB Ops Manager 结合使用的服务条款的标志。必须将其设置为 `true` 才能创建 S3 兼容存储库。
assignEnabled	布尔	指示是否可以将备份作业分配给此数据存储的标志。
AWS Access Key	字符串	可以访问权限s3BucketName 中指定的 S3 兼容存储桶的 AWS 访问密钥ID 。
AWS Secret Key	字符串	可以访问权限s3BucketName 中指定的 S3 兼容存储桶的 AWS 访问秘密密钥。
customCertificates	阵列	适用于关联的 S3 兼容存储桶的有效证书颁发机构证书的列表。
customCertificates[n].filename	字符串	标识证书颁发机构PEM文件的名称。
customCertificates[n].certString	字符串	构成证书颁发机构链的证书颁发机构PEM文件的内容。
disableProxyS3	布尔	指示连接到 S3 兼容存储时是否使用 HTTP proxy 的标志。
加密凭证	布尔	标志，指示此 S3 兼容存储块存储的用户名和密码是否使用凭证工具加密。
id	字符串	唯一标识此 S3 兼容存储块存储的名称。
labels	字符串数组	用于管理Ops Manager可以将哪些备份作业分配给哪些 S3 块存储的标签数组。
链接	对象数组	指向子资源或相关资源的一个或多个链接。响应中的所有 `links` 数组至少包含一个名为 `self` 的链接。URL之间的关系在 Web 链接规范中进行了解释。
负载系数	整型	非零的正整数，表示此快照存储与其他快照存储相比执行的备份工作量。仅当使用多个快照存储时才需要此选项。要学习；了解有关Load Factor的更多信息，请参阅编辑一个现有块存储。
objectLockEnabled	布尔	标志，指示是否启用对象锁以防止 S3 存储桶中的对象被删除。
OIDC	对象	此存储的 OIDC身份验证设置。 `oidc`对象包含以下字段： `enabled`：布尔值。指示是否为此存储启用了 OIDC身份验证。 `method`: string.`callback`、`azure`、`gcp`或`k8s`之一。 `tokenUri`：字符串。 IdP 令牌端点。仅当 `method` 为 `callback` 时才出现。 `clientId`：字符串。向 IdP 注册的客户端ID 。 `clientSecret`: string.MongoDB Ops Manager 在响应中对此值进行编辑，并不返回原始客户端秘密。 `scope`：字符串。从 IdP 请求的 OAuth2 范围。仅当 `method` 为 `callback` 时出现。 `tokenResource`: string.工作负载身份标记的受众或资源标识符。仅在 `method` 为 `azure` 或 `gcp` 时出现。
pathStyleAccessEnabled	布尔	指示此端点样式的标志。 `true`：路径样式的URL端点。示例：`s3.amazonaws.com/<bucket>` `false`：虚拟主机样式的URL端点。示例：`<bucket>.s3.amazonaws.com` 要查看S3 兼容的存储桶URL约定，请参阅 AWS S3 文档。
s3AuthMethod	字符串	用于授权访问`s3BucketName`中指定的 S3 兼容存储桶的方法。此选项可接受的值为： `KEYS` 、 `IAM_ROLE` 。 `KEYS` 或无： Ops Manager使用 `awsAccessKey` 和 `awsSecretKey` 授权对 `s3BucketName` 中指定的 S3 兼容存储桶的访问权限。 `IAM_ROLE`： Ops Manager使用 AWS IAM角色授权访问权限`s3BucketName` 中指定的与 S3 兼容的存储桶。 `awsAccessKey` 和 `awsSecretKey` 字段将被忽略。要学习；了解更多信息，请参阅 AWS 文档
s3BucketEndpoint	字符串	Ops Manager用于访问权限此与 S3 兼容的存储桶的URL 。
S3 存储桶名称	字符串	托管与 S3 兼容的存储块存储的与 S3 兼容的存储桶的名称。
S3 最大连接数	整型	正整数，表示与此 S3 兼容存储块存储的最大连接数。
s3RegionOverride	字符串	S3 兼容存储桶所在的地区。仅当 S3 兼容存储存储的s3BucketEndpoint不支持地区作用域时，此字段才适用。仅当您在创建或更新此 S3 兼容存储块存储时包含此字段时，Ops Manager 才会返回此字段。
sseEnabled	布尔	指示此 S3 兼容存储块存储是否启用服务器端加密。的标志。
ssl	布尔	指示此 S3 兼容存储块存储是否只接受使用 TLS加密的连接的标志。
uri	字符串	连接到此 S3 兼容存储块存储存储的元数据数据库的连接字符串。该数据库将区块的位置存储在与 AWS S3 兼容的存储桶中。
writeConcern	字符串	用于此写关注（write concern）的块存储。 Ops Manager 返回以下值之一： `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` 要学习；了解MongoDB中的写入确认级别，请参阅写关注。

请求示例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true'

响应示例

响应标头

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}

响应体

{
  "assignmentEnabled": true,
  "awsAccessKey": "access",
  "awsSecretKey": "secret",
  "encryptedCredentials": false,
  "id": "id",
  "labels": [
    "l1",
    "l2"
  ],
  "links": [
    {
      "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}",
      "rel": "self"
    }
  ],
  "loadFactor": 50,
  "s3BucketEndpoint": "http://example.com/backupbucket",
  "s3BucketName": "buck1",
  "uri": "mongodb://localhost:27017",
  "ssl": true,
  "writeConcern": "W2"
}