AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

ライセンスキーの状態をオンデマンドで再計算する

Ops Manager は、ライセンスキーのステータスを 1 時間ごと、およびライセンスキーのインストールまたはリリース後に計算します。このエンドポイントを使用すると、次のスケジュールされた計算を待つことなく、必要に応じてステータスを再計算できます。たとえば、 API の外部で検証の問題を修正した後などに使用できます。

このリソースにアクセスするには、 APIキーにGlobal Ownerロールが付与されている必要があります。グローバルオーナーロールは、Ops Managerにおける最高位のロールです。このロールを持つユーザーのみがライセンスキーを表示および管理できます。

POSTリクエストを送信します。エンドポイントにはリクエストボディがありません。

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

POST /admin/licenses/recompute

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

このエンドポイントは、以下のクエリパラメータを受け付けます。

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

レスポンス本体をpretty-print形式にするかどうかを示すフラグ。

false

envelope

ブール値

任意

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

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

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

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

false

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

応答には、再計算されたライセンスキーの状態が含まれます。応答には以下のフィールドが含まれます。

フィールド
タイプ
説明

enforcement

オブジェクト

Ops Managerのインストールにおけるライセンスキーの集計ステータス。このフィールドは、Ops Managerが初めてステータスを計算するまでnullになります。

enforcement.effectiveState

string

インストール時のライセンスキーの状態。Ops Manager はLICENSED 、 GRACE 、 EXPIRED 、またはUNLICENSEDのいずれかを返します。これらの状態が Ops Manager インターフェイスにどのようにマッピングされるかについては、 「Ops Manager ライセンスキーの概要」を参照してください。

enforcement.cause

string

effectiveStateという値が生成された原因を特定します。

enforcement.enforced

ブール値

状態がEXPIREDかUNLICENSEDを示します。Ops Managerはこれらの状態では操作を制限しません。

enforcement.transition

オブジェクト

ライセンスキーの状態に対する次回の変更予定値。変更が予定されていない場合は、このフィールドはnullになります。

enforcement.transition.evaluatorId

string

次の変革を推進する評価者。

enforcement.transition.inStateUntil

string

現在の状態が終了する日時。

enforcement.transition.nextState

string

現在の状態に続く状態。

enforcement.warnings

オブジェクトの配列

未解決の警告。Ops Manager は、注文の終了日前に更新警告を表示します。詳細については、 「Ops Manager ライセンスキーの概要」を参照してください。

enforcement.warnings[n].evaluatorId

string

警告を発した評価者。

enforcement.warnings[n].since

string

警告が発令された日時。

enforcement.warnings[n].subjects

オブジェクトの配列

警告の対象となる項目。各項目には、 idとsince日付が含まれています。警告がインストール全体に適用される場合、この配列は空になります。

enforcement.verdicts

オブジェクトの配列

各評価者がeffectiveState値にどれだけ貢献しているか。

enforcement.verdicts[n].evaluatorId

string

判決を下した評価者。

enforcement.verdicts[n].state

string

評価者が計算したことを明記してください。

enforcement.verdicts[n].breachAt

string

違反が発効する日時(注文終了日など)。この日付は、状態がLICENSEDである間は未来の日付になります。

enforcement.verdicts[n].warningStart

string

更新警告ウィンドウが開いた日時。判定状態がLICENSEDでない限り、このフィールドはnullになります。

enforcement.verdicts[n].metadata

オブジェクト

評価者固有の詳細情報。評価者が情報を提供しない場合は、このフィールドはnullとなります。

enforcement.verdicts[n].transition

オブジェクト

次に、判定状態を変更します。オブジェクトにはinStateUntilとnextStateフィールドが含まれています。変更が予定されていない場合、このフィールドはnullになります。

licenses

オブジェクトの配列

Ops Managerのインストール時にインストールされるライセンスキー。

licenses[n].artifactId

string

ライセンスキーの一意の識別子。この値を使用してライセンスキーを解放します。Ops Managerインターフェースでは、この値がライセンスキーIDとして表示されます。

licenses[n].usable

ブール値

