Atualizar um projeto

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

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.

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.

Alterar o nome de um projeto.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

PATCH /groups/{PROJECT-ID}

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
ID do projeto	string	(Obrigatório.) O identificador exclusivo 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:

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	O novo nome do 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 PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}?pretty=true" \
     --data '
     {
       "name" :  "Project Name 1"
     }'

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   "id": "{PROJECT-ID}",
3   "name":  "Project Name 1",
4   "orgId" : "{ORG-ID}",
5   "hostCounts": {
6     "arbiter": 2,
7     "config": 1,
8     "primary": 4,
9     "secondary": 8,
10     "mongos": 2
11   },
12   "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
13   "activeAgentCount": 1,
14   "replicaSetCount": 3,
15   "shardCount": 2,
16   "publicApiEnabled": true,
17   "agentApiKey": "{API-KEY}",
18   "links" : []
19 }

Voltar

criar

Excluir

1	{
2	"id": "{PROJECT-ID}",
3	"name": "Project Name 1",
4	"orgId" : "{ORG-ID}",
5	"hostCounts": {
6	"arbiter": 2,
7	"config": 1,
8	"primary": 4,
9	"secondary": 8,
10	"mongos": 2
11	},
12	"lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
13	"activeAgentCount": 1,
14	"replicaSetCount": 3,
15	"shardCount": 2,
16	"publicApiEnabled": true,
17	"agentApiKey": "{API-KEY}",
18	"links" : []
19	}