URL base: https://cloud.mongodb.com/api/public/v1.0
Recupera información sobre todas las entradas de listas de acceso para la clave APIespecificada.
Resource
GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList
Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único de la organización a la que pertenece la clave API de destino. Solicitar el endpoint /orgs para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso. |
| string | Identificador único para la clave API para la cual desea recuperar las entradas de la lista de acceso. Solicite el extremo /orgs/{ORG-ID}/apiKeys para recuperar todas las claves API de la organización especificada a las que el usuario autenticado tiene 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
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
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 resultado es una entrada de 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
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true"
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/599c510c80eef518f3b63fe1/apiKeys/5c49e72980eef544a218f8f8/accessList/?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 } ], 6 "results" : [ { 7 "cidrBlock" : "147.58.184.16/32", 8 "count" : 0, 9 "created" : "2019-01-24T16:34:57Z", 10 "ipAddress" : "147.58.184.16", 11 "lastUsed" : "2019-01-24T20:18:25Z", 12 "lastUsedAddress": "147.58.184.16", 13 "links" : [ { 14 "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/147.58.184.16", 15 "rel" : "self" 16 } ] 17 }, { 18 "cidrBlock" : "84.255.48.125/32", 19 "count" : 0, 20 "created" : "2019-01-24T16:26:37Z", 21 "ipAddress" : null, 22 "lastUsed" : "2019-01-24T20:18:25Z", 23 "lastUsedAddress": "84.255.48.125", 24 "links" : [ { 25 "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/206.252.195.126", 26 "rel" : "self" 27 } ] 28 } ], 29 "totalCount" : 2 30 }