获取一个项目的所有备份配置
注意
注意:群组和项目是同义词。您的 {PROJECT-ID}
与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/backupConfigs
请求参数
请求路径参数
名称 | 类型 | 必要性 | 说明 |
---|---|---|---|
PROJECT-ID | 字符串 | 必需 | 唯一的 24 位十六进制数字字符串,用于标识备份配置适用的项目。 |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 |
---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数,用于返回结果的一部分。 | 1 |
itemsPerPage | 数字 | Optional | 每页要返回的项目数,最多 500 个。 | 100 |
pretty | 布尔 | Optional | 指示响应正文是否应采用 prettyprint 格式 的标志 格式。 | false |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 对于返回结果列表的端点, | false |
backupJobsEnabledOnly | 布尔 | Optional | 指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为 false 以包含将backupJobsEnabled 标志设置为false 的守护进程配置。 | true |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
名称 | 类型 | 说明 |
---|---|---|
groupId | 字符串 | 唯一的 24 位十六进制数字字符串,用于标识拥有此备份配置的项目。 |
clusterId | 字符串 | 唯一的 24 位十六进制数字字符串,用于标识要查找其备份配置的集群。 |
statusName | 字符串 | 备份配置的当前(或所需)状态。 可能的值为:
|
storageEngineName | 字符串 | 用于备份的storage engine。可能的值为:
|
EncryptionEnabled | 布尔 |
sslEnabled | 布尔 | 指示是否为同步源数据库启用TLS的标志。 |
exclusive Namespaces | 字符串数组 | 要从备份中省略的数据库名称和collection名称的列表。每个字符串都是 您必须发送排除的命名空间的新完整列表,包括已列出的命名空间。 如果新列表从以前的列表中删除了任何命名空间,则还必须设置 如果新列表仅向前一个列表添加内容,则无需设置 |
includedNamespaces | 字符串数组 | 要包含在备份中的数据库名称和collection名称列表。每个字符串都是 您必须发送包含的命名空间的新完整列表,包括已列出的所有命名空间。 如果新列表向先前列表添加任何命名空间,则还必须设置 如果新列表仅删除前一个列表中的命名空间,则无需设置 |
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs"
响应示例
响应标头
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}
响应体
1 { 2 "totalCount" : 3, 3 "results" : [ { 4 "groupId" : "{PROJECT-ID}", 5 "clusterId" : "{CLUSTER-ID1}", 6 "statusName" : "STARTED", 7 "storageEngineName" : "WIRED_TIGER", 8 "sslEnabled" : false, 9 "excludedNamespaces" : [ ], 10 "includedNamespaces" : [ ], 11 "links" : [ ] 12 }, { 13 "groupId" : "{PROJECT-ID}", 14 "clusterId" : "{CLUSTER-ID2}", 15 "statusName" : "STARTED", 16 "storageEngineName" : "MEMORY_MAPPED", 17 "sslEnabled" : false, 18 "excludedNamespaces" : [ ], 19 "includedNamespaces" : [ ], 20 "links" : [ ] 21 }, { 22 "groupId" : "{PROJECT-ID}", 23 "clusterId" : "{CLUSTER-ID3}", 24 "statusName" : "STOPPED", 25 "storageEngineName" : "WIRED_TIGER", 26 "sslEnabled" : false, 27 "excludedNamespaces" : [ ], 28 "includedNamespaces" : [ ], 29 "links" : [ ] 30 } ], 31 "links" : [ ] 32 }