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

Docs 菜单

/ /

/ /

/

/

/

/

/

/

/

按 ID 获取单个同步存储配置

检索一个同步存储的配置。

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

Resource

GET /sync/mongoConfigs/{SYNC-STORE-CONFIG-ID}

请求路径参数

名称	类型	说明
SYNC-STORE-CONFIG-ID	字符串	表示此oplog配置的唯一标识符。

请求查询参数

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

名称	类型	必要性	说明	默认
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`

请求正文参数

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

响应

名称	类型	说明
assignEnabled	布尔	指示是否可以为此同步存储分配备份作业的标志。
加密凭证	布尔	指示此同步存储的用户名和密码是否使用凭证工具加密的标志。
id	字符串	标记此同步存储的唯一名称。
labels	字符串数组	Array of tags to manage which backup jobs Ops Manager can assign to which sync stores.
链接	对象数组	指向子资源或相关资源的一个或多个链接。响应中的所有 `links` 数组至少包含一个名为 `self` 的链接。URL之间的关系在 Web 链接规范中进行了解释。
maxCapacityGB	数字	可选。OUTSIDE_SPACE_USED_THRESHOLD警报中使用的同步存储的预期最大可用容量。`maxCapacityGB` 不对后端数据库的大小实施任何限制。
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.`callback`、`azure`、`gcp`或`k8s`之一。 `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 范围。仅当 `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/sync/mongoConfigs/{SYNC-STORE-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,
  "encryptedCredentials" : false,
  "id" : "{CONFIG-ID}",
  "labels" : [ "l1", "l2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs/{SYNC-STORE-CONFIG-ID}",
    "rel" : "self"
  }],
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "usedSize" : 222,
  "writeConcern" : "W2"
}

给本页内容打分

在此页面上

Resource
请求路径参数
请求查询参数
请求正文参数
响应
请求示例
响应示例
响应标头
响应体

在此页面上

Resource
请求路径参数
请求查询参数
请求正文参数
响应
请求示例
响应示例
响应标头
响应体