Nota
Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.
Utilice este punto final para realizar cualquiera de los siguientes cambios en un proyecto:
Cambiar el nombre de un proyecto.
Agregar y eliminar etiquetas de un proyecto.
Map GruposLDAP en roles de Ops Manager para un proyecto.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /groups/{PROJECT-ID}
Request Parameters
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
PROJECT-ID | string | (Obligatorio) El identificador único del proyecto. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato. |
| ||||||
envolvente | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionarlo, configure envelope=true en la consulta. Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Debe incluir al menos uno de los siguientes campos en el cuerpo de la solicitud:
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
Nombre | string | Opcional | El nuevo nombre del proyecto. |
Etiquetas | matriz de cadenas | Opcional | Las etiquetas asignadas al proyecto para su uso en la identificación programática del proyecto.
Un proyecto puede tener hasta 10 etiquetas. Las etiquetas siguen estas reglas:
|
Asignaciones de grupos ldap | matriz de objetos | Opcional | Para Ops Manager con respaldo LDAP, las asignaciones de grupos LDAP a roles de proyecto de Ops Manager. Solo se aceptan para Ops Manager con respaldo LDAP. |
Respuesta
Nombre | Tipo | Descripción | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
activeAgentCount | entero | Número de agentes activos que envían pings regulares a Ops Manager. El valor se actualiza aproximadamente cada 24 horas y se almacena en caché. Si inicia un nuevo agente o detiene uno existente, el cambio puede tardar hasta 30 minutos en aparecer en el campo | ||||||||||||||||||
hostCounts | Objeto | Número total de hosts por tipo. Los campos incrustados deberían ser autoexplicativos. | ||||||||||||||||||
ID. | string | Identificador único del proyecto. | ||||||||||||||||||
último agente activo | string | Hora de la última actualización del total de | ||||||||||||||||||
Asignaciones de grupos ldap | matriz de objetos | Para Ops Manager con respaldo LDAP, las asignaciones de grupos LDAP a roles de proyecto de Ops Manager. Solo está presente para Ops Manager con respaldo LDAP. | ||||||||||||||||||
ldapGroupMappings .roleName | string | Rol de usuario de Ops Manager. La asignación de Rol de proyecto a
| ||||||||||||||||||
ldapGroupMappings .ldapGroups | matriz de cadenas | Proyecto(s) LDAP que se asignan al rol de Administrador de operaciones. | ||||||||||||||||||
enlaces | matriz de objetos | Uno o más enlaces a subrecursos o recursos relacionados. Todas las | ||||||||||||||||||
Nombre | string | Nombre para mostrar del proyecto. | ||||||||||||||||||
orgId | string | Identificador único de la organización a la que pertenece el proyecto. | ||||||||||||||||||
publicApiEnabled | booleano | Indicador que indica que la API está habilitada para este proyecto. Este campo es de solo lectura y siempre | ||||||||||||||||||
recuento de conjuntos de réplicas | entero | Número total de conjuntos de réplicas para este proyecto. | ||||||||||||||||||
recuento de fragmentos | entero | Número total de fragmentos para este proyecto. | ||||||||||||||||||
Etiquetas | matriz de cadenas | Etiquetas asignadas al proyecto para su uso en la identificación programática del proyecto.
Un proyecto puede tener hasta 10 etiquetas. Las etiquetas siguen estas reglas:
|
Ejemplo de solicitud
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" ] }'
Ejemplo de respuesta
Encabezado de respuesta
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}
Cuerpo de respuesta
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 }