Ops Manager API を使用すると、Ops Manager インストールのライセンス キーの状態を確認したり、ライセンス キーをインストールまたは解放したりできます。Ops Manager がライセンス キーの状態を計算する方法については、 「Ops Manager ライセンス キーの概要」を参照してください。Ops Manager インターフェイスでライセンス キーを管理する方法については、 「Ops Manager でのライセンス キーの管理」を参照してください。
前提条件
始める前に、以下のものを必ず用意してください。
ロールを持つ
Global OwnerAPI キー。キーポータルで生成したライセンスキーファイル。生成方法については、 「Ops Manager でのライセンスキーの管理」を参照してください。
ライセンスキーをインストールしてください
以下の手順に従ってライセンスキーをインストールし、Ops Managerがそれを適用していることを確認してください。
現在のライセンスキーの状態を確認してください
GETリクエストを/admin/licensesエンドポイントに送信します。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET \ "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/licenses?pretty=true"レスポンスには、 enforcement.effectiveStateフィールドとlicenses配列が含まれます。各フィールドの説明については、 「インストールのライセンスキー ステータスを取得する」を参照してください。
ライセンスキーをインストールしてください
PUTリクエストを/admin/licensesエンドポイントに送信してください。リクエストボディには、ライセンスキーファイルの内容を使用してください。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PUT \ "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/licenses?pretty=true" \ --data @{LICENSE-KEY-FILE}Ops Manager がライセンスキーを受け入れると、ステータスを再計算して返します。Ops Manager がライセンスキーを拒否すると、応答にエラーが含まれます。エラーを解決するには、 「インストールエラーのトラブルシューティング」を参照してください。
新しいライセンスキーの状態を確認してください
前の手順からの応答で、以下の項目を確認してください。
enforcement.effectiveStateはLICENSEDです。新しいライセンスキーは、
licenses配列にstatusがACTIVEとして表示されます。
状態が想定どおりでない場合は、 「ライセンスキーの状態をオンデマンドで再計算」エンドポイントを呼び出して状態を再計算し、再度フィールドを確認してください。
ライセンスキーをリリースする
以下の手順に従って、Ops Managerのインストール環境からライセンスキーを解放してください。
重要
ライセンスキーを一度解放すると、再度使用することはできません。使用可能なライセンスキーが一つしかない場合、インストール環境は保護対象外となります。状態はGRACEに変わり、 90日後にUNLICENSEDに変わります。
ライセンスキーをリリースする
DELETEリクエストを/admin/licenses/{artifactId}エンドポイントに送信します。 {ARTIFACT-ID} artifactId値に置き換えてください。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request DELETE \ "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/licenses/{ARTIFACT-ID}?pretty=true"Ops Manager はステータスを再計算して返します。詳細については、 「Ops Manager からライセンス キーを解放する」を参照してください。
キーマネージャーIDを取得する
キーマネージャIDは、高可用性構成におけるすべてのインスタンスを含め、Ops Managerのインストール環境を識別します。APIは、 holderIdフィールドにキーマネージャIDを返します。これを取得するには、 /admin/artifacts/identityエンドポイントにGETリクエストを送信してください。詳細については、 「インストール環境のキーマネージャIDを取得する」を参照してください。
IDキーを回転させる
Ops Managerのインストール時に、IDキー（インストールがMongoDBに接続する際に自身の身元を証明するために使用するキーペア）が生成されます。組織外の誰かが秘密鍵を入手した疑いがある場合は、キーをローテーションして新しいキーペアに置き換えてください。キーをローテーションするには、インストールがMongoDBに接続できる必要があります。詳細については、 「インストールのIDキーをローテーションする」を参照してください。
インストールエラーのトラブルシューティング
Ops Managerがライセンスキーを拒否した場合、レスポンスのHTTPステータスは400 、 403 、または409となり、エラーを説明するJSONボディが含まれます。エラーは以下のフィールドで識別されます。
フィールド | 説明 |
|---|---|
| エラーコード（例： |
| エラーの内容と対処方法を説明するメッセージ。 |
エラーコード、HTTPステータス、およびメッセージの一覧については、 「インストールエラーのトラブルシューティング」を参照してください。
関連ページ
ライセンスキーに関する詳細については、以下のページをご覧ください。