AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

1 つのグローバル使用状況レポート アーカイブを取得

指定された時間枠でのサーバー使用量の圧縮レポートをzipまたは.tar.gz形式で取得します。

このリソースを正常に呼び出すには、API キーにGlobal Ownerロールが必要です。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /usage/report

このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

レスポンス本体をpretty-print形式にするかどうかを示すフラグ。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

false

startDate

string

必須

endDate

string

必須

fileFormat

文字列

必須

結果レポートの圧縮形式。 MongoDB Ops Managerはzipまたは.tar.gzを受け入れます。

redact

ブール値

任意

レスポンスがレポート内のすべての 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 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

このエンドポイントは、 fileFormatパラメータに基づいて.zipまたは.tar.gzの圧縮ファイルを返します。