Atualizar um projeto
Nesta página
Observação
Grupos e projetos são termos sinônimos. Seu {PROJECT-ID}
é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.
Use esse endpoint para fazer qualquer uma das seguintes alterações em um projeto:
Alterar o nome de um projeto.
Adicione e remova tags de um projeto.
Mapear gruposLDAP para roles MongoDB Ops Manager para um projeto.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /groups/{PROJECT-ID}
Parâmetros da solicitação
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
---|---|---|
ID do projeto | string | (Obrigatório.) O identificador exclusivo do projeto. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato. | false | ||||||
envelope | booleano | Opcional | Sinalizador que 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, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui:
| false |
Parâmetros do corpo da solicitação
Você deve incluir pelo menos um dos seguintes campos no corpo da solicitação:
Nome | Tipo | necessidade | Descrição |
---|---|---|---|
name | string | Opcional | O novo nome do projeto. |
tags | array de strings | Opcional | As marcações atribuídas ao projeto para uso na identificação programática do projeto.
Um projeto pode ter até 10 tags. As marcações seguem estas regras:
|
ldapGroupMappings | array de objetos | Opcional | Para LDAPo apoiado por MongoDB Ops Manager, os mapeamentos de LDAP grupos para MongoDB Ops Manager roles de projeto . Aceito somente para o MongoDB Ops Manager apoiado pelo LDAP. |
Resposta
Nome | Tipo | Descrição | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ActiveAgentCount | inteiro | Número de agente ativos que enviam ping regulares ao Ops Manager. O valor é atualizado a cada 24 horas e armazenado em cache. Se você iniciar um novo agente ou interromper um existente, a alteração pode levar até 30 minutos para aparecer no campo | ||||||||||||||||||
hostCounts | objeto | Número total de hosts por tipo. Os campos incorporados devem ser autoexplicativos. | ||||||||||||||||||
id | string | Identificador único do projeto. | ||||||||||||||||||
lastActiveAgent | string | O Time Ops Manager atualizou pela última vez o total de activeAgentCount para o projeto. O Ops Manager atualiza esse valor a cada 24 horas e o armazena em cache para registrar o número de agente MongoDB ativos. | ||||||||||||||||||
ldapGroupMappings | array de objetos | For LDAP-backed Ops Manager, the mappings of LDAP groups to Ops Manager project roles. Presente apenas para o Ops Manager suportado por LDAP. | ||||||||||||||||||
ldapGroupMappings .roleName | string | Role de usuário do Ops Manager. O mapeamento da função do projeto para
| ||||||||||||||||||
ldapGroupMappings .ldapGroups | array de strings | Projeto(s) LDAP que mapeiam para a role de Ops Manager. | ||||||||||||||||||
links | array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays | ||||||||||||||||||
name | string | Nome de exibição do projeto. | ||||||||||||||||||
orgId | string | Identificador único da organização à qual o projeto pertence. | ||||||||||||||||||
publicApiEnabled | booleano | Sinalizador que indica que a API está ativada para este projeto. Este é um campo somente leitura que está sempre true . | ||||||||||||||||||
replicaSetCount | inteiro | Número total de conjuntos de réplica para este projeto. | ||||||||||||||||||
shardCount | inteiro | Número total de shards para este projeto. | ||||||||||||||||||
tags | array de strings | Marcações atribuídas ao projeto para uso na identificação programática do projeto.
Um projeto pode ter até 10 tags. As marcações seguem estas regras:
|
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}?pretty=true" \ --data ' { "ldapGroupMappings": [{ "roleName": "GROUP_OWNER", "ldapGroups": [ "project-owner" ] }], "name": "Project Name 1", "tags": [ "DEV", "PRODUCT" ] }'
Exemplo de resposta
Cabeçalho de resposta
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
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 "name": Project Name 1", 4 "orgId" : "{ORG-ID}", 5 "hostCounts": { 6 "arbiter": 2, 7 "config": 1, 8 "primary": 4, 9 "secondary": 8, 10 "mongos": 2 11 }, 12 "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"), 13 "activeAgentCount": 1, 14 "replicaSetCount": 3, 15 "shardCount": 2, 16 "publicApiEnabled": true, 17 "agentApiKey": "{API-KEY}", 18 "tags": [ "DEV", "PRODUCT" ], 19 "ldapGroupMappings" : [ { 20 "roleName": "GROUP_OWNER", 21 "ldapGroups": [ "project-owner" ] 22 }, ... ], 23 "links" : [] 24 }