/ /

Listas de acceso

Docs Home

/ /

Claves de API programáticas

Claves de API programáticas

Listas de acceso

Obténgase una entrada de lista de acceso para una clave API de una organización

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

URL base: https://cloud.mongodb.com/api/public/v1.0

Recuperar información sobre un solo Clave de API entrada de acceso usando el identificador único para el API clave y dirección IP deseada.

Resource

GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/{ACCESS-LIST-ENTRY}

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
`ORG-ID`	string	Identificador único de la organización a la que pertenece la clave API de destino. Solicita al punto de conexión /orgs que recupere todas las organizaciones a las que el usuario autenticado tiene acceso.
`API-KEY-ID`	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.
`ACCESS-LIST-ENTRY`	string	La dirección IP o CIDR. Si la entrada incluye una máscara de subred, como `192.0.2.0/24`, use el valor codificado en URL `%2F` para la barra diagonal `/`.

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).

1

elementosPorPágina

entero

Número de elementos a devolver por página, hasta un máximo de 500.

100

bonito

booleano

Indica si el cuerpo de la respuesta debe estar en un prettyprint formato.

false

envelope

booleano

Indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionarlo, configure "envelope" : true en la consulta.

Para los endpoints que devuelven un resultado, el cuerpo de respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

Para los endpoints que devuelven una lista de resultados, el objeto results es un sobre. Cloud Manager añade el campo status al cuerpo de la respuesta.

Ninguno

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
`cidrBlock`	string	Rango de direcciones IP anotadas en CIDR en la lista de acceso.
`count`	Número	Número total de solicitudes que se han originado desde esta dirección IP.
`created`	fecha	Fecha en que se añadió esta dirección IP a la lista de acceso.
`ipAddress`	string	Dirección IP en la lista de acceso.
`lastUsed`	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.
`lastUsedAddress`	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.
`links`	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 "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --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 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}

Respuesta del cuerpo

1 {
2   "cidrBlock": "192.0.2.0/24",
3   "count": 0,
4   "created": "2019-11-01T14:44:44Z",
5   "links": [
6     {
7                "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24",
8                "rel": "self"
9            },
10            {
11                "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",
12                "rel": "http://mms.mongodb.com/apiKeys"
13            }
14        ]
15    }

Volver

Obtener todo

Borrar

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--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"

1	{
2	"cidrBlock": "192.0.2.0/24",
3	"count": 0,
4	"created": "2019-11-01T14:44:44Z",
5	"links": [
6	{
7	"href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24",
8	"rel": "self"
9	},
10	{
11	"href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",
12	"rel": "http://mms.mongodb.com/apiKeys"
13	}
14	]
15	}