1 つのプロジェクトのすべてのエージェントバージョンを取得

項目一覧

必須のロール

リクエスト
リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
リクエストの例
応答例
応答ヘッダー
レスポンス本体

必須のロール

割り当てられた次のいずれかのロールを使用して、このエンドポイントを正常に呼び出すことができます。

Project Read Only

リクエスト

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /groups/{PROJECT-ID}/agents/versions

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

名前	タイプ	必要性	説明
`PROJECT-ID`	string	必須	プロジェクトの一意の識別子。

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

レスポンス本体を pretty-print に含めるかどうかを示すフラグ形式。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

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

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

応答

名前	タイプ	説明
`count`	integer	MongoDB Ops Managerアプリケーションが見つけたエージェントの数。
`entries`	オブジェクトの配列	このMongoDB Ops Managerアプリケーションが管理するすべてのホスト上の各エージェントの詳細。
`entries` `.address`	string	このエージェントを実行するホストの IPv6 アドレス。
`entries` `.hostname`	string	このエージェントを実行するホストのFQDN 。
`entries` `.hostnameShort`	string	このエージェントを実行するホスト名。
`entries` `.version`	string	このホストが実行するこのエージェントのバージョン。
`entries` `.pingCount`	integer	このエージェントから受信した ping の回数。
`entries` `.confCount`	integer	このエージェントから受信した設定呼び出しの数。
`entries` `.tagName`	string	バックアップが有効になっている場合は、このエージェントのラベル。
`entries` `.lastPing`	数値	UNIXエポック MongoDB Ops Managerからの経過ミリ秒単位のタイムスタンプがこのエージェントから最後の ping を受信したときモニタリングが有効になっているモニタリングエージェントと MongoDB エージェントに適用されます。
`entries` `.lastConf`	数値	UNIXエポックからの経過ミリ秒単位のタイムスタンプMongoDB Ops Manager がこのエージェントから最後の構成呼び出しを受信したとき
`entries` `.msSinceLastConf`	数値	前回の構成呼び出しから経過したミリ秒数。
`entries` `.isPrimary`	ブール値	このエージェントが実行されるホストがプライマリであるかどうかを示すフラグ。
`entries` `.isManaged`	ブール値	MongoDB Ops Managerがこのエージェントを管理するかどうかを示すフラグ。モニタリングエージェントとバックアップエージェントにのみ適用されます。
`entries` `.numProcess`	integer	このホスト上で実行される MongoDB プロセスの数。
`entries` `.isVersionOld`	ブール値	インストールされたエージェントが廃止されたことを示すフラグ。このエージェントの現在リリースバージョンが、インストールされているエージェントのバージョンを超えています。
`entries` `.isVersionDeprecated`	ブール値	このエージェントが非推奨であることを示すフラグ。このエージェントでサポートされる最小バージョンが、インストールされたエージェントのバージョンを超えています。
`entries` `.pingState`	string	このエージェントの現在の状態。 `pingName`は次のいずれかの値を返します。 `ok` `warning` `error`
`entries` `.isModule`	ブール値	このエントリが MongoDB Agent のモジュールであることを示すフラグ。
`isAnyAgentNotManaged`	ブール値	いずれかのエージェントが非管理状態のホスト上で実行されるかどうかを示すフラグ。
`isAnyAgentVersionDeprecated`	ブール値	配置内のいずれかのエージェントが、そのエージェントの非推奨バージョンを実行しているかどうかを示すフラグ。
`isAnyAgentVersionOld`	ブール値	配置内のいずれかのエージェントが、そのエージェントの現行のバージョンではないことを実行するかどうかを示すフラグ。
`latestVersion`	string	このタイプのエージェントの最新バージョン。
`links`	オブジェクトの配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
`minimumAgentVersionDetected`	string	このホストにインストールされたこのエージェントの最小サポートバージョン。
`minimumVersion`	string	MongoDB Ops Managerのインストールで動作するこのエージェントの最小サポートバージョン。

リクエストの例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --request GET "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/agents/versions?pretty=true"

応答例

応答ヘッダー

HTTP/1.1 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

HTTP/1.1 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}

レスポンス本体

1 {
2   "count": 0,
3   "entries": [],
4   "isAnyAgentNotManaged": false,
5   "isAnyAgentVersionDeprecated": false,
6   "isAnyAgentVersionOld": false,
7   "latestVersion": "10.14.0.6304",
8   "links": [{
9       "href": "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/agents/current",
10       "rel": "self"
11     },
12     {
13       "href": "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}",
14       "rel": "http://mms.mongodb.com/group"
15     }
16   ],
17   "minimumAgentVersionDetected": "10.14.0.6304",
18   "minimumVersion": "5.0.0.309"
19 }

戻る

すべてのエージェントバージョンを取得

1 つのエージェント API キーを作成

1	{
2	"count": 0,
3	"entries": [],
4	"isAnyAgentNotManaged": false,
5	"isAnyAgentVersionDeprecated": false,
6	"isAnyAgentVersionOld": false,
7	"latestVersion": "10.14.0.6304",
8	"links": [{
9	"href": "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/agents/current",
10	"rel": "self"
11	},
12	{
13	"href": "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}",
14	"rel": "http://mms.mongodb.com/group"
15	}
16	],
17	"minimumAgentVersionDetected": "10.14.0.6304",
18	"minimumVersion": "5.0.0.309"
19	}