すべての物理ホストを取得

項目一覧

必須のロール

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

必須のロール

このリソースでは、 API キーに Global Ownerロールが必要です。

Resource

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

GET /usage/groups

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

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

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

次のクエリパラメータは任意です。

名前

タイプ

説明

default

pageNum

integer

ページ番号（1 インデックスベース）。

1

itemsPerPage

integer

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

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

false

envelope

ブール値

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

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

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

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

結果のリストを返すエンドポイントの場合、 resultsオブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体にstatusフィールドを追加します。

なし

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

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

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前	タイプ	説明
`results`	配列	配列には、 `results`埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

結果配列の各要素は、1 つの物理ホストです。

応答要素	タイプ	説明
ホスト	オブジェクトの配列	提供された物理ホストにバインドされた仮想ホストのリスト。
hosts .[n].groupId	string	MongoDB Ops Managerがこの仮想ホストを配置するプロジェクトの一意の識別子。
hosts .[n].hostname	string	物理ホストにバインドされた仮想ホストのFQDN 。
id	string	MongoDB Ops Managerが仮想ホストをバインドした物理ホストの一意の識別子。
name	string	物理ホストに付けたラベル。
serverType	string	物理ホストのサーバータイプ。 MongoDB Ops Manager は、次のいずれかの値を返します。 DEV_SERVER TEST_SERVER PRODUCTION_SERVER RAM_POOL 詳細については、「 MongoDBの使用」を参照してください。

リクエストの例

1 curl --user "{publicApiKey}:{privateApiKey}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?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   "links": [
3     {
4       "href": "http://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pageNum=1&itemsPerPage=100",
5       "rel": "self"
6     }
7   ],
8   "results": [
9     {
10       "hosts": [
11         {
12           "groupId": "{projectId1}",
13           "hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-7"
14         },
15         {
16           "groupId": "{projectId1}",
17           "hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-8"
18         }
19       ],
20       "id": "{physicalHostId1}",
21       "name": "physicalHostA",
22       "serverType": "DEV_SERVER"
23     },
24     {
25       "hosts": [
26         {
27           "groupId": "{projectId2}",
28           "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-0"
29         },
30         {
31           "groupId": "{projectId2}",
32           "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1"
33         }
34       ],
35       "id": "{physicalHostId2}",
36       "name": "physicalHostB",
37       "serverType": "DEV_SERVER"
38     },
39   ],
40   "totalCount": 2
41 }

戻る

日次使用状況スナップショットの生成

1 つの物理ホストを取得

1	curl --user "{publicApiKey}:{privateApiKey}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pretty=true"

1	{
2	"links": [
3	{
4	"href": "http://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pageNum=1&itemsPerPage=100",
5	"rel": "self"
6	}
7	],
8	"results": [
9	{
10	"hosts": [
11	{
12	"groupId": "{projectId1}",
13	"hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-7"
14	},
15	{
16	"groupId": "{projectId1}",
17	"hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-8"
18	}
19	],
20	"id": "{physicalHostId1}",
21	"name": "physicalHostA",
22	"serverType": "DEV_SERVER"
23	},
24	{
25	"hosts": [
26	{
27	"groupId": "{projectId2}",
28	"hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-0"
29	},
30	{
31	"groupId": "{projectId2}",
32	"hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1"
33	}
34	],
35	"id": "{physicalHostId2}",
36	"name": "physicalHostB",
37	"serverType": "DEV_SERVER"
38	},
39	],
40	"totalCount": 2
41	}