Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos
/
Projetos e usuários
/
Projetos

Obter todos os projetos para o usuário atual

Nesta página

  • Resource
  • 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

Resource

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

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default

pageNum

número

Opcional

Um inteiro baseado que retorna uma subseção de resultados.

1

itemsPerPage

número

Opcional

Número de itens a serem devolvidos por página, até um máximo de 500.

100

pretty

booleano

Opcional

Sinalizador que indica 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 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 uma lista de resultados, o objeto results é um envelope. O Ops Manager adiciona o campo status ao corpo da resposta.

false

backupJobsEnabledOnly

booleano

Opcional

Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como false para incluir configurações de daemon com o sinalizador backupJobsEnabled definido como false.

true

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 documento JSON 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

array

A array inclui um objeto para cada item detalhado na seção results Documento incorporado .

links

array

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 arrays links 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

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.

  • Para visualizar tags, você deve ter o role Project Read Only .

  • Para criar ou editar tags, você deve ter a role Project Automation Admin .

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

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --include \
4 --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups?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    "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups?pretty=true&pageNum=1&itemsPerPage=100",
4    "rel": "self"
5  }, {
6    "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups?pretty=true&itemsPerPage=100&pageNum=2",
7    "rel": "next"
8  }],
9  "results": [{
10    "activeAgentCount": 0,
11    "hostCounts": {
12      "arbiter": 0,
13      "config": 0,
14      "mongos": 0,
15      "primary": 0,
16      "secondary": 0
17    },
18    "id": "56a10a80e4b0fd3b9a9bb0c2",
19    "lastActiveAgent": "2016-03-09T18:19:37Z",
20    "links": [{
21      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
22      "rel": "self"
23    }],
24    "name": "012i3091203jioawjioej",
25    "orgId": "5980cfdf0b6d97029d82f86e",
26    "publicApiEnabled": true,
27    "replicaSetCount": 0,
28    "shardCount": 0,
29    "tags": []
30  }, {
31    "activeAgentCount": 0,
32    "hostCounts": {
33      "arbiter": 0,
34      "config": 0,
35      "mongos": 0,
36      "primary": 0,
37      "secondary": 0
38    },
39    "id": "56aa691ce4b0a0e8c4be51f7",
40    "lastActiveAgent": "2016-01-29T19:02:56Z",
41    "links": [{
42      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
43      "rel": "self"
44    }],
45    "name": "1454008603036",
46    "orgId": "5980d0040b6d97029d831798",
47    "publicApiEnabled": true,
48    "replicaSetCount": 0,
49    "shardCount": 0,
50    "tags": []
51  }, {
52    "activeAgentCount": 0,
53    "hostCounts": {
54      "arbiter": 0,
55      "config": 0,
56      "mongos": 0,
57      "primary": 0,
58      "secondary": 0
59    },
60    "id": "56aa6dfde4b0fe328eee82ad",
61    "lastActiveAgent": "2016-01-29T20:34:28Z",
62    "links": [{
63      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
64      "rel": "self"
65    }],
66    "name": "1454009852809",
67    "orgId": "5980d0040b6d97029d831799",
68    "publicApiEnabled": true,
69    "replicaSetCount": 0,
70    "shardCount": 0,
71    "tags": []
72  }, {
73    "activeAgentCount": 0,
74    "hostCounts": {
75      "arbiter": 0,
76      "config": 0,
77      "mongos": 0,
78      "primary": 0,
79      "secondary": 0
80    },
81    "id": "56aa8421e4b0d04c1c54df99",
82    "lastActiveAgent": "2016-01-29T21:36:10Z",
83    "links": [{
84      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
85      "rel": "self"
86    }],
87    "name": "1454015520776",
88    "orgId": "5980d0040b6d97029d83179a",
89    "publicApiEnabled": true,
90    "replicaSetCount": 0,
91    "shardCount": 0,
92    "tags": []
93  }, {
94    "activeAgentCount": 0,
95    "hostCounts": {
96      "arbiter": 0,
97      "config": 0,
98      "mongos": 0,
99      "primary": 0,
100      "secondary": 0
101    },
102    "id": "56aa85f9e4b0d04c1c54e347",
103    "lastActiveAgent": "2016-01-29T21:36:10Z",
104    "links": [{
105      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
106      "rel": "self"
107    }],
108    "name": "1454015992252",
109    "orgId": "5980d0040b6d97029d83179b",
110    "publicApiEnabled": true,
111    "replicaSetCount": 0,
112    "shardCount": 0,
113    "tags": []
114  }],
115  "totalCount": 5
116}

Voltar

Projetos

Próximo

Obter por ID