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:

Nombre	Descripción
Estado	Código de respuestaHTTP
envolvente	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Descripción
desc	string	Etiqueta para esta clave API de agente.

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: `USER` `OLD_KEY` `PROVISIONING` `ATLAS` `PUBLIC_API`

Ejemplo de solicitud

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request POST "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/agentapikeys?pretty=true" \
 --data '
   {
     "desc": "Agent API Key for this project"
   }'

Ejemplo de respuesta

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}

Cuerpo de respuesta

{
  "_id" : "{AGENT-API-KEY-ID}",
  "createdBy" : "PUBLIC_API",
  "createdIpAddr" : "{IP-ADDRESS}",
  "createdTime" : 1520458807291,
  "createdUserId" : "{USER-ID}",
  "desc" : "Agent API Key for this project",
  "key" : "{AGENT-API-KEY}"
}

Volver

Recuperar para un proyecto

Obtener todas las claves API