Criar um projeto
Nesta página
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://{OPSMANAGER-HOST}:{PORT}/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:
Observação
Se você criar um projeto usando uma chave deAPI de uma organização sem um Organization Owner, o Ops Manager criará o projeto sem um Project Owner.
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 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 de 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 | 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 Ops Manager definiu o |
Resposta
Nome | Tipo | Descrição | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ActiveAgentCount | inteiro | Número de agente ativos que enviam ping regulares ao Ops 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 projeto. | ||||||||||||||||||
lastActiveAgent | string | O Time Ops Manager atualizou pela última vez o total de activeAgentCount para o projeto. O Ops Manager atualiza esse valor a cada 24 horas e o armazena em cache para registrar o número de agente MongoDB ativos. | ||||||||||||||||||
ldapGroupMappings | array de objetos | For LDAP-backed Ops Manager, the mappings of LDAP groups to Ops Manager project roles. Presente apenas para o Ops Manager suportado por LDAP. | ||||||||||||||||||
ldapGroupMappings .roleName | string | Role de usuário do Ops Manager. O mapeamento da função do projeto para
| ||||||||||||||||||
ldapGroupMappings .ldapGroups | array de strings | Projeto(s) LDAP que mapeiam para a role de Ops Manager. | ||||||||||||||||||
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. | ||||||||||||||||||
tags | array de strings | Marcações atribuídas ao projeto para uso na identificação programática do projeto.
Um projeto pode ter até 10 tags. As marcações seguem estas regras:
|
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://{opsManagerHost}:{port}/api/public/v1.0/groups?pretty=true" \ --data ' { "name": "Create Project API Example", "orgId": "deffb2031b938da53f16d714" }'
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
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, "primary" : 0, "secondary" : 0, "mongos" : 0 }, "id" : "{PROJECT-ID}", "ldapGroupMappings" : [ { "roleName": "GROUP_OWNER", "ldapGroups": [ project-owner" ] }, ... ], "links" : [], "name" : "Create Project API Test", "orgId" : "deffb2031b938da53f16d714", "publicApiEnabled": true, "replicaSetCount" : 0, "shardCount" : 0, "tags": [ "DEV", "PRODUCT" ] }