按 ID 获取一个块存储配置

检索一个块存储的配置。

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

Resource

GET /snapshot/mongoConfigs/{BLOCKSTORE-ID}

请求路径参数

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

请求查询参数

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

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

请求正文参数

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

响应

名称	类型	说明
assignEnabled	布尔	指示是否可以为此块存储分配备份作业的标志。
加密凭证	布尔	指示此块存储的用户名和密码是否使用块存储加密的标志。
id	字符串	标记此块存储的唯一名称。
labels	字符串数组	用于管理可以将哪些备份作业分配给哪些块存储的标签数组MongoDB Ops Manager 。
链接	对象数组	指向子资源或相关资源的一个或多个链接。响应中的所有 `links` 数组至少包含一个名为 `self` 的链接。URL之间的关系在 Web 链接规范中进行了解释。
负载系数	数字	一个非零的正整数，表示此快照存储相对于另一个快照存储应执行的备份工作量。仅当使用多个快照存储时才需要此选项。要学习；了解有关Load Factor的更多信息，请参阅编辑一个现有块存储。
maxCapacityGB	数字	可选。OUTSIDE_SPACE_USED_THRESHOLD警报中使用的块存储的预期最大可用容量。`maxCapacityGB` 不对后端数据库的大小实施任何限制。
OIDC	对象	此存储的 OIDC身份验证设置。`oidc` 对象包含以下字段。 `enabled`: 布尔值。指示对此存储是否已启用 OIDC 身份验证。 `method`: string.`callback`、`azure`、`gcp`或`k8s`之一。 `tokenUri`: string.身份提供程序令牌的终结点。仅在 `method` 为 `callback` 时存在。 `clientId`: string.与身份提供程序注册的客户端 ID。 `clientSecret`: string.MongoDB Ops Manager 在响应中对此值进行编辑，并不返回原始客户端秘密。 `scope`: string.从身份提供程序请求的 OAuth2 范围。仅在 `method` 为 `callback` 时呈现。 `tokenResource`: string.工作负载身份标记的受众或资源标识符。仅在 `method` 为 `azure` 或 `gcp` 时出现。
uri	字符串	以逗号分隔的主机列表，采用`<hostname:port>`格式，可用于访问此块存储。
ssl	布尔	指示此块存储是否只接受使用TLS加密的连接的标志。
usedSize	数字	现有备份消耗的备份容量（以MB为单位）。
writeConcern	字符串	用于此块存储的写关注。此选项可接受的值为： `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/mongoConfigs/{BLOCKSTORE-ID}?pretty=true'

响应示例

响应标头

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive

HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

{  "assignmentEnabled" : true,  "encryptedCredentials" : false,  "id" : "{BLOCKSTORE-CONFIG-ID}",  "labels" : [ "l1", "l2" ],  "links" : [ {    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs/{BLOCKSTORE-ID}",    "rel" : "self"  }],  "loadFactor" : 2,  "maxCapacityGB" : 8,  "uri" : "mongodb://localhost:27017",  "ssl" : true,  "usedSize" : 222,  "writeConcern" : "W2"}