按 ID 获取一个块存储配置
MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。 尽快升级到更高的MongoDB Ops Manager版本。
检索一个块存储的配置。
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /snapshot/mongoConfigs/{BLOCKSTORE-ID}
请求路径参数
名称 | 类型 | 说明 |
|---|---|---|
BLOCKSTORE-ID | 字符串 | 标记此块存储配置的唯一名称。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
| false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
名称 | 类型 | 说明 |
|---|---|---|
assignEnabled | 布尔 | 指示是否可以为此块存储分配备份作业的标志。 |
加密凭证 | 布尔 | 指示此块存储的用户名和密码是否使用凭证工具加密的标志。 |
id | 字符串 | 标记此块存储的唯一名称。 |
labels | 字符串数组 | 用于管理 可以将哪些 备份作业 分配给哪些块存储的标签数组MongoDB Ops Manager 。 |
链接 | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。 响应中的所有 |
负载系数 | 数字 | 一个非零的正整数，表示此快照存储相对于另一个快照存储应执行的备份工作量。 仅当使用多个快照存储时才需要此选项。 要学习；了解有关 Load Factor的详情，请参阅编辑一个现有块存储。 |
maxCapacityGB | 数字 | 此块存储存储可以存储的最大数据量（以GB为单位）。 |
uri | 字符串 | 以逗号分隔的主机列表，采用 <hostname:port>格式，可用于访问此块存储。 |
ssl | 布尔 | 指示此块存储是否只接受使用TLS加密的连接的标志。 |
usedSize | 数字 | 现有备份消耗的备份容量（以MB为单位）。 |
writeConcern | 字符串 |
请求示例
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'
响应示例
响应标头
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}
响应体
{ "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" }