Ops Managerのインストール環境からライセンスキーを解放したことを確認する署名済みの領収書を取得します。Ops Managerは、解放されたライセンスキーに対してのみ領収書を返します。Ops Managerのインターフェースでは、ダウンロード時と同じ領収書が提供されます。
リリース証明として領収書を保管してください。インストール環境がMongoDBに接続できない場合は、 https://support.mongodb.com/keyportalのキーポータルに領収書をアップロードしてください。
必須のロール
このリソースにアクセスするには、 APIキーにGlobal Ownerロールが付与されている必要があります。グローバルオーナーロールは、Ops Managerにおける最高位のロールです。このロールを持つユーザーのみがライセンスキーを表示および管理できます。
リクエスト
ライセンスキーIDをパスに含めてGETリクエストを送信してください。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /admin/artifacts/{artifactId}/receiptリクエスト パス パラメーター
リクエストパスには以下のパラメータが含まれています。
Parameter | タイプ | 必要性 | 説明 |
|---|---|---|---|
| string | 必須 | リリースされたライセンスキーの一意の識別子。 |
リクエスト クエリ パラメータ
このエンドポイントは、以下のクエリパラメータを受け付けます。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
レスポンスには以下のフィールドが含まれます。
フィールド | タイプ | 説明 |
|---|---|---|
| オブジェクト | ライセンスキーのリリースレシート。JSONドキュメントとして返されます。 |
Errors
リリース済みのライセンスキーと一致しないartifactIdを指定した場合、エンドポイントは HTTP ステータス404を返します。レスポンスボディのerrorCodeフィールドにはARTIFACT_NOT_FOUNDが含まれ、 detailフィールドにはNo released artifact with that id.が含まれます。
リクエストの例
curlを使用してGETリクエストを/admin/artifacts/{artifactId}/receiptエンドポイントに送信します。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET \ "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/artifacts/{ARTIFACT-ID}/receipt?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-aliveHTTP/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}レスポンス本体
以下の例は、レスポンスボディを示しています。
{ "receipt": { "{RECEIPT-CONTENTS}": "..." }}