URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/agentapikeys
Este punto final está restringido a usuarios con
Project Read Only role.
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
PROJECT-ID | string | Identificador único del proyecto que posee la clave API del agente. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
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 Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
ID. | string | Identificador único de esta clave API de agente. |
clave | string | Clave API del agente. Después de crear esta clave API del agente, las solicitudes posteriores devuelven los últimos cuatro caracteres de las claves API del agente. |
desc | string | Etiqueta para esta clave API del agente. Limitada a 1,000 caracteres. |
tiempo de creación | string | Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se creó la clave API del agente. |
ID de usuario creado | string | Identificador único del usuario que creó esta clave API de agente. |
direcciónIP creada | string | DirecciónIP que creó esta clave API del agente. |
creado por | string | Origen de esta clave API del agente. Los valores aceptados son:
|
Ejemplo de solicitud
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/agentapikeys?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
[ { "_id" : "{AGENT-API-KEY-ID-1}", "createdBy" : "PUBLIC_API", "createdIpAddr" : "{IP-ADDRESS-1}", "createdTime" : 1520458807291, "createdUserId" : "{USER-ID-1}", "desc" : "Agent API Key for this project", "key" : "****************************8b87" }, { "_id" : "{AGENT-API-KEY-ID-2}", "createdBy" : "PROVISIONING", "createdTime" : 1508871142864, "desc" : "Generated by Provisioning", "key" : "****************************39fe" }, { "_id" : "{AGENT-API-KEY-ID-3}", "createdBy" : "USER", "createdIpAddr" : "{IP-ADDRESS-2}", "createdTime" : 1507067499083, "createdUserId" : "{USER-ID-2}", "desc" : "Initial API Key", "key" : "****************************70d7" } ]