Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Recuperar todas as políticas de recursos

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

Esse recurso requer qualquer usuário autenticado ou chave de API.

GET /groups/availablePolicies

Este endpoint não usa parâmetros de caminho de solicitação HTTP.

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
Descrição
Default

pageNum

inteiro

Número da página (com base em índice 1).

1

itemsPerPage

inteiro

Número de itens a serem devolvidos por página, até um máximo de 500.

100

pretty

booleano

Indica se o corpo da resposta deve estar em formato prettyprint.

false

envelope

booleano

Indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure "envelope" : true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

  • status: Código de resposta HTTP

  • content: Corpo de resposta esperado

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Ops Manager adiciona o campo status ao corpo da resposta.

none

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Nome
Tipo
Descrição

_id

string

Identificador único do projeto para o qual você está definindo esta política.

created

string

Registro de data/hora no formato de data e hora ISO 8601 em UTC quando esta política de controle de funcionalidades foi criada.

updated

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando esta política de controle de recurso foi atualizada.

externalManagementSystem

objeto

Identificar parâmetros para o sistema externo que managed esse projeto do Ops Manager.

externalManagementSystem
.name

string

Identificar etiqueta para o sistema externo que managed este projeto do Ops Manager.

externalManagementSystem
.systemId

string

Identificador único do sistema externo que managed este projeto do Ops Manager.

externalManagementSystem
.version

string

Versão ativa do sistema externo que managed este projeto do Ops Manager.

policies

array

Lista de políticas que o sistema externo aplica a este projeto do Ops Manager.

policies
.policy[n]

objeto

Política única definida para este projeto do Ops Manager. Este parâmetro pode ser definido uma ou mais vezes na array policies .

Os valores possíveis são:

  • EXTERNALLY_MANAGED_LOCK: Os usuários não podem usar o MongoDB Ops Manager para gerenciar outras configurações fornecidas no policies.policy[n] array. Esses mesmos usuários podem usar um sistema externo configurado, como o operador do Kubernetes, para gerenciar essas configurações.

  • DISABLE_USER_MANAGEMENT: Usuários não podem gerenciar usuários ou funções.

  • DISABLE_AUTHENTICATION_MECHANISMS: Os usuários não podem alterar as configurações de autenticação.

  • DISABLE_SET_MONGOD_CONFIG: Os usuários não podem alterar nenhuma das configurações mongod listadas no policies[n].disabledParams array.

  • DISABLE_SET_MONGOD_VERSION: Os usuários não podem alterar a versão de nenhum mongod ou mongos.

  • DISABLE_BACKUP_AGENT: Os usuários não podem ativar ou desativar o agente de backup.

  • DISABLE_MONGOD_LOG_MANAGEMENT: Os usuários não podem alterar as configurações de gerenciamento de log.

  • DISABLE_IMPORT_TO_AUTOMATION: Os usuários não podem gerenciar implantações usando a automação.

  • DISABLE_AGENT_API_KEY_MANAGEMENT: Os usuários não podem criar ou atualizar chaves de API do agente.

  • DISABLE_MONGOD_HOST_MANAGEMENT: Os usuários não podem alterar o tipo de servidor dos hosts.

policies[n]
.disabledParams

array

Lista de configurações do mongod para desabilitar se você aplicar a política do DISABLE_SET_MONGOD_CONFIG . A automação não oferece suporte a todas as opções do MongoDB , o que pode resultar em tentativas fracassadas de importação. Para saber mais, consulte Suporte a configurações e automação do MongoDB .

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"
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-alive
HTTP/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}
{ "_id": "{PROJECT-ID}", "created": "2019-08-29T15:03:24Z", "updated": "2019-08-29T15:03:24Z", "externalManagementSystem": { "name": "Operator", "systemId": "6d6c139ae5528707b6e8e3b2", "version": "0.2.1" }, "policies": [ {"policy": "ExternallyManagedLock"}, {"policy": "DisableUserManagement"}, {"policy": "DisableAuthenticationMechanisms"}, {"policy": "DisableSetMongodVersion"}, { "policy": "DisableSetMongodConfig", "disabledParams": ["net.tls.CAFile"] } ]}