Ops Manager インストールのテレメトリコレクションのステータスと構成の詳細を取得します。
必須のロール
このエンドポイントでは、Global Owner ロールを持つAPIキーが必要です。
エンドポイント
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/private/v1.0/telemetry
GET /collection/details
リクエスト
path パラメータ
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
クエリ パラメータ
このエンドポイントは、 HTTPリクエストクエリ パラメーターを使用しません。
ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
応答JSONドキュメントには、次のフィールドが含まれます。
名前 | タイプ | 説明 |
|---|---|---|
enabled | ブール値 | システムがテレメトリを収集して送信するかどうかを示します。 |
last_成功_send | datetime | 最後に成功したテレメトリ送信の日時。 |
次_ジョブ | datetime | 次のテレメトリの送信がスケジュールされている日時。 |
データ | 配列 |
テレメトリ データ埋め込みオブジェクト
data 配列の各要素は、Ops Manager インストールのテレメトリの詳細を記述します。
名前 | タイプ | 説明 |
|---|---|---|
app_db_nodes | integer | この Ops Manager インストールが使用する AppDB ノードの数。 |
uuid | string | この Ops Manager インストールの静的一意な識別子。 |
os | 文字列の配列 | Ops Manager ホスト上で実行されるオペレーティング システム。 |
バージョン | string | 現在の Ops Manager バージョン。 |
インスタンス | integer | このインストール内の Ops Manager インスタンスの数。 |
backup_damons | integer | このインストールで実行中バックアップデーモンの数。 |
auth_method | string | MongoDB Ops Manager が使用する認証方法。可能な値は |
CPU | 整数の配列 | 各 Ops Manager ホストにプロビジョニングされた CPU コアの数。 |
メモリ | 整数の配列 | 各 Ops Manager ホストにプロビジョニングされるメモリの量。 |
インフラストラクチャ | string | Ops Manager をホストする インフラストラクチャ の種類可能な値は |
プロジェクト | integer | 現在存在するプロジェクトの合計数。 |
orgs | integer | 現在存在する組織の合計数。 |
配置 | 配列 |
テレメトリ配置の埋め込みオブジェクト
deployments 配列の各要素は、Ops Manager が管理するMongoDBデプロイを表します。
名前 | タイプ | 説明 |
|---|---|---|
バージョン | 文字列の配列 | 配置で使用されるMongoDB のバージョン。 |
uuid | string | 配置の静的一意な識別子です。 |
tls_enabled | ブール値 | 配置で TLS が有効になっているかどうかを示します。 |
auth_method | string | 配置で使用される認証方法。可能な値は |
タイプ | string | 配置タイプ。可能な値は |
nodes | integer | レプリカセットの場合は、配置内のノードの数。 |
shards | integer | シャーディングされたクラスターである場合は、配置内のシャードの数。 |
data_size | integer | 配置の合計データ サイズ（ ローカルメタデータを含む）。 |
エディション | オブジェクト |
|
リクエストの例
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/private/v1.0/telemetry/collection/details"
応答例
応答ヘッダー
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}
レスポンス本体
{ "data": { "app_db_nodes": 1, "auth_method": "DB", "backup_daemons": 3, "cpu": [ 14,12 ], "infrastructure": "Bare Metal", "instances": 2, "memory": [ "3221225472","221225472" ], "os": [ "RHEL 8.10 aarch64","RHEL 8.11 aarch64" ], "orgs": 3, "projects": 12, "uuid": "84248c7e-94df-4a0c-942a-dfb1fa987edd", "version": "8.0.13", "deployments": [ { "auth_method": "MONGODB-CR", "data_size": 3221225472, "edition": { "community": 3, "enterprise": 0 }, "nodes": 3, "tls_enabled": true, "type": "RS", "uuid": "6907dd45d61b992049366140", "version": [ "8.15","7.11" ] }, { "auth_method": "MONGODB-CR", "data_size": 221225472, "edition": { "community": 1, "enterprise": 2 }, "shards": 3, "tls_enabled": false, "type": "SC", "uuid": "6907de15d61b9920493664ca", "version": [ "8.15" ] } ], }, "enabled": true, "last_successful_send": "2025-10-02T22:26:10Z", "next_job": "2025-10-09T22:26:10Z" }