Obter um projeto por nome
Nesta página
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
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://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/byName/{GROUP-NAME}
Parâmetros da solicitação
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
GROUP-NAME | string | (Obrigatório.) O nome 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 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:
| false |
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
Nome | Tipo | Descrição |
|---|---|---|
ActiveAgentCount | inteiro | Número de agentes ativos que enviam pings regulares ao Cloud 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 grupo. |
lastActiveAgent | string | Hora do Cloud Manager atualizar pela última vez o total de activeAgentCount para o projeto. O Cloud Manager atualiza esse valor a cada 24 horas e o armazena em cache para registrar o número de agentes MongoDB ativos. |
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. |
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/{GROUP-NAME}?pretty=true"
Importante
Alguns caracteres não são permitidos em URLs. Eles são chamados de caracteres reservados. Se o {GROUP-NAME} seu incluir caracteres reservados, como espaços, você deverá substituí-los pela codificação de porcentagem .
Por exemplo, em vez de fazer esta solicitação (via curl):
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Project?pretty=true"
Faça esta solicitação (via curl):
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Group?pretty=true"
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
{ "activeAgentCount": 1, "agentApiKey": "{AGENT-API-KEY}", "hostCounts": { "arbiter": 2, "config": 1, "primary": 4, "secondary": 8, "mongos": 2 }, "id": "{PROJECT-ID}", "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"), "links" : [], "name": "My Project", "orgId" : "111111111cccccf38dc78bdf", "publicApiEnabled": true, "replicaSetCount": 3, "shardCount": 2, }