Atualizar uma organização
Nesta página
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 .
Alterar o nome de um projeto.
URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
PATCH /orgs/{ORG-ID}
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
---|---|---|
ORG-ID | string | O identificador exclusivo da organização. |
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
Nome | Tipo | necessidade | Descrição |
---|---|---|---|
name | string | Obrigatório | O novo nome da organização. |
Resposta
Nome | Tipo | Descrição |
---|---|---|
id | Identificador único da organização. | |
isDeleted | booleano | Sinalizador que indica se a organização foi excluída. |
links | array de documentos | 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 . |
name | string | Novo nome da organização. |
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/orgs/{ORG-ID}?pretty=true" \ --data ' { "name" : "Organization Name 1" }'
Exemplo de resposta
1 { 2 "id": "{ORG-ID}", 3 "isDeleted": false, 4 "links": [{ 5 "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}", 6 "rel": "self" 7 }, 8 { 9 "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/groups", 10 "rel": "http://mms.mongodb.com/groups" 11 }, 12 { 13 "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams", 14 "rel": "http://mms.mongodb.com/teams" 15 }, 16 { 17 "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/users", 18 "rel": "http://mms.mongodb.com/users" 19 } 20 ], 21 "name": "Organization Name 1" 22 }