Retorne uma chave de API global para o Ops Manager usando o identificador exclusivo para essa chave.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/apiKeys/{API-KEY-ID}Funções obrigatórias
Exige que a API Key chamando este ponto de extremidade tenha o Global Read Only função.
Parâmetros da solicitação
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
| string | Identificador único da chave de API global que você deseja recuperar. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
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
Elementos de resposta
Nome | Tipo | Descrição |
|---|---|---|
| string | Descrição desta chave de API global. |
| string | Identificador exclusivo para esta chave de API global. |
| string | Um array de documentos que representa um link para um ou mais sub-recursos ou recursos relacionados, como paginação de lista. Consulte Vinculação para obter mais informações. |
| string | Chave privada editada para esta chave de API global. |
| string | Chave pública para esta chave de API global. |
| array de objetos | Funções que esta chave de API global tem. Essa matriz retorna todos os roles globais que o usuário tem no Ops Manager. |
| string | Nome da função. Esse recurso retorna todos os roles que o usuário tem no Ops Manager. Os valores possÃveis são:
|
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true"Exemplo de resposta
Cabeçalho de resposta
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
{ "desc" : "Test Global API Key 1", "id" : "{API-KEY-ID}", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/{API-KEY-ID}", "rel" : "self" } ], "privateKey" : "********-****-****-54d9792d337d", "publicKey" : "zrefxaep", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" }, { "roleName" : "GLOBAL_BILLING_ADMIN" } ]}