/ /

/ /

Gerente de Operaciones

API

Recursos

agentes

Obtener todas las claves API de agentes para un proyecto

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 de la Proyecto que posee la clave API del agente.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de respuesta debe estar en un prettyprint formato.

false

envelope

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 endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
ID	string	Identificador único de esta clave API del agente.
llave	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. Limitado a 1,000 caracteres.
createdTime	string	Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se creó la clave API del agente.
createdUserId	string	Identificador único del usuario que creó esta clave API del agente.
direcciónIP creada	string	Dirección IP que creó esta clave API de agente.
createdBy	string	Origen de esta clave API del agente. Los valores aceptados son: `USER` `OLD_KEY` `PROVISIONING` `ATLAS` `PUBLIC_API`

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --include \
     --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/agentapikeys?pretty=true"

Respuesta de ejemplo

Encabezado de respuesta

HTTP/1.1 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

HTTP/1.1 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}

Respuesta del cuerpo

[ {
  "_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"
} ]

Volver

Crear clave de API

remover clave de API