Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/ / / /

Obter um projeto por chave de API do agente

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

GET /groups/byAgentApiKey/{AGENT-API-KEY}
Nome
Tipo
Descrição

chave de API do agente

string

(Obrigatório.) Achave de API do agente

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

Nome
Tipo
necessidade
Descrição
Default

pretty

booleano

Opcional

false

envelope

booleano

Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes da 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:

Nome
Descrição

status

Código de resposta HTTP

content

Corpo de resposta esperado

false

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

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

Para LDAPo apoiado MongoDB Ops Manager por , os mapeamentos de LDAP grupos para MongoDB Ops Manager roles de projeto . Presente somente para o MongoDB Ops Manager apoiado 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

GROUP_AUTOMATION_ADMIN

GROUP_BACKUP_ADMIN

GROUP_MONITORING_ADMIN

GROUP_DATA_ACCESS_ADMIN

GROUP_DATA_ACCESS_READ_WRITE

GROUP_DATA_ACCESS_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

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--include \
--request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/byAgentApiKey/{AGENT-API-KEY}?pretty=true"
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}
{
"id": "{PROJECT-ID}",
"name": "My Project",
"orgId" : "{ORG-ID}",
"hostCounts": {
"arbiter": 2,
"config": 1,
"primary": 4,
"secondary": 8,
"mongos": 2
},
"lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
"activeAgentCount": 1,
"replicaSetCount": 3,
"shardCount": 2,
"publicApiEnabled": true,
"agentApiKey": "{AGENT-API-KEY}",
"tags": [ "DEV", "PRODUCT" ],
"ldapGroupMappings" : [ {
"roleName": "GROUP_OWNER",
"ldapGroups": [ project-owner" ]
}, ... ],
"links" : []
}

Voltar

Obter por nome