URL base: https://cloud.mongodb.com/api/public/v1.0
Recuperar información sobre una única entrada de lista de acceso de clave API utilizando el identificador único de la clave API y la dirección IP deseada.
Resource
GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/{ACCESS-LIST-ENTRY}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 API Key para la cual desea recuperar entradas de la lista de acceso. Haga una solicitud al endpoint /orgs/{ORG-ID}/apiKeys para recuperar todas las claves de API para la organización especificada a la que el usuario autenticado tiene acceso. |
| string | La dirección IP o CIDR. Si la entrada incluye una máscara de subred, como |
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 envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para corregir esto, 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
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/192.0.2.0%2F24?pretty=true"Respuesta de ejemplo
Encabezado de respuesta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
{ "cidrBlock": "192.0.2.0/24", "count": 0, "created": "2019-11-01T14:44:44Z", "links": [ { "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24", "rel": "self" }, { "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}", "rel": "http://mms.mongodb.com/apiKeys" } ] }