/ /

Projetos

Página inicial do Docs

/ /

Projetos e usuários

Projetos

Página inicial do Docs

Criar um projeto

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

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

Funções obrigatórias

Para criar um projeto dentro de uma organização existente, você deve ter uma das seguintes funções na organização especificada:

Resource

POST /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

necessidade

Descrição

Default

pretty

booleano

Opcional

Sinalizador que indica se o corpo da resposta deve estar em um formato de impressão bonita.

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

Parâmetros do corpo da solicitação

Nome	Tipo	necessidade	Descrição
name	string	Obrigatório	Etiqueta legível por humanos que identifica o projeto.
orgId	string	Obrigatório	24exclusiva -string de dígitos hexadecimais que identifica a organização na qual criar o projeto. O Cloud Manager definiu o `Organization Owner` mais antigo da organização especificada como `Project Owner` para o novo projeto.

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

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true" \
     --data '
       {
         "name": "Create Project API Example",
         "orgId": "deffb2031b938da53f16d714"
       }'

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 201 Created
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" : 0,
  "agentApiKey" : "{GROUP-API-KEY}",
  "hostCounts" : {
    "arbiter" : 0,
    "config" : 0,
    "mongos" : 0,
    "primary" : 0,
    "secondary" : 0
  },
  "id" : "{PROJECT-ID}",
  "links" : [],
  "name" : "Create Project API Example",
  "orgId" : "{ORG-ID}",
  "publicApiEnabled" : true,
  "replicaSetCount" : 0,
  "shardCount" : 0,
  "tags" : [ ]
}

Voltar

Obter pela chave API do agente

Update