Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Obter a configuração da automação

A configuração de automação de um projeto determina o estado do objetivo de seus processos e agentes do MongoDB. O MongoDB Agent cria a implantação de acordo com os objetivos especificados.

Importante

A configuração de automação de um projeto pode conter informações confidenciais, incluindo senhas ou valores de chave. Para obter a configuração de automação com informações confidenciais editadas, use o ponto de extremidade /groups/{PROJECT-ID}/automationConfig/noSecrets.

Este recurso requer a função Project Automation Admin .

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

GET /groups/{PROJECT-ID}/automationConfig
Nome
Tipo
necessidade
Descrição

ID do projeto

string

Obrigatório

Identificador exclusivo do grupo que possui a configuração de automação.

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 está em um formato pretty-print.

false

envelope

booleano

Opcional

Sinalizador que indica se deve 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:

  • status: Código de resposta HTTP

  • content: Corpo de resposta esperado

false

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Para revisar esses parâmetros, consulte Parâmetros de configuração de automação.

curl --user "{publicApiKey}:{privateApiKey}" --digest \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/automationConfig?pretty=true" \ --output currentAutomationConfig.json
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Para revisar um exemplo dessa configuração, consulte Exemplo de configuração de automação.