1 つのプロジェクト診断アーカイブを取得
MongoDBエンジニアは、 MongoDB Ops Manager管理者に対して、デバッグおよびトラブルシューティングのために 1 件のプロジェクトの診断アーカイブを提供することを要求する場合があります。 プロジェクト診断アーカイブには、 MongoDB 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 | string | 必須 | 診断アーカイブを所有するプロジェクトの一意の識別子です。 |
リクエスト クエリ パラメータ
必要な次のクエリ パラメータのいずれかを指定します。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 | 1 |
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 | 100 |
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false |
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 | false |
backupJobsEnabledOnly | ブール値 | 任意 | データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これを falseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。 | true |
ageLimit | integer | 任意 | 診断アーカイブのエントリを取得する時間の長さ（日数）。 | 7 |
limit | integer | 任意 | 診断アーカイブの最大エントリ数。 | 1000 |
分 | integer | 任意 | 診断アーカイブの時間範囲。過去の指定された分数から始まり、現在の時点で終了します。 例、過去10分間のデータを含む診断アーカイブを取得するには、リクエストで | 1440 |
sizeLimit | integer | 任意 | 診断アーカイブ内の各ファイルの最大ファイル サイズ（文字数単位）。 これには、この制限に最も近い整数値までの値が含まれます。 | 50000000 |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
このエンドポイントは、 --outputまたは-oオプションを使用して指定した名前を持つ圧縮済み（ .tar.gz ）アーカイブ ファイルを現在の作業ディレクトリに返します。
リクエストの例
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}
レスポンス本体
このエンドポイントは、 --outputまたは-oオプションを使用して指定した名前を持つ圧縮済み（ .tar.gz ）アーカイブ ファイルを現在の作業ディレクトリに返します。