Atualizar políticas de recursos para um projeto

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

Funções obrigatórias

Este recurso exige o Project Owner.

Resource

PUT /groups/{PROJECT-ID}/controlledFeature

Importante

Você deve incluir todas as políticas que deseja incluir e manter. Este recurso substitui qualquer política existente. Se você omitir uma política ao usar esse recurso, essa política não será aplicada após a atualização. Essa política foi removida.

Parâmetros do caminho da solicitação

Nome	Tipo	necessidade	Descrição
`PROJECT-ID`	string	Obrigatório	Identificador único do projeto que possui as funcionalidades controladas.

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 ser retornado em um formato bonito formatar.	`false`
envelope	booleano	Indica se a resposta deve ser encapsulada 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, defina `"envelope" : true` na consulta. 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 Cloud Manager adiciona o campo `status` ao corpo da resposta.	none

Parâmetros do corpo da solicitação

Nome	Tipo	Descrição
`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 aceitos são: `EXTERNALLY_MANAGED_LOCK`: os usuários não podem usar o Ops Manager para gerenciar outras configurações listadas na array `policies.policy[n]`. Esses mesmos usuários podem usar um sistema externo configurado, como o Operador Kubernetes para gerenciar essas configurações. `DISABLE_USER_MANAGEMENT`: os 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 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 gerenciar implantações usando 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 `mongod` a serem desabilitadas ao aplicar a política `DISABLE_SET_MONGOD_CONFIG`. Nem todas as opções do MongoDB estão disponíveis em automação, o que pode resultar em tentativas de importação malsucedidas. Para saber mais, consulte Suporte a configurações e automação do MongoDB .

Resposta

Nome	Tipo	Descrição
`_id`	string	Identificador único do Projeto ao qual esta política se aplica.
`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	Registro de data/hora no formato de data e hora ISO 8601 em UTC quando esta política de controle de funcionalidades 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: `EXTERNALLY_MANAGED_LOCK`: os usuários não podem usar o Cloud Manager para gerenciar outras configurações listadas na array `policies.policy[n]`. Esses mesmos usuários podem usar um sistema externo configurado, como o Operador Kubernetes para gerenciar essas configurações. `DISABLE_USER_MANAGEMENT`: os 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 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 gerenciar implantações usando 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`. Nem todas as opções do MongoDB estão disponíveis em automação, o que pode resultar em tentativas de importação malsucedidas. Para saber mais, consulte Suporte a configurações e automação do MongoDB .

Exemplo de solicitação

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PUT "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/controlledFeature?pretty=true" \
6      --data '{
7        "externalManagementSystem":
8        {
9          "name": "Operator",
10          "systemId": "6d6c139ae5528707b6e8e3b2",
11          "version": "0.2.1"
12        },
13        "policies": [
14          {"policy": "ExternallyManagedLock"},
15          {"policy": "DisableUserManagement"},
16          {"policy": "DisableAuthenticationMechanisms"},
17          {"policy": "DisableSetMongodVersion"},
18          {
19            "policy": "DisableSetMongodConfig",
20            "disabledParams": ["net.tls.CAFile"]
21          }
22        ]
23      }'

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 }

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PUT "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/controlledFeature?pretty=true" \
6	--data '{
7	"externalManagementSystem":
8	{
9	"name": "Operator",
10	"systemId": "6d6c139ae5528707b6e8e3b2",
11	"version": "0.2.1"
12	},
13	"policies": [
14	{"policy": "ExternallyManagedLock"},
15	{"policy": "DisableUserManagement"},
16	{"policy": "DisableAuthenticationMechanisms"},
17	{"policy": "DisableSetMongodVersion"},
18	{
19	"policy": "DisableSetMongodConfig",
20	"disabledParams": ["net.tls.CAFile"]
21	}
22	]
23	}'

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	}