Docs Menu
Docs Home
/
MongoDB Atlas
/
プログラムによるアクセス
/
Atlas Administration API
/
その他の API リソース

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 埋め込みドキュメント

ラベル
説明

availability_zone

Amazon Web ServicesアベイラビリティーゾーンID 、 Google Cloud Platformゾーンの完全修飾名、またはAzureゾーン番号。

Azureでは、リージョンのサブセットのみのアベイラビリティーゾーンをサポートしています。 Atlas は、アベイラビリティーゾーンをサポートするリージョンに対してのみ、 Azure用の事前定義されたアベイラビリティーゾーンタグを提供します。詳しくは、 Microsoft Azureを参照してください。

availabilityZone各クラウドプロバイダーで使用可能な 値の詳細については、 AWS 、 GCP 、またはAzureのドキュメントを参照してください。

cl_name

クラスターを一意に識別するラベル。

group_id

プロジェクトを識別するユニークな 16 進数の文字列。

group_name

プロジェクトを一意に識別するラベル。

node_type

ノード タイプ。

指定できる値は、ELECTABLE、READ_ONLY、ANALYTICS です。

詳細については、「 ノード タイプ 」を参照してください。

org_id

組織を識別するユニークな 16 進数の文字列。

provider

ノードがプロビジョニングされるクラウドプロバイダー。

指定できる値は、AWS、GCP、AZURE です。

region

ノードが存在するクラウド リージョン。

可能なregion 値の完全なリストについては、 AWS 、 GCP 、またはAzure参照ページを参照してください。

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/673f4ae24759b47bdd3a2e90/discovery"

応答例

1[
2  {
3    "labels": {
4      "availability_zone": "use1-az4",
5      "cl_name": "Cluster012",
6      "group_id": "673f4ae24759b47bdd3a2e90",
7      "node_type": "ELECTABLE",
8      "org_id": "673cad5b6b921181d015e1de",
9      "provider": "AWS",
10      "region": "us-east-1"
11    },
12    "targets": [
13      "cluster012-shard-00-00.rffkz.mongodb-dev.net:27018"
14    ]
15  },
16  {
17    "labels": {
18      "availability_zone": "use1-az6",
19      "cl_name": "Cluster012",
20      "group_id": "673f4ae24759b47bdd3a2e90",
21      "node_type": "ELECTABLE",
22      "org_id": "673cad5b6b921181d015e1de",
23      "provider": "AWS",
24      "region": "us-east-1"
25      },
26    "targets": [
27      "cluster012-shard-00-01.rffkz.mongodb-dev.net:27018"
28    ]
29  },
30  {
31    "labels": {
32      "availability_zone": "use1-az1",
33      "cl_name": "Cluster012",
34      "group_id": "673f4ae24759b47bdd3a2e90",
35      "node_type": "ELECTABLE",
36      "org_id": "673cad5b6b921181d015e1de",
37      "provider": "AWS",
38      "region": "us-east-1"
39    },
40    "targets": [
41      "cluster012-shard-00-02.rffkz.mongodb-dev.net:27018"
42    ]
43  }
44]

戻る

その他の API リソース

次へ

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