ルート
ルートリソース は、 MongoDB Ops Manager APIの開始点です。 ここから、 linksを走査して他のすべての API リソースにアクセスできます。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /
リクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 | 1 |
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 | 100 |
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false |
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 | false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答には、次のものが含まれます。
名前 | タイプ | 説明 |
|---|---|---|
appName | string | MongoDB Ops Manager |
構築 | string | の コミットに対応する SHAGithub MongoDB Ops Manager。 |
Links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべての |
スロットリング | ブール値 | フィールドは廃止され、値は falseになります。 |
リクエストの例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "<ops-manager-host>:<port>/api/public/v1.0"
応答例
{ "appName" : "MongoDB Ops Manager", "build" : "ec8b09b880be314981caa9d8fbefc3280056522e", "links" : [ ], "throttling" : false }