Recupera um recibo assinado que confirma que você liberou uma chave de licença de uma instalação do Ops Manager. O Ops Manager retorna um recibo apenas para chaves de licença liberadas. A interface do Ops Manager exibe o mesmo recibo que um download.
Keep the receipt as proof of the release. If your installation can't connect to MongoDB, upload the receipt in the Key Portal at https://support.mongodb.com/keyportal.
Funções obrigatórias
To access this resource, your API key must have the Global Owner role. The Global Owner role is the highest role in Ops Manager. Only users with this role can view and manage license keys.
Solicitar
Send a GET request with the license key ID in the path.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /admin/artifacts/{artifactId}/receiptParâmetros do caminho da solicitação
O caminho da solicitação contém o seguinte parâmetro:
Parâmetro | Tipo | necessidade | Descrição |
|---|---|---|---|
| string | Obrigatório | Identificador único da chave de licença liberada. |
Solicitar parâmetros de query
Este endpoint aceita os seguintes parâmetros de consulta:
Nome | Tipo | necessidade | Descrição | Default |
|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador que indica se o corpo da resposta está em um formato pretty-print. |
|
envelope | booleano | Opcional | Sinalizador que indica se deve envolver a resposta em um envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui:
|
|
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
A resposta contém o seguinte campo:
Campo | Tipo | Descrição |
|---|---|---|
| objeto | Recibo de liberação da chave de licença, retornado como um documento JSON. |
Errors
If you specify an artifactId that doesn't match a released license key, the endpoint returns the HTTP status 404. The errorCode field of the response body contains ARTIFACT_NOT_FOUND, and the detail field contains No released artifact with that id.
Exemplo de solicitação
Use curl to send a GET request to the /admin/artifacts/{artifactId}/receipt endpoint:
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"Exemplo de resposta
Os exemplos a seguir mostram os cabeçalhos e o corpo da resposta de uma solicitação bem-sucedida.
Cabeçalho de resposta
Os cabeçalhos a seguir mostram uma resposta não autorizada e uma resposta bem-sucedida:
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}Corpo de resposta
O exemplo a seguir mostra o corpo da resposta:
{ "receipt": { "{RECEIPT-CONTENTS}": "..." }}