Menu Docs

Página inicial do Docs → MongoDB Cloud Manager

Recuperar todas as políticas de recursos

Nesta página

  • Funções obrigatórias
  • Recurso
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

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

Funções obrigatórias

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

Recurso

GET /groups/availablePolicies

Parâmetros do caminho da solicitação

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

Solicitar parâmetros de query

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 um prettyprint formato.
false
envelope
booleano

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

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

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

Status
Código de resposta HTTP
envelope
Corpo de resposta esperado

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

none

Parâmetros do corpo da solicitação

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

Resposta

Nome
Tipo
Descrição
_id
string
Identificador único do projeto para o qual você está definindo esta política.
created
string
Carimbo de data/hora na ISO 8601 formato de data e hora 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 recursos foi atualizada.
externalManagementSystem
objeto
Identificar parâmetros para o sistema externo que managed este projeto do Cloud Manager.
externalManagementSystem
.name
string
Etiqueta de identificação para o sistema externo que managed este projeto do Cloud Manager.
externalManagementSystem
.systemId
string
Identificador único do sistema externo que managed este projeto do Cloud Manager.
externalManagementSystem
.version
string
Versão ativa do sistema externo que managed este projeto do Cloud Manager.
policies
array
Lista de políticas que o sistema externo aplica a este projeto do Cloud Manager.
policies
.policy[n]
objeto

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

Os valores possíveis são:

Valor
Propósito
EXTERNALLY_MANAGED_LOCK
Os usuários não podem usar o Cloud Manager para managed outras configurações fornecidas na matriz policies.policy[n] . Esses mesmos usuários podem usar um sistema externo configurado, como o Kubernetes para managed essas configurações.
DISABLE_USER_MANAGEMENT
Os usuários não podem managed usuários ou roles.
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 configuração mongod listada na array policies[n].disabledParams .
DISABLE_SET_MONGOD_
VERSION
Os usuários não podem alterar a versão de qualquer mongod ou mongos.
DISABLE_BACKUP_AGENT
Os usuários não podem habilitar ou desabilitar o agente de backup.
DISABLE_MONGOD_LOG_
MANAGEMENT
Os usuários não podem alterar as configurações de gerenciamento de registros.
DISABLE_IMPORT_TO_
AUTOMATION
Os usuários não podem managed 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 de 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.

Exemplo de solicitação

curl --user "{USERNAME}:{APIKEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/availablePolicies?pretty=true"

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

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}
← Atualizar políticas de recursos para um projeto
Migração de dados em tempo real do Cloud Manager para o MongoDB Atlas →

Nesta página