Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/ / /

获取一份全局使用情况报告存档

在此页面上

  • 所需角色
  • 请求
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

检索zip.tar.gz格式的服务器在给定时间范围内使用情况的压缩报告。

您的API密钥必须具有 Global Owner角色才能成功调用此资源。

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

GET /usage/report

此端点不使用 HTTP 请求路径参数。

名称
类型
必要性
说明
默认
pretty
布尔
Optional
指示响应正文是否应采用 Prettyprint 的标志 格式。
false
envelope
布尔
Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true

对于返回一个结果的端点,响应体包括:

名称
说明
状态
HTTP 响应代码
envelope
预期响应正文
false
startDate
字符串
必需
ISO8601 的日期 报告开始时的日期格式。
endDate
字符串
必需
ISO8601 的日期 报告结束时的日期格式。
文件格式
字符串
必需
生成的报告的压缩格式。 Ops Manager 接受zip.tar.gz
编辑
布尔
Optional
该标志指示响应是否应审查报告中的所有 IP 地址、主机名、组织名称和项目名称。
true

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

此端点根据fileFormat参数返回.zip.tar.gz压缩文件。

curl --user "{publicApiKey}:{privateApiKey}" --digest \
--header "Accept: application/gzip" \
--include \
--request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/usage/report?startDate=2019-07-27&endDate=2020-07-28&fileFormat=zip"
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}

此端点根据fileFormat参数返回.zip.tar.gz压缩文件。

后退

获取一个项目诊断存档