Crear una entrada en la lista de acceso global

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.

Cree una entrada de lista de acceso global para Ops Manager.

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

Resource

POST /admin/accessList

Roles necesarios

Requiere que el La clave API que llama a este punto final tiene la Global Owner role.

Request Parameters

Parámetros de la ruta de solicitud

Este punto final no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato.

false

envolvente

booleano

Opcional

Bandera que 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 puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
Estado	Código de respuestaHTTP
envolvente	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Especifica un documento que represente una entrada de lista de acceso que desees agregar.

Al enviar una solicitud POST que contiene un valor cidrBlock que no está presente en la lista de acceso, Ops Manager agrega esas entradas a la lista de entradas existentes. Ops Manager no configura la lista de acceso para que contenga únicamente las entradas especificadas en la solicitud.

Nombre	Tipo	Necesidad	Descripción
`description`	string	Requerido	Descripción de la entrada de la lista de acceso global. Debe tener entre 1 y 250 caracteres.
`cidrBlock`	string	Requerido	Se agregará una entrada de lista de acceso en notación CIDR IPv4 o IPv.6

Respuesta

Nombre	Tipo	Descripción
`cidrBlock`	string	Rango de direcciones IP en una lista de acceso en notación CIDR IPv4 o IPv.6
`created`	string	Marca de tiempo, en la cantidad de segundos que han transcurrido desde la época UNIX en que agregó este bloque CIDR a la Lista de acceso global.
`description`	string	Explicación del propósito de esta entrada de lista de acceso global.
`id`	string	Identificador único para esta entrada de lista de acceso global.
`type`	string	Alcance de la entrada de la lista de acceso global.
`updated`	string	Marca de tiempo, en la cantidad de segundos que han transcurrido desde la época UNIX en la que modificó por última vez el bloque CIDR de esta entrada de lista de acceso global.

Ejemplo de solicitud

1 curl --user '{USER-ID}:{API-KEY}' --digest \
2 --header 'Accept: application/json' \
3 --header 'Content-Type: application/json' \
4 --include \
5 --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/accessList?pretty=true" \
6 --data '
7   {
8     "cidrBlock"  : "127.0.0.1/32",
9     "description" : "Docs Example"
10   }'

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" : "127.0.0.1/32",
3   "created" : "2019-09-04T17:45:33Z",
4   "description" : "Docs Example",
5   "expires" : null,
6   "id" : "5d6ff83dff4ab7133648b584",
7   "lastUsed" : null,
8   "type" : "GLOBAL_ROLE",
9   "updated" : "2019-09-04T17:45:33Z"
10 }

Volver

Obtenga una entrada

Actualizar entrada

1	curl --user '{USER-ID}:{API-KEY}' --digest \
2	--header 'Accept: application/json' \
3	--header 'Content-Type: application/json' \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/accessList?pretty=true" \
6	--data '
7	{
8	"cidrBlock" : "127.0.0.1/32",
9	"description" : "Docs Example"
10	}'

1	{
2	"cidrBlock" : "127.0.0.1/32",
3	"created" : "2019-09-04T17:45:33Z",
4	"description" : "Docs Example",
5	"expires" : null,
6	"id" : "5d6ff83dff4ab7133648b584",
7	"lastUsed" : null,
8	"type" : "GLOBAL_ROLE",
9	"updated" : "2019-09-04T17:45:33Z"
10	}