Devolver todo Global ClavesAPI para Ops Manager.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/apiKeys
Roles necesarios
Requiere que la clave API que llama a este punto final tenga la
Global Read Only role.
Request Parameters
Parámetros de la ruta de solicitud
Este punto final no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
número de página | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
artículos por página | Número | Opcional | Número de artículos a devolver por página, hasta un máximo de 500. |
|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato. |
|
envolvente | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionarlo, configure Para los puntos finales que devuelven una lista de resultados, el objeto |
|
trabajos de respaldo habilitados solamente | booleano | Opcional | Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en |
|
Respuesta
Documento de respuesta
El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | La matriz incluye un objeto para cada elemento detallado en la |
| arreglo | La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web. |
| Número | Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado. |
results Documento incrustado
Cada resultado es una clave API.
Nombre | Tipo | Descripción | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | Descripción de esta clave API global. | ||||||||||||||
| string | Identificador único para esta clave API global. | ||||||||||||||
| string | Una matriz de documentos que representa un enlace a uno o más subrecursos o recursos relacionados, como la paginación de listas. Consulte Enlaces para obtener más información. | ||||||||||||||
| string | Clave privada redactada para esta clave API global. | ||||||||||||||
| string | Clave pública para esta clave API global. | ||||||||||||||
| matriz de objetos | Roles que tiene esta clave API global. Esta matriz 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:
|
Ejemplo de solicitud
Nota
El usuario que realiza la solicitud puede tener el formato {USERNAME}:{APIKEY} o {PUBLIC-KEY}:{PRIVATE-KEY}.
1 curl --user "{USERNAME}:{APIKEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true"
Ejemplo de respuesta
Encabezado de respuesta
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
Cuerpo de respuesta
1 { 2 "links" : [ { 3 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 } ], 6 "results" : [ { 7 "desc" : "Test Global API Key 1", 8 "id" : "5d669ce780eef52a42cf0e1e", 9 "links" : [ { 10 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e", 11 "rel" : "self" 12 } ], 13 "privateKey" : "********-****-****-54d9792d337d", 14 "publicKey" : "zrefxaep", 15 "roles" : [ { 16 "roleName" : "GLOBAL_READ_ONLY" 17 }, { 18 "roleName" : "GLOBAL_BILLING_ADMIN" 19 } ] 20 }, { 21 "desc" : "Test Global API Key 2", 22 "id" : "5d6fec4180eef54728814b14", 23 "links" : [ { 24 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fec4180eef54728814b14", 25 "rel" : "self" 26 } ], 27 "privateKey" : "********-****-****-fe646723a586", 28 "publicKey" : "qlgofmne", 29 "roles" : [ { 30 "roleName" : "GLOBAL_READ_ONLY" 31 } ] 32 }, { 33 "desc" : "Test Global API Key 3", 34 "id" : "5d6fecfc80eef547288207f3", 35 "links" : [ { 36 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fecfc80eef547288207f3", 37 "rel" : "self" 38 } ], 39 "privateKey" : "********-****-****-fe348ed1796f", 40 "publicKey" : "cfswjfck", 41 "roles" : [ { 42 "roleName" : "GLOBAL_READ_ONLY" 43 }, { 44 "roleName" : "GLOBAL_BILLING_ADMIN" 45 }, { 46 "roleName" : "GLOBAL_USER_ADMIN" 47 } ] 48 } ], 49 "totalCount" : 3 50 }