Menu Docs

Página inicial do Docs → MongoDB Ops Manager

Obter todos os projetos com tags específicas para o usuário atual

Nesta página

  • Recurso
  • Parâmetros da solicitação
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • documento de resposta
  • results documento incorporado
  • Exemplo de solicitação
  • Exemplo de resposta

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.

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

Recurso

GET /groups

Parâmetros da solicitação

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

Nome
Tipo
Descrição
marcar
string

As marcações atribuídas ao projeto para uso na identificação programática do projeto.

Parâmetros do corpo da solicitação

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

Resposta

documento de resposta

O documentoJSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

Nome
Tipo
Descrição
results
variedade
A array inclui um objeto para cada item detalhado na seção results Documento incorporado .
links
variedade
A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web.
totalCount
número
Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

results documento incorporado

Cada resultado é um projeto.

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 activeAgentCount .

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 roleName é o seguinte:

Role do usuário
roleName Valor
Project Owner (obrigatório)
GROUP_OWNER
Project Automation Admin
GROUP_AUTOMATION_ADMIN
Project Backup Admin
GROUP_BACKUP_ADMIN
Project Monitoring Admin
GROUP_MONITORING_ADMIN
Project Data Access Admin
GROUP_DATA_ACCESS_ADMIN
Project Data Access Read/Write
GROUP_DATA_ACCESS_READ_WRITE
Project Data Access Read Only
GROUP_DATA_ACCESS_READ_ONLY
Project Read Only
GROUP_READ_ONLY
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 links arrays nas respostas incluem pelo menos um link chamado self. Os relacionamentos entre URLs são explicados na Especificação de links da web.

name
string
Nome de exibição do projeto.
orgId
string
Identificador único da organização à qual o projeto pertence.
publicApiEnabled
boleano
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:

  • Diferenciam maiúsculas de minúsculas

  • Pode conter estes caracteres:

    • A através de Z

    • 0 através de 9

    • . (período)

    • _ (sublinhado)

    • - (traço)

  • Estão limitados a 32 caracteres

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups?tag=ABC&tag=DEF&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  "links": [],
3  "results": [{
4      "id": "xxx",
5      "name": "My Project",
6      "orgId": "111111111cccccf38dc78bdf",
7      "hostCounts": {
8        "arbiter": 2,
9        "config": 1,
10        "primary": 4,
11        "secondary": 8,
12        "mongos": 2
13          },
14      "lastActiveAgent": "2016-08-05T07:23:34Z",
15      "activeAgentCount": 1,
16      "replicaSetCount": 3,
17      "shardCount": 2,
18      "publicApiEnabled": true,
19      "agentApiKey": "cbd728abd6a6d6c6b6d7826345dbcff0e",
20      "tags": ["ABC", "DEF"],
21      "ldapGroupMappings": [{
22        "roleName": "GROUP_OWNER",
23        "ldapGroups": [ project-owner"]
24      }],
25      "links": []
26    }
27  ],
28  "totalCount": 1
29}
← Remover uma equipe de um projeto
Usuários →

Nesta página