/ /

Políticas de control de funciones

Docs Home

/ /

Recursos

Políticas de control de funciones

Políticas de control de funciones

Recuperar todas las políticas de funciones

Cloud Manager dejará de ofrecer compatibilidad con automatización, copias de seguridad y monitorización para MongoDB 3.6 y 4.0 a partir del 30de agosto de 2024. Por favor, Actualice su implementación de MongoDB o migre a Atlas.

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

Roles necesarios

Este recurso requiere cualquier usuario autenticado o clave API.

Resource

GET /groups/availablePolicies

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

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 Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure "envelope" : true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuestaHTTP
`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 punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Nombre

Tipo

Descripción

_id

string

Identificador único del proyecto para el que está configurando esta política.

created

string

Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se creó esta política de control de funciones.

updated

string

Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se actualizó esta política de control de funciones.

externalManagementSystem

Objeto

Identificar parámetros para el sistema externo que administra este proyecto de Cloud Manager.

externalManagementSystem

.name

string

Etiqueta de identificación del sistema externo que administra este proyecto de Cloud Manager.

externalManagementSystem

.systemId

string

Identificador único del sistema externo que administra este proyecto de Cloud Manager.

externalManagementSystem

.version

string

Liberación activa del sistema externo que administra este proyecto de Cloud Manager.

policies

arreglo

Lista de políticas que el sistema externo aplica a este proyecto de Cloud Manager.

policies

.policy[n]

Objeto

Conjunto de políticas único para este proyecto de Cloud Manager. Este parámetro se puede configurar una o más veces en la matriz policies.

Los valores posibles son:

Valor	Propósito
`EXTERNALLY_MANAGED_LOCK`	Los usuarios no pueden usar Cloud Manager para administrar otras configuraciones especificadas en la matriz `policies.policy[n]`. Estos mismos usuarios pueden usar un sistema externo configurado, como el operador de Kubernetes, para administrar estas configuraciones.
`DISABLE_USER_MANAGEMENT`	Los usuarios no pueden administrar usuarios o roles.
`DISABLE_AUTHENTICATION_` `MECHANISMS`	Los usuarios no pueden cambiar la configuración de autenticación.
`DISABLE_SET_MONGOD_` `CONFIG`	Los usuarios no pueden cambiar ninguna configuración enumerada en `mongod` la `policies[n].disabledParams` matriz.
`DISABLE_SET_MONGOD_` `VERSION`	Los usuarios no pueden cambiar la versión de ningún `mongod` `mongos`o.
`DISABLE_BACKUP_AGENT`	Los usuarios no pueden habilitar ni deshabilitar el agente de respaldo.
`DISABLE_MONGOD_LOG_` `MANAGEMENT`	Los usuarios no pueden cambiar la configuración de administración de registros.
`DISABLE_IMPORT_TO_` `AUTOMATION`	Los usuarios no pueden administrar implementaciones mediante Automatización.
`DISABLE_AGENT_API_KEY_` `MANAGEMENT`	Los usuarios no pueden crear ni actualizar claves de API del agente.
`DISABLE_MONGOD_HOST_` `MANAGEMENT`	Los usuarios no pueden cambiar el tipo de servidor de los hosts.

policies[n]

.disabledParams

arreglo

Lista de configuraciones que se deshabilitarán si se aplica mongod la DISABLE_SET_MONGOD_CONFIG política. La automatización no es compatible con todas las opciones de MongoDB, lo que puede provocar intentos de importación fallidos. Para obtener más información, consulte Compatibilidad con configuraciones y automatización de MongoDB.

Ejemplo de solicitud

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/availablePolicies?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   "_id": "{PROJECT-ID}",
3   "created": "2019-08-29T15:03:24Z",
4   "updated": "2019-08-29T15:03:24Z",
5   "externalManagementSystem":
6   {
7     "name": "Operator",
8     "systemId": "6d6c139ae5528707b6e8e3b2",
9     "version": "0.2.1"
10   },
11   "policies": [
12     {"policy": "ExternallyManagedLock"},
13     {"policy": "DisableUserManagement"},
14     {"policy": "DisableAuthenticationMechanisms"},
15     {"policy": "DisableSetMongodVersion"},
16     {
17       "policy": "DisableSetMongodConfig",
18       "disabledParams": ["net.tls.CAFile"]
19     }
20   ]
21 }

Volver

Retrieve

Update

1	{
2	"_id": "{PROJECT-ID}",
3	"created": "2019-08-29T15:03:24Z",
4	"updated": "2019-08-29T15:03:24Z",
5	"externalManagementSystem":
6	{
7	"name": "Operator",
8	"systemId": "6d6c139ae5528707b6e8e3b2",
9	"version": "0.2.1"
10	},
11	"policies": [
12	{"policy": "ExternallyManagedLock"},
13	{"policy": "DisableUserManagement"},
14	{"policy": "DisableAuthenticationMechanisms"},
15	{"policy": "DisableSetMongodVersion"},
16	{
17	"policy": "DisableSetMongodConfig",
18	"disabledParams": ["net.tls.CAFile"]
19	}
20	]
21	}