按 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 /groups/{PROJECT-ID}
请求路径参数
名称 | 类型 | 说明 |
---|---|---|
PROJECT-ID | 字符串 | 表示此项目及其备份作业配置的唯一标识符。 |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。 对于返回一个结果的端点,响应体包括:
| false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
名称 | 类型 | 说明 |
---|---|---|
daemonFilter | 对象数组 | |
daemonFilter.headRootDirectory | 字符串 | |
daemonFilter.machine | 字符串 | 一个备份守护程序主机的主机地址。 |
id | 字符串 | 表示此项目及其备份作业配置的唯一标识符。 |
kmipClientCertPassword | 字符串 | 用于加密KMIP客户端证书的密码。 |
kmipClientCertPath | 字符串 | 备份守护程序主机上存储KMIP客户端证书的目录路径。 |
链接 | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。 响应中的所有 |
labelFilter | 字符串数组 | |
oplogStoreFilter | 对象数组 | 表示可用于此项目备份作业的oplog存储的唯一标识符数组。 |
oplogStoreFilter.id | 字符串 | 表示可用于此项目备份作业的oplog 存储的唯一标识符。 |
oplogStoreFilter.type | 字符串 | 要使用的oplog 存储的类型。 此值始终为 oplogStore 。 |
snapshotStoreFilter | 对象数组 | 表示可用于此项目备份作业的特定快照存储及其类型的唯一标识符数组。 如果省略,则使用所有可用的快照存储。 |
snapshotStoreFilter.id | 字符串 | 表示可用于此项目备份作业的特定快照存储的唯一标识符。 |
snapshotStoreFilter.type | 字符串 | 特定快照存储的类型以 此选项可接受的值为:
|
syncStoreFilter | 字符串数组 | 可用于此项目的备份作业的同步存储筛选器数组。 如果省略,则使用所有可用的同步存储。 |
请求示例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups/{PROJECT-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}
响应体
{ "daemonFilter" : [ { "headRootDirectory" : "/data/backup", "machine" : "http://backup.example.com" } ], "id" : "{PROJECT-ID}", "kmipClientCertPassword" : "P4$$w0rD", "kmipClientCertPath" : "/certs/kmip", "labelFilter" : [ "label1", "label2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups/{PROJECT-ID}", "rel" : "self" }, { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/groups/{PROJECT-ID}", "rel" : "http://mms.mongodb.com/group" } ], "oplogStoreFilter" : [ { "id" : "oplog1", "type" : "oplogStore" } ], "snapshotStoreFilter" : [ { "id" : "sPid", "type" : "s3blockstore" } ], "syncStoreFilter" : [ "s1", "s2" ] }