Devuelva una clave Global API para Ops Manager usando el identificador único de esa Clave.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/apiKeys/{API-KEY-ID}Roles necesarios
Requiere que la clave de API que llama a este endpoint tenga el rol de Global Read Only.
Request Parameters
Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único para la clave Global de API que desea recuperar. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print. |
|
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Elementos de respuesta
Nombre | Tipo | Descripción |
|---|---|---|
| string | Descripción de esta clave API global. |
| string | Identificador único para esta clave de API global. |
| string | Un arreglo de documentos que representa un vÃnculo a uno o más subrecursos o recursos relacionados como paginación de lista. Consulte Vinculación para obtener más información. |
| string | llave privada redactada para esta clave global API. |
| string | Clave pública para esta clave API global. |
| objeto arreglo | Roles que tiene esta clave API global. Este arreglo devuelve todos los roles Globales que el usuario tiene en Ops Manager. |
| string | Nombre del rol. Este recurso devuelve todos los roles que el usuario tiene en Ops Manager. Los valores posibles son:
|
Solicitud de ejemplo
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"Respuesta de ejemplo
Encabezado de respuesta
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}Respuesta del cuerpo
{ "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" } ]}