必須のロール
このリソースでは、 API キーにGlobal Ownerロールが必要です。
Resource
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /usage/groupsリクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 説明 | default |
|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 |
|
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | レスポンス本体を pretty-print 形式にするかどうかを示します。 |
|
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
応答JSONドキュメントには、resultオブジェクトの配列、linkオブジェクトの配列、および検索されたresultオブジェクトの合計数のカウントが含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 配列には、 |
| 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
| 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
結果配列の各要素は、1 つの物理ホストです。
応答要素 | タイプ | 説明 |
|---|---|---|
ホスト | オブジェクトの配列 | 提供された物理ホストにバインドされた仮想ホストのリスト。 |
ホスト | string | MongoDB Ops Managerがこの仮想ホストを配置するプロジェクトの一意の識別子。 |
hosts | string | 物理ホストにバインドされた仮想ホストのFQDN 。 |
id | string | MongoDB Ops Managerが仮想ホストをバインドした物理ホストの一意の識別子。 |
name | string | 物理ホストに付けたラベル。 |
serverType | string | 物理ホストのサーバータイプ。 MongoDB Ops Manager は、次のいずれかの値を返します。
詳細については、「 MongoDB の使用状況 」ページを参照してください。 |
リクエストの例
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pretty=true"応答例
応答ヘッダー
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "links": [ { "href": "http://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "hosts": [ { "groupId": "{projectId1}", "hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-7" }, { "groupId": "{projectId1}", "hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-8" } ], "id": "{physicalHostId1}", "name": "physicalHostA", "serverType": "DEV_SERVER" }, { "hosts": [ { "groupId": "{projectId2}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-0" }, { "groupId": "{projectId2}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1" } ], "id": "{physicalHostId2}", "name": "physicalHostB", "serverType": "DEV_SERVER" }, ], "totalCount": 2}