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	必須	ISO8601 の日付レポートが開始されたときの日付形式。
endDate	string	必須	ISO8601 の日付レポートが終了するときの日付形式。
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 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の圧縮ファイルを返します。

戻る

診断アーカイブを取得する

ホスト割り当てを一覧表示する