Docs Home

/ /

Listas de acceso de la organización

Docs Home

/ /

Claves de API programáticas

Listas de acceso de la organización

Claves de API programáticas

Listas de acceso de la organización

Obtenga una entrada de lista de acceso para una clave API de organización

Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de MongoDB Ops Manager.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Recuperar información sobre un único Entrada de la lista de acceso a laclave API que utiliza el identificador único para la Clave API 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,`192.0.2.0/24` como, utilice el valor codificado en URL en lugar de la barra `%2F` `/`diagonal.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Descripción

predeterminado

número de página

entero

Número de página (basado en el índice 1).

1

artículos por página

entero

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

100

bonita

booleano

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

false

envolvente

booleano

Indica si se debe envolver o no 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 puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Estado	Código de respuestaHTTP
envolvente	Cuerpo de respuesta esperado

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

Ninguno

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la 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 originaron desde esta dirección IP.
`created`	fecha	Fecha en que se agregó 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 originada desde esta dirección IP. Este campo solo aparece si al menos una solicitud se originó desde esta dirección IP y se actualiza únicamente cuando se recupera un recurso de la lista de acceso.
`lastUsedAddress`	string	Dirección IP desde la que se realizó la última llamada a la API. Este campo solo aparece si al menos una solicitud se originó desde esta dirección IP.
`links`	arreglo	Una matriz de documentos que representa un enlace a uno o más subrecursos o recursos relacionados, como la paginación de listas. Consulte Enlaces para obtener más información.

Ejemplo de solicitud

1 curl --user "{USERNAME}:{APIKEY}" --digest \
2   --header "Accept: application/json" \
3   --header "Content-Type: application/json" \
4   --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24?pretty=true"

Ejemplo de respuesta

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}

Cuerpo de respuesta

1 {
2     "cidrBlock": "192.0.2.0/24",
3     "count": 0,
4     "created": "2019-11-01T14:32:57Z",
5     "links": [
6         {
7             "href": "https://{OPSMANAGER-HOST}:{PORT}/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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",
12             "rel": "http://mms.mongodb.com/apiKeys"
13         }
14     ]
15 }

Volver

Obtener todas las entradas

Crear entradas

1	curl --user "{USERNAME}:{APIKEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--request GET "https://{OPSMANAGER-HOST}:{PORT}/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:32:57Z",
5	"links": [
6	{
7	"href": "https://{OPSMANAGER-HOST}:{PORT}/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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",
12	"rel": "http://mms.mongodb.com/apiKeys"
13	}
14	]
15	}