获取一个项目诊断存档
MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。 尽快升级到更高的MongoDB Ops Manager版本。
MongoDB 工程师可能会请求 Ops Manager 管理员提供一个项目的诊断存档，以进行调试和故障排除。项目诊断存档还包含有关 Ops Manager 的全球系统信息。
所需角色
API密钥需要 Global Monitoring Admin或Global Owner角色才能下载诊断存档。
Resource
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /groups/{PROJECT-ID}/diagnostics
请求路径参数
名称 | 类型 | 必要性 | 说明 |
|---|---|---|---|
PROJECT-ID | 字符串 | 必需 | 拥有诊断存档的项目的唯一标识符。 |
请求查询参数
提供您需要的以下任何查询参数：
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数，用于返回结果的一部分。 | 1 |
itemsPerPage | 数字 | Optional | 每页要返回的项目数，最多 500 个。 | 100 |
pretty | 布尔 | Optional | 指示响应正文是否应采用 prettyprint 格式 的标志 格式。 | false |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 对于返回结果列表的端点， | false |
backupJobsEnabledOnly | 布尔 | Optional | 指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为 false以包含将backupJobsEnabled标志设置为false的守护进程配置。 | true |
AgeLimit | 整型 | Optional | 检索诊断存档条目的时间长度（以天为单位）。 | 7 |
limit | 整型 | Optional | 诊断存档的最大条目数。 | 1000 |
数分钟 | 整型 | Optional | 诊断存档的时间范围，从过去指定的分钟数开始，现在结束。 示例，要检索包含最后10分钟数据的诊断存档，请在请求中指定 | 1440 |
大小限制 | 整型 | Optional | 诊断归档中每个文件的最大文件大小，以字符数表示。 这包括最接近此限制的整数值。 | 50000000 |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
此端点将压缩 ( .tar.gz ) 存档文件返回到当前工作目录，其名称是您使用--output或-o选项指定的。
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/gzip" \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/diagnostics?pretty=true" \ --output project_diagnostics.tar.gz
响应会将project_diagnostics.tar.gz保存到本地主机的当前工作目录。
响应示例
响应标头
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}
响应体
此端点将压缩 ( .tar.gz ) 存档文件返回到当前工作目录，其名称是您使用--output或-o选项指定的。