获取所有 oplog 配置
MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。 尽快升级到更高的MongoDB Ops Manager版本。
检索所有 oplog 存储的配置。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /oplog/mongoConfigs
请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
名称 | 类型 | 必要性 | 说明 | 默认 |
---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数,用于返回结果的一部分。 | 1 |
itemsPerPage | 数字 | Optional | 每页要返回的项目数,最多 500 个。 | 100 |
pretty | 布尔 | Optional | 指示响应正文是否应采用 prettyprint 格式 的标志 格式。 | false |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 对于返回结果列表的端点, | false |
backupJobsEnabledOnly | 布尔 | Optional | 指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为 false 以包含将backupJobsEnabled 标志设置为false 的守护进程配置。 | true |
assignableOnly | 布尔 | 指示是否可以为此oplog存储分配新的备份作业的标志。 | true |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应文档
响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。
名称 | 类型 | 说明 |
---|---|---|
results | 阵列 | 数组为 results 嵌入式文档部分中详细介绍的每一项包含一个对象。 |
links | 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
totalCount | 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页,则它可能大于results数组中的对象数。 |
results
嵌入式文档
每个结果都是一个 oplog 存储。
名称 | 类型 | 说明 |
---|---|---|
assignEnabled | 布尔 | 指示是否可以为此oplog 存储分配备份作业的标志。 |
加密凭证 | 布尔 | 指示此oplog存储的用户名和密码是否使用凭证工具加密的标志。 |
id | 字符串 | |
labels | 字符串数组 | |
链接 | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。 响应中的所有 |
maxCapacityGB | 数字 | 此oplog 存储可以存储的最大数据量(以 GB 为单位)。 |
uri | 字符串 | 以逗号分隔的 <hostname:port> 格式的主机列表,可用于访问此oplog 存储。 |
ssl | 布尔 | 指示此 oplog 存储是否只接受使用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/oplog/mongoConfigs?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}
响应体
{ "links" : [ { "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "assignmentEnabled" : true, "encryptedCredentials" : false, "id" : "{CONFIG-ID}", "labels" : [ "l1", "l2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs/{OPLOG-ID}", "rel" : "self" }], "maxCapacityGB" : 8, "uri" : "mongodb://localhost:27017", "ssl" : true, "usedSize" : 222, "writeConcern" : "W2" } ], "totalCount" : 1 }