Adicionar equipes a um projeto

Nesta página

Sintaxe

Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
documento de resposta
results documento incorporado
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo 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.

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

Sintaxe

POST /groups/{PROJECT-ID}/teams

Parâmetros do caminho da solicitação

Elemento do caminho	Obrigatório/Opcional	Descrição
`PROJECT-ID`	Obrigatório.	O identificador exclusivo do projeto ao qual você está adicionando a equipe ou equipes.

Solicitar parâmetros de query

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

Nome	Tipo	necessidade	Descrição	Default
pageNum	número	Opcional	Um inteiro baseado que retorna uma subseção de resultados.	`1`
itemsPerPage	número	Opcional	Número de itens a serem devolvidos por página, até um máximo de 500.	`100`
pretty	booleano	Opcional	Sinalizador que indica 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 do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure `envelope : true` na consulta. Para endpoints que retornam uma lista de resultados, o objeto `content` é um envelope. O Cloud Manager adiciona o campo `status` ao corpo da resposta.	`false`
backupJobsEnabledOnly	booleano	Opcional	Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como `false` para incluir configurações de daemon com o sinalizador `backupJobsEnabled` definido como `false`.	`true`

Parâmetros do corpo da solicitação

Especifique uma array de documentos, onde cada documento representa uma equipe que você deseja associar ao projeto. Cada documento no array deve conter os seguintes campos:

Nome	Tipo	Descrição
`roleNames`	array	Cada objeto na array representa uma função de projeto que você deseja atribuir à equipe. As roles válidas e seus mapeamentos associados são: `GROUP_OWNER` - `Project Owner` `GROUP_READ_ONLY` - `Project Read Only` `GROUP_DATA_ACCESS_ADMIN` - `Project Data Access Admin` `GROUP_DATA_ACCESS_READ_WRITE` - `Project Data Access Read/Write` `GROUP_DATA_ACCESS_READ_ONLY` - `Project Data Access Read Only` `GROUP_MONITORING_ADMIN` - `Project Monitoring Admin` `GROUP_BACKUP_ADMIN` - `Project Backup Admin` `GROUP_AUTOMATION_ADMIN` - `Project Automation Admin` `GROUP_USER_ADMIN` - `Project User Admin`
`teamId`	string	O identificador exclusivo da equipe que você deseja associar ao projeto. A equipe e o projeto devem compartilhar a mesma organização principal.

Resposta

documento de resposta

O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

Nome	Tipo	Descrição
`results`	array	A array inclui um objeto para cada item detalhado na seção `results` Documento incorporado.
`links`	array	A array inclui 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.
`totalCount`	número	Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

`results` documento incorporado

Cada elemento na array result é uma equipe adicionada ao projeto.

Nome	Tipo	Descrição
`links`	array	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.
`roleNames`	array	Array de roles de projetos atribuídos à equipe. As roles válidas e seus mapeamentos associados são: `GROUP_OWNER` - `Project Owner` `GROUP_READ_ONLY` - `Project Read Only` `GROUP_DATA_ACCESS_ADMIN` - `Project Data Access Admin` `GROUP_DATA_ACCESS_READ_WRITE` - `Project Data Access Read/Write` `GROUP_DATA_ACCESS_READ_ONLY` - `Project Data Access Read Only` `GROUP_MONITORING_ADMIN` - `Project Monitoring Admin` `GROUP_BACKUP_ADMIN` - `Project Backup Admin` `GROUP_AUTOMATION_ADMIN` - `Project Automation Admin` `GROUP_USER_ADMIN` - `Project User Admin`

Exemplo de solicitação

curl -u "username:apiKey" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams?pretty=true" \
     --data '[ { "teamId" : "{TEAM-ID}", "roles" : [ { "roleName" : "GROUP_OWNER" } ] } ]'

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

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams",
      "rel": "self"
    }
  ],
  "results": [
    {
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/pubic/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}",
          "rel": "self"
        }
      ],
      "roleNames": [ "GROUP_OWNER" ],
      "teamId": "{TEAM-ID}"
    }
  ],
  "totalCount": 1
}

Voltar

Obtenha todas as equipes

Remover equipe