/ /

Recursos

Importar sistemas

Página inicial do Docs

Criar Solicitação de Sistema de Importação

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.

Crie uma nova solicitação de implantação de importação para adicionar processos MongoDB existentes à automação do Ops Manager. Esse endpoint inicia o processo de importação de vários processos do MongoDB para o gerenciamento de monitoramento e automação.

Importante

Este recurso está disponível a partir do Ops Manager 8.0.13.

Os sistemas importados são adicionados à configuração de automação do projeto. O MongoDB Agent começará a monitorar os processos e a gerenciá-los de acordo com a configuração da automação.

Funções obrigatórias

Esse endpoint requer a Project Automation Admin função .

Endpoint

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

POST /automation/importDeployment/{PROJECT-ID}

Solicitar

parâmetros de caminho

Nome	Tipo	necessidade	Descrição
ID do projeto	string	Obrigatório	Identificador único do projeto que possuirá os sistemas importados.

parâmetros de query

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

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

Nome	Tipo	necessidade	Descrição
seedHostport	string	Obrigatório	Nome de host e porta do processo semente MongoDB para conectar para descoberta (por exemplo, `mongodb1.example.com:27017`).
Processos exigidos	array	Obrigatório	Array de strings de nome de host: porta representando processos do MongoDB que devem ser descobertos antes que a importação possa prosseguir.
tempos limite	objeto	Opcional	Configurações de tempo limite para várias fases da importação.
timeouts.seedHostConnectionSec	número	Opcional	Tempo limite em segundos para se conectar ao host de sementes. Intervalo: 60-86400 segundos. O padrão usa configurações do sistema.
timeouts.processesDiscoverySec	número	Opcional	Tempo limite em segundos para descobrir todos os processos necessários. Intervalo: 60-86400 segundos. O padrão usa configurações do sistema.
timeouts.automationImported	número	Opcional	Tempo limite em segundos para concluir a importação de automação. Intervalo: 60-86400 segundos. O padrão usa configurações do sistema.
timeouts.goalStateSec	número	Opcional	Tempo limite em segundos para atingir o estado da meta de automação. Intervalo: 60-86400 segundos. O padrão usa configurações do sistema.
authMechanism	string	Opcional	Mecanismo de autenticação para se conectar aos processos do MongoDB . Os valores possíveis são: `MONGODB_CR` (Isto abrange SCRAM-SHA-1, SCRAM-SHA-256 e MONGODB-CR.) `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
nome de usuário	string	Condicional	Nome de usuário para autenticar nos processos do MongoDB . Obrigatório se `authMechanism` for especificado.
Senha	string	Condicional	Senha para autenticar nos processos do MongoDB . Obrigatório se `authMechanism` for `MONGODB_CR`. O gerente de operações não inclui este parâmetro nos documentos de resposta.
adminDb	string	Opcional	Banco de dados contra o qual autenticar. Padrão: `admin`.
pemKeyFilePath	string	Opcional	Caminho para o arquivo de chave PEM para autenticação do cliente TLS.
pemKeyFilePassword	string	Opcional	Senha do arquivo de chave PEM. O gerente de operações não inclui este parâmetro nos documentos de resposta.
adminKerberosKeytab	string	Opcional	Caminho para o arquivo de guia de chave Kerberos para autenticação GSSAPI.
adminLdapGroupDn	string	Opcional	nome diferenciado do grupo LDAP para autenticação PLAIN.
saslServiceName	string	Opcional	Nome do serviço SASL para autenticação GSSAPI.
caFilePath	string	Opcional	Caminho para o arquivo da Autoridade de certificação para conexões TLS.
clusterCaFilePath	string	Opcional	Caminho para o arquivo da Autoridade de Certificação do cluster para conexões TLS.
clientCertificateMode	string	Opcional	modo de certificado de cliente para conexões TLS.

Resposta

Retorna uma resposta de sucesso vazia com status HTTP 200 se a solicitação de importação for enviada com sucesso.

Observação

Este endpoint não retorna a ID da solicitação de importação criada. Para acompanhar o status de sua solicitação de importação, use o endpoint Obter Solicitações de Implementação de Importação para listar todas as solicitações para o projeto e identificá-la por tempo de criação ou outras propriedades.

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/automation/importDeployment/{PROJECT-ID}?pretty=true" \
     --data '{
       "seedHostport": "mongodb1.example.com:27017",
       "requiredProcesses": [
         "mongodb1.example.com:27017",
         "mongodb2.example.com:27017",
         "mongodb3.example.com:27018"
       ],
       "timeouts": {
         "seedHostConnectionSec": 300,
         "processesDiscoverySec": 600,
         "automationImported": 600,
         "goalStateSec": 1200
       },
       "authMechanism": "MONGODB_CR",
       "username": "admin",
       "password": "password123",
       "adminDb": "admin"
     }'

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

{}

Voltar

Importar sistemas

Obter solicitações de sistema de importação