Prometheus の最新のターゲットを返す

項目一覧

構文

リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
応答ドキュメント
labels 埋め込みドキュメント
リクエストの例
応答例

注意

グループとプロジェクトは同義語です。あなたの {GROUP-ID}はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースと対応するエンドポイントでは、 groupsという用語が使用されます。

https://cloud.mongodb.com/prometheus/v1.0

構文

GET /groups/{GROUP-ID}/discovery

リクエストパスパラメーター

Parameter	必須/オプション	説明
`{GROUP-ID}`	必須	プロジェクト識別子。

リクエストクエリパラメータ

名前	タイプ	必要性	説明	default
targetScheme	ターゲットスキーム	任意	返すターゲットのタイプ。値には、次のものが含まれます。 `PUBLIC`: パブリックインターネットアクセス可能なターゲット。 `PRIVATE`: VPCピアリング互換ターゲットのプライベート IP。	`PUBLIC`

リクエストボディパラメータ

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

応答

応答ドキュメント

応答JSONドキュメントには、スクレイピングする最新のターゲットの配列と、そのラベルを含むドキュメントが含まれます。

名前	タイプ	説明
`targets`	オブジェクトの配列	メトリクスをスクレイピングするそれぞれの`host`と`port` 。
`labels`	ドキュメント	メトリクスを区別するラベルと値を含むドキュメント。

labels 埋め込みドキュメント

ラベル	説明
`group_id`	プロジェクトを識別するユニークな 16 進数の文字列。
`group_name`	プロジェクトを識別する、人間に判読可能なラベル。
`org_id`	組織を識別するユニークな 16 進数の文字列。
`cluster_name`	クラスターを識別する人間が判読できるラベル。
`replica_set_name`	レプリカセットを識別する人間が判読できるラベル。

リクエストの例

curl --header 'Accept: application/json'
# Sets the `Authorization` header on every scrape request with the
# configured username and password.
--user prom_user_618d48e05277a606ed2496fe:fSIMUngfTmOTVEB4
# The URL that Prometheus fetches the targets from.
--request GET "https://cloud.mongodb.com/prometheus/v1.0/groups/618d48e05277a606ed2496fe/discovery"

応答例

[
  {
      "targets":[
        "cluster1-shard-00-02.lvfy8.mongodb-dev.net:27018",
        "cluster1-shard-00-00.lvfy8.mongodb-dev.net:27018",
        "cluster1-shard-00-01.lvfy8.mongodb-dev.net:27018"
      ],
      "labels":{
        "cluster_name":"Cluster1",
        "group_id":"618d48e05277a606ed2496fe",
        "group_name":"Cloud-Testing",
        "org_id":"618d48ba5277a606ed2495ce",
        "replica_set_name":"atlas-74dujs-shard-0"
      }
  }
]

戻る

その他の API リソース

カスタムロールアクション

注意

構文

リクエスト パス パラメーター

リクエスト クエリ パラメータ

リクエスト ボディ パラメータ

応答