必須のロール
このリソースでは、 API キーに Global Ownerロールが必要です。
Resource
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /usage/groups/{physicalHostId}
リクエスト パス パラメーター
MongoDB Ops Manager にはすべてのリクエストパス パラメータが必要です。
Path Parameter | タイプ | 説明 |
|---|---|---|
automaticHostId | string | 検索対象の物理ホストの一意な識別子です。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 説明 | default | ||||
|---|---|---|---|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 |
| ||||
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 |
| ||||
pretty | ブール値 | レスポンス本体が pretty-print 形式であるかどうかを示します。 |
| ||||
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答要素 | タイプ | 説明 |
|---|---|---|
ホスト | オブジェクトの配列 | 提供された物理ホストにバインドされた仮想ホストのリスト。 |
hosts .[n].groupId | string | MongoDB Ops Managerがこの仮想ホストを配置するプロジェクトの一意の識別子。 |
hosts .[n].hostname | string | 物理ホストにバインドされた仮想ホストのFQDN 。 |
id | string | MongoDB Ops Managerが仮想ホストをバインドした物理ホストの一意の識別子。 |
name | string | 物理ホストに付けたラベル。 |
serverType | string | 物理ホストのサーバータイプ。 MongoDB Ops Manager は、次のいずれかの値を返します。
詳細については、「 MongoDBの使用 」を参照してください。 |
リクエストの例
1 curl --user "{publicApiKey}:{privateApiKey}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups/{physicalHostId}?pretty=true"
応答例
応答ヘッダー
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}
レスポンス本体
1 { 2 "hosts": [ 3 { 4 "groupId": "{PROJECT-ID}", 5 "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-2" 6 }, 7 { 8 "groupId": "{PROJECT-ID}", 9 "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-3" 10 }, 11 { 12 "groupId": "{PROJECT-ID}", 13 "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-4" 14 }, 15 { 16 "groupId": "{PROJECT-ID}", 17 "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-5" 18 }, 19 { 20 "groupId": "{PROJECT-ID}", 21 "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-6" 22 }, 23 { 24 "groupId": "{PROJECT-ID}", 25 "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-7" 26 }, 27 { 28 "groupId": "{PROJECT-ID}", 29 "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-8" 30 }, 31 { 32 "groupId": "{PROJECT-ID}", 33 "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-9" 34 } 35 ], 36 "id": "{PHYSICAL-HOST-ID}", 37 "name": "physicalDevHostA", 38 "serverType": "DEV_SERVER" 39 }