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 status de automação do plano mais recente

Observação

Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu grupo. Para grupos existentes, o ID do grupo/ ID do projeto permanece o mesmo. Esta página usa o termo grupo, que é mais familiar, ao se referir a descrições. O ponto de extremidade permanece conforme indicado no documento.

Recupera o plano mais recente para processos MongoDB. Os planos são um conjunto de ação necessárias para obter uma implantação do MongoDB no goalVersion.

O endpoint retorna o campo goalVersion para relatar a versão atual da configuração de automação e o campo lastGoalVersionAchieved para relatar as versões da configuração em execução em cada servidor.

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

GET /groups/{PROJECT-ID}/automationStatus
Parâmetro
Tipo
Descrição

ID do projeto

string

(Obrigatório.) O identificador exclusivo do projeto.

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 prettyprint.

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.

Nome
Tipo
Descrição

targetVersion

número

A versão da configuração de automação enviada mais recentemente. Se houver um conflito nos envios de configurações de automação, esse campo listará a configuração vencedora.

processes

array

Instâncias MongoDB implantadas do projeto.

process.errorCode

inteiro

O código de erro. Retorna 0 se o processo não tiver erros.

process.errorCodeDescription

string

Descrição detalhada do erro. Retorna uma string vazia se o processo não tiver erros.

process.errorCodeHumanReadable

string

Descrição curta do erro. Retorna uma string vazia se o processo não tiver erros.

process.errorString

string

Saída da linha de log que contém o erro. Examine este campo para contexto de erro adicional. Retorna uma string vazia se o processo não tiver erros.

process.hostname

string

O nome de domínio totalmente qualificado (recuperado emitindo hostname -f) do servidor no qual o processo do MongoDB e a automação estão hospedados.

process.name

string

O nome do processo conforme especificado na configuração da automação.

processos.lastGoalVersionAchievede

número

A última versão da configuração de automação com a qual esse processo foi distribuído como configurado. Se o número processes.lastGoalVersionAchieved não for igual ao número goalVersion , o processo ainda não foi implementado de acordo com a configuração atual.

process.plan

array

Descreve como um processo que ainda não está atualizado com a configuração atingirá o estado da meta.

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET -i "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationStatus"
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}
{ "goalVersion": 11, "processes": [{ "errorCode": 0, "errorCodeDescription": "", "errorCodeHumanReadable": "", "errorString": "", "hostname": "example.net", "lastGoalVersionAchieved": 11, "name": "myReplicaSet_3", "plan": ["Download", "WaitRsInit", "WaitFeatureCompatibilityVersionCorrect" ] }, { "errorCode": 100, "errorCodeDescription": "There is an issue with file permissions for this process", "errorCodeHumanReadable": "File Permissions Error", "errorString": "<myReplicaSet_1> [13:11:33.348] Failed to compute states : <myReplicaSet_1> [13:11:33.348] Error calling ComputeState : <myReplicaSet_1> [13:11:33.348] Error getting fickle state for current state : <myReplicaSet_1> [13:11:33.348] Error checking if process is running from dbpath = /data/0 : <myReplicaSet_1> [13:11:33.348] Error getting file contents of /data/0/mongod.lock as string : <myReplicaSet_1> [13:11:33.348] Error reading file from /data/0/mongod.lock : open /data/0/mongod.lock: permission denied", "hostname": "example.net", "lastGoalVersionAchieved": 1, "name": "myReplicaSet_1", "plan": ["Download"] }, { "errorCode": 0, "errorCodeDescription": "", "errorCodeHumanReadable": "", "errorString": "", "hostname": "example.net", "lastGoalVersionAchieved": 11, "name": "myReplicaSet_2", "plan": ["WaitRsInit", "WaitFeatureCompatibilityVersionCorrect" ] }]}