Prometheus の最新のターゲットを返す
Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
ベース URL: https://cloud.mongodb.com/prometheus/v1.0
構文
GET /groups/{GROUP-ID}/discovery
リクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
{PROJECT-ID} | string | 必須 | プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 | 1 |
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 | 100 |
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 | false |
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 | false |
backupJobsEnabledOnly | ブール値 | 任意 | データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これを falseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。 | true |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答要素
応答には、スクレイピングする最新の targetsの配列と、それらのlabelsを含むドキュメントが含まれます。
名前 | タイプ | 説明 |
|---|---|---|
ターゲット | 配列 | メトリクスをスクレイピングするそれぞれの hostとport 。 |
labels | ドキュメント | メトリクスを区別するラベルと値を含むドキュメント。 |
labels.group_id | string | プロジェクトを識別するユニークな 16 進数の文字列。 |
labels.group_name | string | プロジェクトを識別する、人間に判読可能なラベル。 |
labels.org_id | string | 組織を識別するユニークな 16 進数の文字列。 |
リクエストの例
Sets the `Authorization` header on every scrape request with the configured username and password. The URL that Prometheus fetches the targets from. curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/prometheus/v1.0/groups/{PROJECT-ID}/discovery"
応答例
[ { "targets":[ "mongodbd-prometheus:9216" ], "labels":{ "group_id":"{PROJECT-ID}", "group_name":"CM-Testing", "org_id":"{ORG-ID}" } } ]