Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
MongoDB Ops Manager Administration APIリソース
/
MongoDB Server の使用量

1 つの物理ホストを作成

項目一覧

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

必須のロール

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

Resource

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

POST /usage/groups

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

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

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

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

名前
タイプ
説明
default
pageNum
integer
ページ番号（1 インデックス ベース）。
1
itemsPerPage
integer
1 ページあたりに返す項目の数は最大 500 です。
100
pretty
ブール値
レスポンス本体を pretty-print に含めるかどうかを示します 形式。
false
envelope
ブール値

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

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

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

状態
HTTPレスポンス コード
envelope
期待される応答本体

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

なし

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

Body Parameter
タイプ
必要性
説明
Atlas App Services
文字列の配列
必須
提供された物理ホストにバインドされた仮想ホストのリスト。
virtualHosts
.groupId
string
任意
MongoDB Ops Managerがこの仮想ホストを配置するプロジェクトの一意の識別子。
virtualHosts
.hostname
string
任意
物理ホストにバインドされた仮想ホストのFQDN 。
name
string
必須
物理ホストに付けたラベル。 この値は一意である必要があります。
serverType
string
必須

物理ホストのサーバータイプ。 これは、次のいずれかの値に設定できます。

  • DEV_SERVER

  • TEST_SERVER

  • PRODUCTION_SERVER

  • RAM_POOL

詳細については、「 MongoDBの使用 」を参照してください。

応答

応答要素
タイプ
説明
ホスト
オブジェクトの配列
提供された物理ホストにバインドされた仮想ホストのリスト。
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の使用 」を参照してください。

リクエストの例

1curl --user "{publicApiKey}:{privateApiKey}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pretty=true" \
6     --data '{
7               "name": "physicalHostA",
8               "serverType":
9                 {
10                   "name": "PRODUCTION_SERVER",
11                   "label": "Production Server",
12                 },
13               "virtualHosts": [
14                 {
15                   "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1",
16                   "groupId": "{groupId}"
17                 }
18               ]
19             }'

応答例

応答ヘッダー

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  "hosts": [
3    {
4      "groupId": "{groupId}",
5      "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1"
6    }
7  ],
8  "id": "{physicalHostID}",
9  "name": "physicalHostA",
10  "serverType":
11    {
12      "name": "PRODUCTION_SERVER",
13      "label": "Production Server",
14    },
15}

戻る

1 つの物理ホストを取得

次へ

1 つの物理ホストを更新