URL base: https://cloud.mongodb.com/api/public/v1.0
Cree una o más nuevas entradas en la lista de acceso para la API Keyespecificada.
Resource
POST /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList
Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único para la organización a la que pertenece la clave API de destino. Utiliza el endpoint /orgs para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso. |
| string | Identificador único para la Organización API clave para la que deseas crear una nueva entrada en la lista de acceso. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|
Num. de pág. | entero | Número de página (basado en índice a partir de 1). |
| ||||||
elementosPorPágina | entero | Número de elementos a devolver por página, hasta un máximo de 500. |
| ||||||
bonito | booleano | Indica si el cuerpo de la respuesta debe estar en un formato prettyprint. |
| ||||||
envelope | booleano | Indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP o al código de estado. Para remediarlo, establezca Para los endpoints que devuelven un resultado, el cuerpo de respuesta incluye:
Para los endpoints que devuelven una lista de resultados, el objeto | Ninguno |
Parámetros del cuerpo de la solicitud
Especifica un arreglo de documentos, donde cada documento representa una entrada de lista de acceso que se desea añadir al Proyecto. Debe especificar un arreglo incluso si solo está asociando una única entrada de lista de acceso al Proyecto.
Cuando se envía una solicitud POST que contiene valores ipAddress o cidrBlock que no están presentes en la lista de acceso, Cloud Manager añade esas entradas a la lista de entradas existentes en la lista de acceso. Cloud Manager no establece que la lista de acceso contenga solo las entradas especificadas en la solicitud.
Nota
Cloud Manager es compatible con hasta 500 claves API dentro de una sola organización.
En la siguiente tabla, [i] representa un índice de arreglo.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Dirección IP que se añadirá a la lista de acceso para la clave API. Este campo es mutuamente excluyente con el campo |
| string | Entrada de lista de acceso en notación CIDR que se añadirá para la clave API. Este campo es excluyente con el campo |
Respuesta
Documento de respuesta
El documento de respuesta JSON incluye un arreglo de objetos result, un arreglo de objetos link y un recuento del número total de objetos result recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | El arreglo incluye un objeto para cada elemento detallado en la sección del |
| arreglo | El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web. |
| Número | Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado. |
results embeddedDocument
Cada objeto dentro del arreglo results es un registro en la lista de acceso.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Rango de direcciones IP en notación CIDR en la lista de acceso. |
| Número | Número total de solicitudes que se han originado desde esta dirección IP. |
| fecha | Fecha en que se añadió esta dirección IP a la lista de acceso. |
| string | Dirección IP en la lista de acceso. |
| fecha | Fecha de la solicitud más reciente que se originó desde esta dirección IP. Este campo solo aparece si al menos una solicitud se ha originado desde esta dirección IP, y solo se actualiza cuando se recupera un recurso de la lista de acceso. |
| string | Dirección IP desde la que se emitió la última llamada a la API. Este campo solo aparece si al menos una solicitud se ha originado desde esta dirección IP. |
| arreglo | Un arreglo de documentos que representa un enlace a uno o más subrecursos y/o recursos relacionados, como la paginación de la lista. Consulta Vinculación para obtener más información. |
Solicitud de ejemplo
1 curl --user '{USER-ID}:{API-KEY}' --digest \ 2 --header 'Accept: application/json' \ 3 --header 'Content-Type: application/json' \ 4 --include \ 5 --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true" \ 6 --data ' 7 [{ 8 "ipAddress" : "77.54.32.11" 9 }]'
Respuesta de ejemplo
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}
Respuesta del cuerpo
1 { 2 "links" : [ { 3 "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 } ], 6 "results" : [ { 7 "cidrBlock" : "206.252.195.126/32", 8 "count" : 47, 9 "created" : "2019-01-24T16:26:37Z", 10 "ipAddress" : "206.252.195.126", 11 "lastUsed" : "2019-01-25T16:32:47Z", 12 "lastUsedAddress" : "206.252.195.126", 13 "links" : [ { 14 "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/206.252.195.126", 15 "rel" : "self" 16 } ] 17 }, { 18 "cidrBlock" : "76.54.32.11/32", 19 "count" : 0, 20 "created" : "2019-01-24T21:09:05Z", 21 "ipAddress" : null, 22 "links" : [ { 23 "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/76.54.32.11", 24 "rel" : "self" 25 } ] 26 } ], 27 "totalCount" : 2 28 }