Ops Managerがライセンスキーをカバレッジに使用できるかどうかを示します。

licenses[n].generatedAt

string

MongoDBがライセンスキーを生成した日時。

licenses[n].installedAt

string

ライセンスキーがインストールされた日時。

licenses[n].status

string

ライセンスキーの状態。Ops Manager はACTIVE 、 EXPIRED 、 RELEASED 、またはDENIEDのいずれかを返します。ライセンスキーが使用可能で、注文終了日が将来である場合はACTIVEとなります。ライセンスキーが使用可能だが注文終了日が過ぎている場合はEXPIREDとなります。

licenses[n].statusCause

string

DENIEDライセンスキーの理由コード。Ops Manager はCLAIM_CONFLICT 、 CLAIM_REVOKED 、またはVERIFICATION_FAILEDのいずれかを返します。Ops Manager はこのフィールドをDENIEDライセンスキーの場合にのみ設定します。

licenses[n].statusReason

string

ライセンスキーがDENIEDである理由を説明する文。Ops ManagerはこのフィールドをDENIEDライセンスキーの場合にのみ設定します。

licenses[n].termEnd

string

ライセンスキーの有効期間が終了する日時。ライセンスキーに有効期限が設定されていない場合は、このフィールドはnullとなります。

licenses[n].grants

オブジェクトの配列

ライセンスキーに含まれる権限。ライセンスキーがRELEASEDまたはDENIEDの場合、保存されているライセンスキーが検証に合格すれば、Ops Managerは権限を返します。検証に失敗した場合、この配列は空になります。

licenses[n].grants[n].grantType

string

助成金の種類(例: contract )。

licenses[n].grants[n].grantId

string

助成金の識別子。発行者が設定しない場合、このフィールドはnullになります。

licenses[n].grants[n].startDate

string

助成金の開始日時。

licenses[n].grants[n].endDate

string

助成金が終了する日時。

licenses[n].grants[n].entitlements

オブジェクトの配列

助成金に付随する権利。各オブジェクトは、 activeEntitlementsで説明されているフィールドを使用します。

activeEntitlements

オブジェクト

現在有効な権限を、権限の種類ごとにグループ化して表示します。各キーは権限の種類(例: exemption::telemetry )を表し、各値は権限オブジェクトの配列です。

activeEntitlements.<type>[n].type

string

権利の種類。

activeEntitlements.<type>[n].productName

string

権利が適用される製品名。権利に製品名が指定されていない場合、このフィールドはnullになります。

activeEntitlements.<type>[n].active

ブール値

権利が有効かどうかを示します。

activeEntitlements.<type>[n].window

オブジェクト

権利の有効期間。オブジェクトにはstartとend日付フィールドが含まれます。有効期間に境界がない場合、このフィールドはnullになります。

curlを使用してPOSTリクエストを/admin/licenses/recomputeエンドポイントに送信します。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request POST \ "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/licenses/recompute?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-alive
HTTP/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}

以下の例は、レスポンスボディを示しています。

{ "enforcement": { "effectiveState": "LICENSED", "cause": "term:LICENSED", "enforced": false, "transition": { "evaluatorId": "term", "inStateUntil": "2027-06-30T00:00:00Z", "nextState": "GRACE" }, "warnings": [], "verdicts": [ { "evaluatorId": "term", "state": "LICENSED", "breachAt": "2027-06-30T00:00:00Z", "warningStart": "2027-02-28T00:00:00Z", "metadata": null, "transition": { "inStateUntil": "2027-06-30T00:00:00Z", "nextState": "GRACE" } } ] }, "licenses": [ { "artifactId": "{ARTIFACT-ID}", "usable": true, "generatedAt": "2026-10-01T12:00:00Z", "installedAt": "2026-11-04T15:30:00Z", "status": "ACTIVE", "statusCause": null, "statusReason": null, "termEnd": "2027-06-30T00:00:00Z", "grants": [ { "grantType": "contract", "grantId": "{GRANT-ID}", "startDate": "2026-07-01T00:00:00Z", "endDate": "2027-06-30T00:00:00Z", "entitlements": [] } ] } ], "activeEntitlements": {}}