URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
POST /users/{USER-ID}/accessList
Parámetros de ruta de solicitud
Parameter | Tipo | Descripción |
|---|---|---|
ID de usuario | string | (Obligatorio). Identificador único del usuario actual. Para recuperar el ID del usuario actual, consulte Obtén todos los usuarios en un proyecto. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
Num. de pág. | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
elementosPorPágina | Número | Opcional | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de la respuesta debe estar en un prettyprint formato. |
|
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediarlo, establezca Para los endpoints que devuelven una lista de resultados, el objeto |
|
backupJobsEnabledOnly | booleano | Opcional | Indicador que indica si se deben excluir los demonios que no están habilitados para hacer copias de seguridad de bases de datos de la respuesta. Establece esto en |
|
Parámetros del cuerpo de la solicitud
El cuerpo de la solicitud debe ser un arreglo de entidades de la lista de accesos, incluso si sólo hay una. El único campo que debes especificar para cada objeto de solicitud es la DIRECCIÓN IP.
Si una dirección IP ya está en la lista de acceso, será ignorada.
Si especificas una dirección IP individual con la máscara de subred /32, Cloud Manager no almacenará el /32, ya que el /32 no modifica la dirección.
Ejemplo
Una dirección de 12.34.56.78 es igual que 12.34.56.78/32.
Parameter | Tipo | Descripción |
|---|---|---|
Dirección IP | string | (Obligatorio). La dirección IP o el bloque CIDR que quieres agregar a la lista de acceso del usuario especificado. |
Respuesta
Documento de respuesta
El documento de respuesta JSON incluye un arreglo de result objetos, un arreglo de link objetos y una cantidad del número total de result objetos 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 resultado es una lista de acceso.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Un rango de direcciones IP con notación CIDR. |
| fecha | La fecha en que se agregó esta dirección IP a la lista de acceso. |
| string | Una dirección IP en la lista de acceso. |
| fecha | La fecha de la solicitud más reciente que se originó desde esta dirección IP. Deben tenerse en cuenta que este campo solo se actualiza cuando se accede a un recurso protegido por la lista de acceso. |
| string | La dirección desde la cual se realizó la última llamada a la API. |
| Número | El número total de solicitudes que se originaron desde esta dirección IP. Ten en cuenta que este campo solo se actualiza cuando se accede a un recurso protegido por la lista de acceso. |
| arreglo | Enlaces a subrecursos relacionados. Todos los arreglos de enlaces en las respuestas contienen al menos un enlace llamado |
Solicitud de ejemplo
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/accessList" --data ' [ { "ipAddress" : "192.0.1.15", "comment" : "IP address for Application Server A" }, { "cidrBlock" : "192.0.2.0/24", "comment" : "CIDR block for Application Server B - D" } ]'
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
201 Created 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
{ "totalCount" : 3, "results" : [ { "cidrBlock" : "12.34.56.78/32", "ipAddress" : "12.34.56.78", "created" : "2014-04-23T16:17:44Z", "lastUsed" : "2016-08-17T19:34:05Z", "lastUsedAddress" : "12.34.56.78", "count" : 0, "links" : [] }, { "cidrBlock" : "76.54.32.10/32", "ipAddress" : "76.54.32.10", "created" : "2016-08-17T19:34:05Z", "count" : 0, "links" : [] }, { "cidrBlock" : "2.3.4.5/32", "ipAddress" : "2.3.4.5", "created" : "2016-08-17T19:34:05Z", "count" : 0, "links" : [] } ], "links" : [] }